FEI Version of the Day
fei_test_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 _fei_test_utils_hpp_
00045 #define _fei_test_utils_hpp_
00046 
00047 #include <fei_macros.hpp>
00048 
00049 #include <fei_mpi.h>
00050 
00051 #include <fei_fwd.hpp>
00052 
00053 #include <fei_FillableMat.hpp>
00054 
00055 #include <vector>
00056 #include <string>
00057 
00060 namespace fei_test_utils {
00061 
00068   std::string construct_filename(int argc, char** argv);
00069 
00076   int initialize_mpi(int argc, char** argv,
00077                      int& localProc, int& numProcs);
00078 
00088   bool bool_arg(const char* flag, int argc, char** argv,
00089                 bool default_result=false);
00090 
00097   std::string get_arg_value(const char* flag, int argc, char** argv);
00098 
00103   void broadcast_string(MPI_Comm comm, int root, std::string& strg);
00104 
00112   int get_filename_and_read_input(int argc, char** argv,
00113           MPI_Comm comm, int localProc,
00114           std::vector<std::string>& stdstrings);
00115 
00119   void read_file_lines_into_strings(const char* filename,
00120             std::vector<std::string>& file_contents);
00121 
00129   void read_input_file(const char* filename, MPI_Comm comm,
00130            std::vector<std::string>& file_contents);
00131 
00137   double get_file_benchmark(const char* filename,
00138           const char* testname);
00139 
00147   bool within_percentage_margin(double value1,
00148         double value2,
00149         unsigned margin);
00150 
00151   bool check_and_cout_test_result(std::string testname,
00152           double value,
00153           double file_value,
00154           unsigned margin);
00155 
00156   std::string check_test_result(double value,
00157         double goldvalue,
00158         unsigned margin);
00159 
00160   int compare_with_file_benchmark(const char* name,
00161           double benchmark,
00162           const char* filename);
00163 
00164   int whichArg(int argc, const char*const* argv, const char* findarg);
00165 
00166   int dirname(const char* name, char*& dir);
00167 
00168   void print_args(int argc, char** argv);
00169 
00170   int compareMatrices(fei::FillableMat& mat1, fei::FillableMat& mat2, double tol=1.e-15);
00171 
00172   int readMatrix(const char* baseName, int np, fei::FillableMat& matrix);
00173 
00174   int readMatrix(const char* fileName, fei::FillableMat& matrix);
00175 
00176   int writeMatrix(const char* fileName, fei::FillableMat& matrix);
00177 
00178   int copy_feiMatrix_to_FillableMat(fei::Matrix& feimat, fei::FillableMat& ssmat);
00179 
00180 }//namespace fei_test_utils
00181 
00182 #endif
00183 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends