Stratimikos Package Browser (Single Doxygen Collection)  Version of the Day
test_single_amesos_thyra_solver_driver.cpp
Go to the documentation of this file.
1 /*
2 // @HEADER
3 // ***********************************************************************
4 //
5 // Stratimikos: Thyra-based strategies for linear solvers
6 // Copyright (2006) Sandia Corporation
7 //
8 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
9 // license for use of this work by or on behalf of the U.S. Government.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
39 //
40 // ***********************************************************************
41 // @HEADER
42 */
43 
45 #include "Teuchos_CommandLineProcessor.hpp"
46 #include "Teuchos_VerboseObject.hpp"
47 
48 int main(int argc, char* argv[])
49 {
50 
51  using Teuchos::CommandLineProcessor;
52 
53  bool success = true;
54  bool verbose = true;
55 
56  Teuchos::RCP<Teuchos::FancyOStream>
57  out = Teuchos::VerboseObjectBase::getDefaultOStream();
58 
59  try {
60 
61  //
62  // Read options from command-line
63  //
64 
65  std::string matrixFile = "";
67 #ifdef HAVE_AMESOS_KLU
68  = Thyra::Amesos::KLU;
69 #else
71 #endif
73  bool testTranspose = true;
74  int numRandomVectors = 1;
75  double maxFwdError = 1e-14;
76  double maxError = 1e-10;
77  double maxResid = 1e-10;
78  bool showAllTests = false;
79  bool dumpAll = false;
80 
81  CommandLineProcessor clp;
82  clp.throwExceptions(false);
83  clp.addOutputSetupOptions(true);
84  clp.setOption( "matrix-file", &matrixFile, "Matrix iput file [Required]." );
85  clp.setOption(
86  "solver-type", &solverType
88  ,"Type of direct solver."
89  );
90  clp.setOption(
91  "refactorization-policy", &refactorizationPolicy
93  ,"Pivoting policy used on refactorizations."
94  );
95  clp.setOption( "test-transpose", "no-test-transpose", &testTranspose, "Test the transpose solve or not." );
96  clp.setOption( "num-random-vectors", &numRandomVectors, "Number of times a test is performed with different random vectors." );
97  clp.setOption( "max-fwd-error", &maxFwdError, "The maximum relative error in the forward operator." );
98  clp.setOption( "max-error", &maxError, "The maximum relative error in the solution." );
99  clp.setOption( "max-resid", &maxResid, "The maximum relative error in the residual." );
100  clp.setOption( "verbose", "quiet", &verbose, "Set if output is printed or not." );
101  clp.setOption( "show-all-tests", "no-show-all-tests", &showAllTests, "Set if all the tests are shown or not." );
102  clp.setOption( "dump-all", "no-dump-all", &dumpAll, "Determines if vectors are printed or not." );
103  CommandLineProcessor::EParseCommandLineReturn parse_return = clp.parse(argc,argv);
104  if( parse_return != CommandLineProcessor::PARSE_SUCCESSFUL ) return parse_return;
105 
106  TEUCHOS_TEST_FOR_EXCEPT( matrixFile == "" );
107 
108  Teuchos::ParameterList amesosLOWSFPL;
109  amesosLOWSFPL.set("Solver Type",toString(solverType));
110  amesosLOWSFPL.set("Refactorization Policy",toString(refactorizationPolicy));
111 
112  success
114  matrixFile,&amesosLOWSFPL,testTranspose,numRandomVectors
115  ,maxFwdError,maxError,maxResid,showAllTests,dumpAll,verbose?&*out:0
116  );
117 
118  }
119  catch( const std::exception &excpt ) {
120  std::cerr << "*** Caught standard exception : " << excpt.what() << std::endl;
121  success = false;
122  }
123  catch( ... ) {
124  std::cerr << "*** Caught an unknown exception\n";
125  success = false;
126  }
127 
128  if (verbose) {
129  if(success) *out << "\nCongratulations! All of the tests checked out!\n";
130  else *out << "\nOh no! At least one of the tests failed!\n";
131  }
132 
133  return ( success ? 0 : 1 );
134 }
ERefactorizationPolicy
The policy used on refactoring a matrix.
bool test_single_amesos_thyra_solver(const std::string matrixFile, Teuchos::ParameterList *amesosLOWSFPL, const bool testTranspose, const int numRandomVectors, const double maxFwdError, const double maxError, const double maxResid, const bool showAllTests, const bool dumpAll, Teuchos::FancyOStream *out)
Testing function for a single amesos solver with a single matrix.
const ERefactorizationPolicy refactorizationPolicyValues[numRefactorizationPolices]
const int numRefactorizationPolices
const char * solverTypeNames[numSolverTypes]
const int numSolverTypes
const char * refactorizationPolicyNames[numRefactorizationPolices]
const ESolverType solverTypeValues[numSolverTypes]
Completely new pivoting will be used on refactorizations!
const char * toString(const ESolverType solverType)
int main(int argc, char *argv[])