AMP::Solver::AndersonStatusTest Class Reference

#include <AndersonStatusTest.h>

Inherits NOX::StatusTest::Generic.

Public Member Functions
	AndersonStatusTest (std::shared_ptr< AMP::Database > db)
NOX::StatusTest::StatusType	checkStatus (const NOX::Solver::Generic &solver, NOX::StatusTest::CheckType checkType)
NOX::StatusTest::StatusType	getStatus () const
std::ostream &	print (std::ostream &stream, int indent=0) const
virtual	~AndersonStatusTest ()

Protected Attributes
std::vector< double >	d_relativeResiduals
NOX::StatusTest::StatusType	d_status
std::vector< double >	d_tolerances
std::vector< std::string >	d_variableNames

Detailed Description

The AndersonStatusTest implements a AMP-specific stopping criteria for use with the NOX Anderson acceleration solver.

Definition at line 23 of file AndersonStatusTest.h.

Constructor & Destructor Documentation

AndersonStatusTest()

AMP::Solver::AndersonStatusTest::AndersonStatusTest ( std::shared_ptr< AMP::Database >  db )

explicit

main constructor

Parameters

[in]

db

The database object containing teh following fields:

1. type: vector<string>, name: AndersonConvergenceVariables, default value: "", acceptable values (any variable name on solution vector)
2. type: vector<double>, name: AndersonConvergenceTolerances, default value: "", acceptable values (>0.0)

~AndersonStatusTest()

virtual AMP::Solver::AndersonStatusTest::~AndersonStatusTest ( )

virtual

Default destructor.

Member Function Documentation

checkStatus()

NOX::StatusTest::StatusType AMP::Solver::AndersonStatusTest::checkStatus	(	const NOX::Solver::Generic &	solver,
		NOX::StatusTest::CheckType	checkType
	)

Test the stopping criterion

Parameters

solver	Instance of solver for which convergence is being evaluated.
checkType	Type of convergence check

getStatus()

NOX::StatusTest::StatusType AMP::Solver::AndersonStatusTest::getStatus

(

)

const

Return the result of the most recent checkStatus call.

print()

std::ostream & AMP::Solver::AndersonStatusTest::print	(	std::ostream &	stream,
		int	indent = 0
	)		const

Output formatted description of stopping test to output stream.

Member Data Documentation

d_relativeResiduals

std::vector<double> AMP::Solver::AndersonStatusTest::d_relativeResiduals

protected

Definition at line 69 of file AndersonStatusTest.h.

d_status

NOX::StatusTest::StatusType AMP::Solver::AndersonStatusTest::d_status

protected

Definition at line 64 of file AndersonStatusTest.h.

d_tolerances

std::vector<double> AMP::Solver::AndersonStatusTest::d_tolerances

protected

Definition at line 68 of file AndersonStatusTest.h.

d_variableNames

std::vector<std::string> AMP::Solver::AndersonStatusTest::d_variableNames

protected

Definition at line 67 of file AndersonStatusTest.h.

---

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

• src/solvers/trilinos/nox/AndersonStatusTest.h