Testing class for LinearOpWithSolveBase. More...

#include <Thyra_LinearOpWithSolveTester_decl.hpp>

Inheritance diagram for Thyra::LinearOpWithSolveTester< Scalar >:

Public types .
typedef Teuchos::ScalarTraits < Scalar >::magnitudeType	ScalarMag

Constructors/initializers
	LinearOpWithSolveTester ()
	Default constructor. More...

	STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, check_forward_default)
	Set if a default forward solve will be performed on not. More...

	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. More...

	STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, forward_residual_solve_tol)
	Set the relative tolerance that will be requested in the residual for the forward solve . More...

	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. More...

	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. More...

	STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, adjoint_residual_solve_tol)
	Set the relative tolerance that will be requested in the residual in the adjoint solve . More...

	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. More...

	STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, show_all_tests)
	Set if all tests are shown or just summaries. More...

	STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, dump_all)
	Set if all of the vectors are dumped or not (only relevant if `show_all_tests()==true`). More...

	STANDARD_MEMBER_COMPOSITION_MEMBERS (int, num_rhs)
	Set the number of right-hand-sides in the multivectors. More...

void	turn_off_all_tests ()
	Turn off all tests so that individual tests can be set. More...

void	set_all_solve_tol (const ScalarMag solve_tol)
	Set all the solve tolerances to the same value. More...

void	set_all_slack_warning_tol (const ScalarMag slack_warning_tol)
	Set all the warning tolerances to the same value. More...

void	set_all_slack_error_tol (const ScalarMag slack_error_tol)
	Set all the error tolerances to the same value. More...

Overridden from ParameterListAcceptor
void	setParameterList (const RCP< ParameterList > &paramList)

RCP< const ParameterList >	getValidParameters () const

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

Detailed Description

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

Testing class for LinearOpWithSolveBase.

This testing class can be used in several different roles:

Comprehensive unit testing class: In this mode, all of the capabilities of the solve functions are tested and the post conditions are examined according to a set of tolerances. This is the default mode.
Check of accuracy for specific types of linear solves: In this mode, the client can check only one or more types of linear solves for the sake of efficiency.

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 60 of file Thyra_LinearOpWithSolveTester_decl.hpp.

Member Typedef Documentation

template<class Scalar >

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

Definition at line 69 of file Thyra_LinearOpWithSolveTester_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

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

Default constructor.

Definition at line 33 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 60 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 71 of file Thyra_LinearOpWithSolveTester_def.hpp.

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 82 of file Thyra_LinearOpWithSolveTester_def.hpp.

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 96 of file Thyra_LinearOpWithSolveTester_def.hpp.

template<class Scalar >

void Thyra::LinearOpWithSolveTester< Scalar >::setParameterList ( const RCP< ParameterList > & paramList )

virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 112 of file Thyra_LinearOpWithSolveTester_def.hpp.

template<class Scalar >

RCP< const ParameterList > Thyra::LinearOpWithSolveTester< Scalar >::getValidParameters ( ) const

virtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 130 of file Thyra_LinearOpWithSolveTester_def.hpp.

template<class Scalar >

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

Check a LinearOpWithSolveBase object.

ToDo: Finish documentation!

Definition at line 160 of file Thyra_LinearOpWithSolveTester_def.hpp.

The documentation for this class was generated from the following files:

Public types .

Constructors/initializers

Overridden from ParameterListAcceptor

LOWS testing

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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