FEI Version of the Day
snl_fei_Utils.hpp
00001 /*
00002 // @HEADER
00003 // ************************************************************************
00004 //             FEI: Finite Element Interface to Linear Solvers
00005 //                  Copyright (2005) Sandia Corporation.
00006 //
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, the
00008 // U.S. Government retains certain rights in this software.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Alan Williams (william@sandia.gov) 
00038 //
00039 // ************************************************************************
00040 // @HEADER
00041 */
00042 
00043 
00044 #ifndef _snl_fei_Utils_hpp_
00045 #define _snl_fei_Utils_hpp_
00046 
00047 #include <fei_fwd.hpp>
00048 #include <fei_mpi.h>
00049 #include <fei_SharedPtr.hpp>
00050 
00051 namespace fei {
00052   class CSVec;
00053   class Matrix;
00054 }
00055 
00056 #include <vector>
00057 #include <map>
00058 #include <string>
00059 
00060 namespace snl_fei {
00061 
00076   const char* getParam(const char* key,
00077            int numParams,
00078            const char* const* paramStrings);
00079 
00096   const char* getParamValue(const char* key,
00097           int numParams,
00098           const char* const* paramStrings,
00099           char separator=' ');
00100 
00114   const char* getParamValue(const char* key,
00115           std::vector<std::string>& params,
00116           char separator=' ');
00117 
00136   const char* getParamValue(const char* key,
00137           int numParams,
00138           const char* const* paramStrings,
00139           int& foundOffset,
00140           char separator=' ');
00141 
00144   int getIntParamValue(const char* key,
00145            int numParams,
00146            const char*const* params,
00147            int& paramValue);
00148 
00152   int getDoubleParamValue(const char* key,
00153         int numParams,
00154         const char*const* params,
00155         double& paramValue);
00156 
00160   int getDoubleParamValue(const char* key,
00161         std::vector<std::string>& params,
00162         double& paramValue);
00163 
00182   const char* getParam(const char* key,
00183            int numParams,
00184            const char* const* paramStrings,
00185            int& foundOffset);
00186 
00204   const char* getParam(const char* key,
00205            std::vector<std::string>& paramStrings,
00206            int& foundOffset);
00207 
00209   int storeNamedAttribute(const char* name,
00210         void* attribute,
00211         std::vector<char*>& attributeNames,
00212         std::vector<void*>& attributes);
00213 
00215   void* retrieveNamedAttribute(const char* name,
00216              std::vector<char*>& attributeNames,
00217              std::vector<void*>& attributes);
00218 
00220   void separate_string(const char* input_string,
00221            const char* substring,
00222            const char*& before_substring,
00223            int& len_before_substring,
00224            const char*& after_substring,
00225            int& len_after_substring);
00226 
00230   unsigned leading_substring_length(const char* string);
00231 
00243   const char* skipSeparator(const char* paramString,
00244           char separator=' ');
00245 
00249   int mergeStringLists(char**& strings, int& numStrings,
00250            const char*const* stringsToMerge, int numStringsToMerge);
00251 
00255   int resolveConflictingCRs(fei::MatrixGraph& matrixGraph,
00256           fei::Matrix& bcEqns,
00257                             const std::vector<int>& bcEqnNumbers);
00258 
00262   int gatherRemoteEssBCs(fei::CSVec& essBCs,
00263        fei::SparseRowGraph* remoteGraph,
00264        fei::Matrix& matrix);
00265 
00266   fei::SharedPtr<fei::SparseRowGraph>
00267     mergeSparseRowGraphs(const fei::SparseRowGraph* srg1,
00268                          const fei::SparseRowGraph* srg2);
00269 
00273   void copy2DBlockDiagToColumnContig(int numBlocks,
00274              const int* blockSizes,
00275              const double*const* values2d,
00276              int format,
00277              double* colcontigvalues);
00278 
00282   void copy2DToColumnContig(int numrows,
00283           int numcols,
00284           const double*const* values2d,
00285           int format,
00286           double* colcontigvalues);
00287 } //namespace snl_fei
00288 
00289 #endif // _snl_fei_Utils_hpp_
00290 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends