#include <NOX_Abstract_PrePostOperator.H>
Public Member Functions | |
PrePostOperator () | |
Abstract Vector constructor (does nothing) | |
PrePostOperator (const NOX::Abstract::PrePostOperator &source) | |
Copy constructor (doesnothing). | |
virtual | ~PrePostOperator () |
Abstract Vector destructor (does nothing) | |
virtual void | runPreIterate (const NOX::Solver::Generic &solver) |
User defined method that will be executed at the start of a call to NOX::Solver::Generic::iterate(). | |
virtual void | runPostIterate (const NOX::Solver::Generic &solver) |
User defined method that will be executed at the end of a call to NOX::Solver::Generic::iterate(). | |
virtual void | runPreSolve (const NOX::Solver::Generic &solver) |
User defined method that will be executed at the start of a call to NOX::Solver::Generic::solve(). | |
virtual void | runPostSolve (const NOX::Solver::Generic &solver) |
User defined method that will be executed at the end of a call to NOX::Solver::Generic::solve(). |
The user should implement their own concrete implementation of this class and register it as a Teuchos::RCP<NOX::Abstract::PrePostoperator> in the "Solver Options" sublist.
To create and use a user defined pre/post operators:
Foo
might be defined as shown below.
class Foo : public NOX::Abstract::PrePostOperator { // Insert class definition here }
Teuchos::RCP<Foo> foo = Teuchos::rcp(new Foo); params.sublist("Sovler Options").set<NOX::Abstract::PrePostOperator>("User Defined Pre/Post Operator", foo);
Definition at line 96 of file NOX_Abstract_PrePostOperator.H.
NOX::Abstract::PrePostOperator::PrePostOperator | ( | ) | [inline] |
Abstract Vector constructor (does nothing)
Definition at line 101 of file NOX_Abstract_PrePostOperator.H.
NOX::Abstract::PrePostOperator::PrePostOperator | ( | const NOX::Abstract::PrePostOperator & | source | ) | [inline] |
virtual NOX::Abstract::PrePostOperator::~PrePostOperator | ( | ) | [inline, virtual] |
Abstract Vector destructor (does nothing)
Definition at line 107 of file NOX_Abstract_PrePostOperator.H.
void NOX::Abstract::PrePostOperator::runPreIterate | ( | const NOX::Solver::Generic & | solver | ) | [inline, virtual] |
User defined method that will be executed at the start of a call to NOX::Solver::Generic::iterate().
Reimplemented in NOX::Epetra::BroydenOperator.
Definition at line 126 of file NOX_Abstract_PrePostOperator.H.
void NOX::Abstract::PrePostOperator::runPostIterate | ( | const NOX::Solver::Generic & | solver | ) | [inline, virtual] |
User defined method that will be executed at the end of a call to NOX::Solver::Generic::iterate().
Reimplemented in NOX::Epetra::BroydenOperator.
Definition at line 131 of file NOX_Abstract_PrePostOperator.H.
void NOX::Abstract::PrePostOperator::runPreSolve | ( | const NOX::Solver::Generic & | solver | ) | [inline, virtual] |
User defined method that will be executed at the start of a call to NOX::Solver::Generic::solve().
Reimplemented in NOX::Epetra::BroydenOperator.
Definition at line 136 of file NOX_Abstract_PrePostOperator.H.
void NOX::Abstract::PrePostOperator::runPostSolve | ( | const NOX::Solver::Generic & | solver | ) | [inline, virtual] |
User defined method that will be executed at the end of a call to NOX::Solver::Generic::solve().
Reimplemented in NOX::Epetra::BroydenOperator.
Definition at line 141 of file NOX_Abstract_PrePostOperator.H.