fei_test_utils.hpp

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*    Copyright 2005 Sandia Corporation.                              */
/*    Under the terms of Contract DE-AC04-94AL85000, there is a       */
/*    non-exclusive license for use of this work by or on behalf      */
/*    of the U.S. Government.  Export of this program may require     */
/*    a license from the United States Government.                    */
/*--------------------------------------------------------------------*/

#ifndef _fei_test_utils_hpp_
#define _fei_test_utils_hpp_

#include <fei_macros.hpp>

#include <fei_mpi.h>

#include <fei_fwd.hpp>

#include <fei_FillableMat.hpp>

#include <vector>
#include <string>

namespace fei_test_utils {

  std::string construct_filename(int argc, char** argv);

  int initialize_mpi(int argc, char** argv,
                     int& localProc, int& numProcs);

  bool bool_arg(const char* flag, int argc, char** argv,
                bool default_result=false);

  std::string get_arg_value(const char* flag, int argc, char** argv);

  void broadcast_string(MPI_Comm comm, int root, std::string& strg);

  int get_filename_and_read_input(int argc, char** argv,
          MPI_Comm comm, int localProc,
          std::vector<std::string>& stdstrings);

  void read_file_lines_into_strings(const char* filename,
            std::vector<std::string>& file_contents);

  void read_input_file(const char* filename, MPI_Comm comm,
           std::vector<std::string>& file_contents);

  double get_file_benchmark(const char* filename,
          const char* testname);

  bool within_percentage_margin(double value1,
        double value2,
        unsigned margin);

  bool check_and_cout_test_result(std::string testname,
          double value,
          double file_value,
          unsigned margin);

  std::string check_test_result(double value,
        double goldvalue,
        unsigned margin);

  int compare_with_file_benchmark(const char* name,
          double benchmark,
          const char* filename);

  int whichArg(int argc, const char*const* argv, const char* findarg);

  int dirname(const char* name, char*& dir);

  void print_args(int argc, char** argv);

  int compareMatrices(fei::FillableMat& mat1, fei::FillableMat& mat2, double tol=1.e-15);

  int readMatrix(const char* baseName, int np, fei::FillableMat& matrix);

  int readMatrix(const char* fileName, fei::FillableMat& matrix);

  int writeMatrix(const char* fileName, fei::FillableMat& matrix);

  int copy_feiMatrix_to_FillableMat(fei::Matrix& feimat, fei::FillableMat& ssmat);

}//namespace fei_test_utils

#endif