NOX::Petsc::Options Class Reference

Class to convert solver options from command line (or command input file) into a form usable by NOX. More...

#include <NOX_Petsc_Options.H>

List of all members.

Public Member Functions
	Options ()
	Constructor.
	Options (Teuchos::ParameterList &params, int rank=0)
	Constructor.
	~Options ()
	Destructor.
bool	setOptions (Teuchos::ParameterList &params)
	Set parameter list based on options on command line or from file.
Teuchos::RCP < NOX::StatusTest::Combo > &	getStatusTest ()
	Get reference to the final (combo) status test.
Private Types
enum	{ maxStringLength = 256 }
Private Attributes
char	optionString [maxStringLength]
PetscTruth	flg
int	ierr
int	rank
Teuchos::RCP < NOX::StatusTest::MaxIters >	testMaxIters
	Supported convergence criteria.
Teuchos::RCP < NOX::StatusTest::NormF >	testNormF
Teuchos::RCP < NOX::StatusTest::NormUpdate >	testNormUpdate
Teuchos::RCP < NOX::StatusTest::Combo >	testCombo

---

Detailed Description

Class to convert solver options from command line (or command input file) into a form usable by NOX.

Details go here .....

Definition at line 55 of file NOX_Petsc_Options.H.

---

Constructor & Destructor Documentation

Options::Options

(

)

Constructor.

Definition at line 47 of file NOX_Petsc_Options.C.

Options::Options	(	Teuchos::ParameterList &	params,
		int	rank = 0
	)

Constructor.

Definition at line 51 of file NOX_Petsc_Options.C.

References setOptions().

Options::~Options

(

)

Destructor.

Definition at line 57 of file NOX_Petsc_Options.C.

---

Member Function Documentation

bool Options::setOptions

(

Teuchos::ParameterList &

params

)

Set parameter list based on options on command line or from file.

Definition at line 62 of file NOX_Petsc_Options.C.

References NOX::Utils::Details, NOX::Utils::InnerIteration, NOX::StatusTest::Combo::OR, NOX::Utils::OuterIteration, NOX::Utils::OuterIterationStatusTest, NOX::Utils::Parameters, testMaxIters, and NOX::Utils::Warning.

Referenced by Options().

Teuchos::RCP< NOX::StatusTest::Combo > & Options::getStatusTest

(

)

Get reference to the final (combo) status test.

Definition at line 223 of file NOX_Petsc_Options.C.

---

Member Data Documentation

Teuchos::RCP<NOX::StatusTest::MaxIters> NOX::Petsc::Options::testMaxIters [private]

Supported convergence criteria.

Definition at line 83 of file NOX_Petsc_Options.H.

Referenced by setOptions().

---

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

• NOX_Petsc_Options.H
• NOX_Petsc_Options.C