LinearOpWithSolveBase.
More...
#include <Thyra_LinearOpWithSolveTesterDecl.hpp>
Public Types | |
| typedef Teuchos::ScalarTraits< RangeScalar >::magnitudeType | RangeScalarMag |
| | |
| typedef Teuchos::ScalarTraits< DomainScalar >::magnitudeType | DomainScalarMag |
| | |
| typedef Teuchos::PromotionTraits< RangeScalar, DomainScalar >::promote | Scalar |
| | |
| typedef Teuchos::ScalarTraits< Scalar >::magnitudeType | ScalarMag |
| | |
Public Member Functions | |
| LinearOpWithSolveTester (const bool check_forward_default=true, const RangeScalarMag forward_default_residual_warning_tol=1e-6, const RangeScalarMag forward_default_residual_error_tol=1e-5, const DomainScalarMag forward_default_solution_error_warning_tol=1e-6, const DomainScalarMag forward_default_solution_error_error_tol=1e-5, const bool check_forward_residual=true, const RangeScalarMag forward_residual_solve_tol=1e-5, const RangeScalarMag forward_residual_slack_warning_tol=1e-6, const RangeScalarMag forward_residual_slack_error_tol=1e-5, const bool check_forward_solution_error=true, const RangeScalarMag forward_solution_error_solve_tol=1e-5, const RangeScalarMag forward_solution_error_slack_warning_tol=1e-6, const RangeScalarMag forward_solution_error_slack_error_tol=1e-5, const bool check_adjoint_default=true, const DomainScalarMag adjoint_default_residual_warning_tol=1e-6, const DomainScalarMag adjoint_default_residual_error_tol=1e-5, const RangeScalarMag adjoint_default_solution_error_warning_tol=1e-6, const RangeScalarMag adjoint_default_solution_error_error_tol=1e-5, const bool check_adjoint_residual=true, const DomainScalarMag adjoint_residual_solve_tol=1e-5, const DomainScalarMag adjoint_residual_slack_warning_tol=1e-6, const DomainScalarMag adjoint_residual_slack_error_tol=1e-5, const bool check_adjoint_solution_error=true, const DomainScalarMag adjoint_solution_error_solve_tol=1e-5, const DomainScalarMag adjoint_solution_error_slack_warning_tol=1e-6, const DomainScalarMag adjoint_solution_error_slack_error_tol=1e-5, const int num_random_vectors=1, const bool show_all_tests=false, const bool dump_all=false) | |
| Default constructor which sets default parameter values. | |
| void | check_forward_default (const bool &check_forward_default) |
| Set if a default forward solve will be performed on not. | |
| void | forward_default_residual_warning_tol (const RangeScalarMag &forward_default_residual_warning_tol) |
| | |
| void | forward_default_residual_error_tol (const RangeScalarMag &forward_default_residual_error_tol) |
| | |
| void | forward_default_solution_error_warning_tol (const DomainScalarMag &forward_default_solution_error_warning_tol) |
| | |
| void | forward_default_solution_error_error_tol (const DomainScalarMag &forward_default_solution_error_error_tol) |
| | |
| void | check_forward_residual (const bool &check_forward_residual) |
| Set if a tolerance on the residual of the forward solve should checked or not. | |
| void | forward_residual_solve_tol (const RangeScalarMag &forward_residual_solve_tol) |
| Set the relative tolerance that will be requested in the residual for the forward solve . | |
| void | forward_residual_slack_warning_tol (const RangeScalarMag &forward_residual_slack_warning_tol) |
| | |
| void | forward_residual_slack_error_tol (const RangeScalarMag &forward_residual_slack_error_tol) |
| | |
| void | check_forward_solution_error (const bool &check_forward_solution_error) |
| Set if a tolerance on the solution error of the forward solve should checked or not. | |
| void | forward_solution_error_solve_tol (const RangeScalarMag &forward_solution_error_solve_tol) |
| Set the relative tolerance that will be requested in the solution_error for the forward solve . | |
| void | forward_solution_error_slack_warning_tol (const RangeScalarMag &forward_solution_error_slack_warning_tol) |
| | |
| void | forward_solution_error_slack_error_tol (const RangeScalarMag &forward_solution_error_slack_error_tol) |
| | |
| void | check_adjoint_default (const bool &check_adjoint_default) |
| Set if a default forward solve will be performed on not. | |
| void | adjoint_default_residual_warning_tol (const DomainScalarMag &adjoint_default_residual_warning_tol) |
| | |
| void | adjoint_default_residual_error_tol (const DomainScalarMag &adjoint_default_residual_error_tol) |
| | |
| void | adjoint_default_solution_error_warning_tol (const RangeScalarMag &adjoint_default_solution_error_warning_tol) |
| | |
| void | adjoint_default_solution_error_error_tol (const RangeScalarMag &adjoint_default_solution_error_error_tol) |
| | |
| void | check_adjoint_residual (const bool &check_adjoint_residual) |
| Set if a tolerance on the residual of the adjoint solve should checked or not. | |
| void | adjoint_residual_solve_tol (const DomainScalarMag &adjoint_residual_solve_tol) |
| Set the relative tolerance that will be requested in the residual in the adjoint solve . | |
| void | adjoint_residual_slack_warning_tol (const DomainScalarMag &adjoint_residual_slack_warning_tol) |
| | |
| void | adjoint_residual_slack_error_tol (const DomainScalarMag &adjoint_residual_slack_error_tol) |
| | |
| void | check_adjoint_solution_error (const bool &check_adjoint_solution_error) |
| Set if a tolerance on the solution error of the adjoint solve should checked or not. | |
| void | adjoint_solution_error_solve_tol (const RangeScalarMag &adjoint_solution_error_solve_tol) |
| Set the relative tolerance that will be requested in the solution_error for the adjoint solve . | |
| void | adjoint_solution_error_slack_warning_tol (const RangeScalarMag &adjoint_solution_error_slack_warning_tol) |
| | |
| void | adjoint_solution_error_slack_error_tol (const RangeScalarMag &adjoint_solution_error_slack_error_tol) |
| | |
| void | num_random_vectors (const int &num_random_vectors) |
| Set the number random vectors that is generated during each test. | |
| void | show_all_tests (const bool &show_all_tests) |
| Set if all tests are shown or just summaries. | |
| void | dump_all (const bool &dump_all) |
Set if all of the vectors are dumped or not (only relevant if show_all_tests()==true). | |
| void | turn_off_all_tests () |
| Turn off all tests so that individual tests can be set. | |
| void | set_all_solve_tol (const ScalarMag solve_tol) |
| Set all the solve tolerances to the same value. | |
| void | set_all_slack_warning_tol (const ScalarMag slack_warning_tol) |
| Set all the warning tolerances to the same value. | |
| void | set_all_slack_error_tol (const ScalarMag slack_error_tol) |
| Set all the error tolerances to the same value. | |
| bool | check (const LinearOpWithSolveBase< RangeScalar, DomainScalar > &op, std::ostream *out, const std::string &leadingIndent="", const std::string &indentSpacer=" ") const |
Check a LinearOpWithSolveBase object. | |
LinearOpWithSolveBase.
This testing class can be used in several different roles:
This class can check single linear solves or multi-RHS (i.e. multi-vector) linear solves.
As a general rule, the client can specify tolerances that are used to determine if a test is successful or not.
The client can pass in randomizer objects that create "random" vectors and multi-vectors that are used by the testing class. This can be very important in some cases and this gives the client full control over what data is used in the tests.
This testing class is not designed to test the LinearOpBase interface. For that purpose, use the LinearOpTester class in conjunction with this testing class to fully validate a LinearOpWithSolveBase object.
ToDo: Finish documentation!
Definition at line 74 of file Thyra_LinearOpWithSolveTesterDecl.hpp.
|
|||||
|
Definition at line 78 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
|||||
|
Definition at line 80 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
|||||
|
Definition at line 82 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
|||||
|
Definition at line 84 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Default constructor which sets default parameter values. Note: It is not recommended that the client pass in values in this constructor since the argument list may change in the near future but instead use the below set functions to change an option after construction. Definition at line 42 of file Thyra_LinearOpWithSolveTester.hpp. |
|
||||||||||
|
Set if a default forward solve will be performed on not.
Definition at line 126 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Definition at line 129 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Definition at line 132 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Definition at line 135 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Definition at line 138 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Set if a tolerance on the residual of the forward solve should checked or not.
Definition at line 141 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Set the relative tolerance that will be requested in the residual for the forward solve .
Definition at line 145 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Definition at line 148 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Definition at line 151 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Set if a tolerance on the solution error of the forward solve should checked or not.
Definition at line 154 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Set the relative tolerance that will be requested in the solution_error for the forward solve .
Definition at line 158 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Definition at line 161 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Definition at line 164 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Set if a default forward solve will be performed on not.
Definition at line 167 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Definition at line 170 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Definition at line 173 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Definition at line 176 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Definition at line 179 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Set if a tolerance on the residual of the adjoint solve should checked or not.
Definition at line 183 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Set the relative tolerance that will be requested in the residual in the adjoint solve .
Definition at line 187 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Definition at line 190 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Definition at line 193 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Set if a tolerance on the solution error of the adjoint solve should checked or not.
Definition at line 196 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Set the relative tolerance that will be requested in the solution_error for the adjoint solve .
Definition at line 200 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Definition at line 203 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Definition at line 206 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Set the number random vectors that is generated during each test.
Definition at line 210 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Set if all tests are shown or just summaries.
Definition at line 214 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
||||||||||
|
Set if all of the vectors are dumped or not (only relevant if
Definition at line 219 of file Thyra_LinearOpWithSolveTesterDecl.hpp. |
|
|||||||||
|
Turn off all tests so that individual tests can be set. Postconditions: Definition at line 105 of file Thyra_LinearOpWithSolveTester.hpp. |
|
||||||||||
|
Set all the solve tolerances to the same value. Postconditions: Definition at line 116 of file Thyra_LinearOpWithSolveTester.hpp. |
|
||||||||||
|
Set all the warning tolerances to the same value. Postconditions: Definition at line 126 of file Thyra_LinearOpWithSolveTester.hpp. |
|
||||||||||
|
Set all the error tolerances to the same value. Postconditions: Definition at line 139 of file Thyra_LinearOpWithSolveTester.hpp. |
|
||||||||||||||||||||||||
|
Check a ToDo: Finish documentation! Definition at line 152 of file Thyra_LinearOpWithSolveTester.hpp. |
1.3.9.1