Stratimikos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
test_single_belos_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
44
46#include "Teuchos_CommandLineProcessor.hpp"
47#include "Teuchos_ParameterList.hpp"
48#include "Teuchos_VerboseObject.hpp"
49#include "Teuchos_GlobalMPISession.hpp"
50#include "Teuchos_StandardCatchMacros.hpp"
51
52
53int main(int argc, char* argv[])
54{
55
56 using Teuchos::CommandLineProcessor;
57
58 bool success = true;
59 bool verbose = true;
60
61 Teuchos::GlobalMPISession mpiSession(&argc, &argv);
62
63 Teuchos::RCP<Teuchos::FancyOStream>
64 out = Teuchos::VerboseObjectBase::getDefaultOStream();
65
66 try {
67
68 //
69 // Read options from command-line
70 //
71
72 std::string matrixFile = "";
73 bool testTranspose = false;
74 bool usePreconditioner = true;
75 int numRhs = 1;
76 int numRandomVectors = 1;
77 double maxFwdError = 1e-14;
78 int maxIterations = 400;
79 int maxRestarts = 25;
80 int gmresKrylovLength = 25;
81 int outputFrequency = 10;
82 bool outputMaxResOnly = true;
83 int blockSize = 1;
84 double maxResid = 1e-6;
85 double maxSolutionError = 1e-6;
86 bool showAllTests = false;
87 bool dumpAll = false;
88
89 CommandLineProcessor clp;
90 clp.throwExceptions(false);
91 clp.addOutputSetupOptions(true);
92 clp.setOption( "matrix-file", &matrixFile, "Matrix input file [Required]." );
93 clp.setOption( "test-transpose", "no-test-transpose", &testTranspose, "Test the transpose solve or not." );
94 clp.setOption( "use-preconditioner", "no-use-preconditioner", &usePreconditioner, "Use the preconditioner or not." );
95 clp.setOption( "num-rhs", &numRhs, "Number of RHS in linear solve." );
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-iters", &maxIterations, "The maximum number of linear solver iterations to take." );
99 clp.setOption( "max-restarts", &maxRestarts, "???." );
100 clp.setOption( "gmres-krylov-length", &gmresKrylovLength, "???." );
101 clp.setOption( "output-frequency", &outputFrequency, "Number of linear solver iterations between output" );
102 clp.setOption( "output-max-res-only", "output-all-res", &outputMaxResOnly, "Determines if only the max residual is printed or if all residuals are printed per iteration." );
103 clp.setOption( "block-size", &blockSize, "???." );
104 clp.setOption( "max-resid", &maxResid, "The maximum relative error in the residual." );
105 clp.setOption( "max-solution-error", &maxSolutionError, "The maximum relative error in the solution of the linear system." );
106 clp.setOption( "verbose", "quiet", &verbose, "Set if output is printed or not." );
107 clp.setOption( "show-all-tests", "no-show-all-tests", &showAllTests, "Set if all the tests are shown or not." );
108 clp.setOption( "dump-all", "no-dump-all", &dumpAll, "Determines if vectors are printed or not." );
109 CommandLineProcessor::EParseCommandLineReturn parse_return = clp.parse(argc,argv);
110 if( parse_return != CommandLineProcessor::PARSE_SUCCESSFUL ) return parse_return;
111
112 TEUCHOS_TEST_FOR_EXCEPT( matrixFile == "" );
113
114 Teuchos::ParameterList belosLOWSFPL;
115
116 belosLOWSFPL.set("Solver Type","Block GMRES");
117
118 Teuchos::ParameterList& belosLOWSFPL_solver =
119 belosLOWSFPL.sublist("Solver Types");
120
121 Teuchos::ParameterList& belosLOWSFPL_gmres =
122 belosLOWSFPL_solver.sublist("Block GMRES");
123
124 belosLOWSFPL_gmres.set("Maximum Iterations",int(maxIterations));
125 belosLOWSFPL_gmres.set("Convergence Tolerance",double(maxResid));
126 belosLOWSFPL_gmres.set("Maximum Restarts",int(maxRestarts));
127 belosLOWSFPL_gmres.set("Block Size",int(blockSize));
128 belosLOWSFPL_gmres.set("Num Blocks",int(gmresKrylovLength));
129 belosLOWSFPL_gmres.set("Output Frequency",int(outputFrequency));
130 belosLOWSFPL_gmres.set("Show Maximum Residual Norm Only",bool(outputMaxResOnly));
131
132 Teuchos::ParameterList precPL("Ifpack");
133 if(usePreconditioner) {
134 precPL.set("Overlap",int(2));
135 precPL.set("Prec Type","ILUT");
136 }
137
138 success
140 matrixFile,testTranspose,usePreconditioner,numRhs,numRandomVectors
141 ,maxFwdError,maxResid,maxSolutionError,showAllTests,dumpAll
142 ,&belosLOWSFPL,&precPL
143 ,verbose?&*out:0
144 );
145
146 }
147 TEUCHOS_STANDARD_CATCH_STATEMENTS(verbose, std::cerr, success)
148
149 if (verbose) {
150 if(success) *out << "\nCongratulations! All of the tests checked out!\n";
151 else *out << "\nOh no! At least one of the tests failed!\n";
152 }
153
154 return ( success ? 0 : 1 );
155}
bool test_single_belos_thyra_solver(const std::string matrixFile, const bool testTranspose, const bool usePreconditioner, const int numRhs, const int numRandomVectors, const double maxFwdError, const double maxResid, const double maxSolutionError, const bool showAllTests, const bool dumpAll, Teuchos::ParameterList *belosLOWSFPL, Teuchos::ParameterList *precPL, Teuchos::FancyOStream *out)
Testing function for a single belos solver with a single matrix.
int main(int argc, char *argv[])