Thyra Package Browser (Single Doxygen Collection) Version of the Day
Static Private Attributes
Thyra::LinearOpWithSolveTester< Scalar > Class Template Reference

Testing class for LinearOpWithSolveBase. More...

#include <Thyra_LinearOpWithSolveTester_decl.hpp>

Inheritance diagram for Thyra::LinearOpWithSolveTester< Scalar >:
Inheritance graph
[legend]

List of all members.

Static Private Attributes

static const bool check_forward_default_default_
static const bool check_forward_residual_default_
static const bool check_adjoint_default_default_
static const bool check_adjoint_residual_default_
static const ScalarMag warning_tol_default_
static const ScalarMag error_tol_default_
static const ScalarMag solve_tol_default_
static const ScalarMag slack_warning_tol_default_
static const ScalarMag slack_error_tol_default_
static const int num_random_vectors_default_
static const bool show_all_tests_default_
static const bool dump_all_default_
static const int num_rhs_default_
static const std::string AllSolveTol_name_
static const std::string AllSlackWarningTol_name_
static const std::string AllSlackErrorTol_name_
static const std::string ShowAllTests_name_
static const std::string DumpAll_name_

Public types .

typedef Teuchos::ScalarTraits
< Scalar >::magnitudeType 
ScalarMag
 

Constructors/initializers

 LinearOpWithSolveTester ()
 Default constructor.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, check_forward_default)
 Set if a default forward solve will be performed on not.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, forward_default_residual_warning_tol)
 
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, forward_default_residual_error_tol)
 
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, forward_default_solution_error_warning_tol)
 
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, forward_default_solution_error_error_tol)
 
 STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, check_forward_residual)
 Set if a tolerance on the residual of the forward solve should checked or not.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, forward_residual_solve_tol)
 Set the relative tolerance that will be requested in the residual for the forward solve .
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, forward_residual_slack_warning_tol)
 
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, forward_residual_slack_error_tol)
 
 STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, check_adjoint_default)
 Set if a default forward solve will be performed on not.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, adjoint_default_residual_warning_tol)
 
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, adjoint_default_residual_error_tol)
 
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, adjoint_default_solution_error_warning_tol)
 
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, adjoint_default_solution_error_error_tol)
 
 STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, check_adjoint_residual)
 Set if a tolerance on the residual of the adjoint solve should checked or not.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, adjoint_residual_solve_tol)
 Set the relative tolerance that will be requested in the residual in the adjoint solve .
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, adjoint_residual_slack_warning_tol)
 
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, adjoint_residual_slack_error_tol)
 
 STANDARD_MEMBER_COMPOSITION_MEMBERS (int, num_random_vectors)
 Set the number random vectors that is generated during each test.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, show_all_tests)
 Set if all tests are shown or just summaries.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, dump_all)
 Set if all of the vectors are dumped or not (only relevant if show_all_tests()==true).
 STANDARD_MEMBER_COMPOSITION_MEMBERS (int, num_rhs)
 Set the number of right-hand-sides in the multivectors.
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.

Overridden from ParameterListAcceptor

void setParameterList (const RCP< ParameterList > &paramList)
 
RCP< const ParameterListgetValidParameters () const
 

LOWS testing

bool check (const LinearOpWithSolveBase< Scalar > &op, Teuchos::FancyOStream *out) const
 Check a LinearOpWithSolveBase object.

Detailed Description

template<class Scalar>
class Thyra::LinearOpWithSolveTester< Scalar >

Testing class for 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 79 of file Thyra_LinearOpWithSolveTester_decl.hpp.


Member Typedef Documentation

template<class Scalar>
typedef Teuchos::ScalarTraits<Scalar>::magnitudeType Thyra::LinearOpWithSolveTester< Scalar >::ScalarMag

Definition at line 88 of file Thyra_LinearOpWithSolveTester_decl.hpp.


Constructor & Destructor Documentation

template<class Scalar >
Thyra::LinearOpWithSolveTester< Scalar >::LinearOpWithSolveTester ( )

Default constructor.

Definition at line 52 of file Thyra_LinearOpWithSolveTester_def.hpp.


Member Function Documentation

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( bool  ,
check_forward_default   
)

Set if a default forward solve will be performed on not.

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
forward_default_residual_warning_tol   
)

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
forward_default_residual_error_tol   
)

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
forward_default_solution_error_warning_tol   
)

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
forward_default_solution_error_error_tol   
)

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( bool  ,
check_forward_residual   
)

Set if a tolerance on the residual of the forward solve should checked or not.

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
forward_residual_solve_tol   
)

Set the relative tolerance that will be requested in the residual for the forward solve .

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
forward_residual_slack_warning_tol   
)

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
forward_residual_slack_error_tol   
)

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( bool  ,
check_adjoint_default   
)

Set if a default forward solve will be performed on not.

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
adjoint_default_residual_warning_tol   
)

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
adjoint_default_residual_error_tol   
)

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
adjoint_default_solution_error_warning_tol   
)

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
adjoint_default_solution_error_error_tol   
)

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( bool  ,
check_adjoint_residual   
)

Set if a tolerance on the residual of the adjoint solve should checked or not.

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
adjoint_residual_solve_tol   
)

Set the relative tolerance that will be requested in the residual in the adjoint solve .

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
adjoint_residual_slack_warning_tol   
)

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
adjoint_residual_slack_error_tol   
)

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( int  ,
num_random_vectors   
)

Set the number random vectors that is generated during each test.

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( bool  ,
show_all_tests   
)

Set if all tests are shown or just summaries.

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( bool  ,
dump_all   
)

Set if all of the vectors are dumped or not (only relevant if show_all_tests()==true).

template<class Scalar>
Thyra::LinearOpWithSolveTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( int  ,
num_rhs   
)

Set the number of right-hand-sides in the multivectors.

template<class Scalar >
void Thyra::LinearOpWithSolveTester< Scalar >::turn_off_all_tests ( )

Turn off all tests so that individual tests can be set.

Postconditions:

  • ???

Definition at line 79 of file Thyra_LinearOpWithSolveTester_def.hpp.

template<class Scalar >
void Thyra::LinearOpWithSolveTester< Scalar >::set_all_solve_tol ( const ScalarMag  solve_tol)

Set all the solve tolerances to the same value.

Postconditions:

  • ???

Definition at line 90 of file Thyra_LinearOpWithSolveTester_def.hpp.

Referenced by main().

template<class Scalar >
void Thyra::LinearOpWithSolveTester< Scalar >::set_all_slack_warning_tol ( const ScalarMag  slack_warning_tol)

Set all the warning tolerances to the same value.

Postconditions:

  • ???

Definition at line 101 of file Thyra_LinearOpWithSolveTester_def.hpp.

Referenced by main().

template<class Scalar >
void Thyra::LinearOpWithSolveTester< Scalar >::set_all_slack_error_tol ( const ScalarMag  slack_error_tol)

Set all the error tolerances to the same value.

Postconditions:

  • ???

Definition at line 115 of file Thyra_LinearOpWithSolveTester_def.hpp.

Referenced by main().

template<class Scalar >
void Thyra::LinearOpWithSolveTester< Scalar >::setParameterList ( const RCP< ParameterList > &  paramList) [virtual]
template<class Scalar >
RCP< const ParameterList > Thyra::LinearOpWithSolveTester< Scalar >::getValidParameters ( ) const [virtual]

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 149 of file Thyra_LinearOpWithSolveTester_def.hpp.

References is_null().

template<class Scalar >
bool Thyra::LinearOpWithSolveTester< Scalar >::check ( const LinearOpWithSolveBase< Scalar > &  op,
Teuchos::FancyOStream out 
) const

Member Data Documentation

template<class Scalar>
const bool Thyra::LinearOpWithSolveTester< Scalar >::check_forward_default_default_ [static, private]

Definition at line 233 of file Thyra_LinearOpWithSolveTester_decl.hpp.

template<class Scalar>
const bool Thyra::LinearOpWithSolveTester< Scalar >::check_forward_residual_default_ [static, private]

Definition at line 234 of file Thyra_LinearOpWithSolveTester_decl.hpp.

template<class Scalar>
const bool Thyra::LinearOpWithSolveTester< Scalar >::check_adjoint_default_default_ [static, private]

Definition at line 235 of file Thyra_LinearOpWithSolveTester_decl.hpp.

template<class Scalar>
const bool Thyra::LinearOpWithSolveTester< Scalar >::check_adjoint_residual_default_ [static, private]

Definition at line 236 of file Thyra_LinearOpWithSolveTester_decl.hpp.

template<class Scalar>
const ScalarMag Thyra::LinearOpWithSolveTester< Scalar >::warning_tol_default_ [static, private]

Definition at line 238 of file Thyra_LinearOpWithSolveTester_decl.hpp.

template<class Scalar>
const ScalarMag Thyra::LinearOpWithSolveTester< Scalar >::error_tol_default_ [static, private]

Definition at line 239 of file Thyra_LinearOpWithSolveTester_decl.hpp.

template<class Scalar>
const ScalarMag Thyra::LinearOpWithSolveTester< Scalar >::solve_tol_default_ [static, private]

Definition at line 240 of file Thyra_LinearOpWithSolveTester_decl.hpp.

template<class Scalar>
const ScalarMag Thyra::LinearOpWithSolveTester< Scalar >::slack_warning_tol_default_ [static, private]

Definition at line 241 of file Thyra_LinearOpWithSolveTester_decl.hpp.

template<class Scalar>
const ScalarMag Thyra::LinearOpWithSolveTester< Scalar >::slack_error_tol_default_ [static, private]

Definition at line 242 of file Thyra_LinearOpWithSolveTester_decl.hpp.

template<class Scalar>
const int Thyra::LinearOpWithSolveTester< Scalar >::num_random_vectors_default_ [static, private]

Definition at line 244 of file Thyra_LinearOpWithSolveTester_decl.hpp.

template<class Scalar>
const bool Thyra::LinearOpWithSolveTester< Scalar >::show_all_tests_default_ [static, private]

Definition at line 245 of file Thyra_LinearOpWithSolveTester_decl.hpp.

template<class Scalar>
const bool Thyra::LinearOpWithSolveTester< Scalar >::dump_all_default_ [static, private]

Definition at line 246 of file Thyra_LinearOpWithSolveTester_decl.hpp.

template<class Scalar>
const int Thyra::LinearOpWithSolveTester< Scalar >::num_rhs_default_ [static, private]

Definition at line 247 of file Thyra_LinearOpWithSolveTester_decl.hpp.

template<class Scalar>
const std::string Thyra::LinearOpWithSolveTester< Scalar >::AllSolveTol_name_ [static, private]

Definition at line 249 of file Thyra_LinearOpWithSolveTester_decl.hpp.

template<class Scalar>
const std::string Thyra::LinearOpWithSolveTester< Scalar >::AllSlackWarningTol_name_ [static, private]

Definition at line 250 of file Thyra_LinearOpWithSolveTester_decl.hpp.

template<class Scalar>
const std::string Thyra::LinearOpWithSolveTester< Scalar >::AllSlackErrorTol_name_ [static, private]

Definition at line 251 of file Thyra_LinearOpWithSolveTester_decl.hpp.

template<class Scalar>
const std::string Thyra::LinearOpWithSolveTester< Scalar >::ShowAllTests_name_ [static, private]

Definition at line 252 of file Thyra_LinearOpWithSolveTester_decl.hpp.

template<class Scalar>
const std::string Thyra::LinearOpWithSolveTester< Scalar >::DumpAll_name_ [static, private]

Definition at line 253 of file Thyra_LinearOpWithSolveTester_decl.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines