#include <NOX_Solver_PrePostOperator.H>
Public Member Functions | |
PrePostOperator (const Teuchos::RCP< NOX::Utils > &utils, Teuchos::ParameterList &solverOptionsSubList) | |
Ctor. | |
virtual | ~PrePostOperator () |
Destructor. | |
virtual void | reset (const Teuchos::RCP< NOX::Utils > &utils, Teuchos::ParameterList &solverOptionsSublist) |
Resets the pre/post operator. | |
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(). | |
Protected Attributes | |
bool | havePrePostOperator |
Flag that determines if a pre/post operator has been supplied by user. | |
Teuchos::RCP < NOX::Abstract::PrePostOperator > | prePostOperatorPtr |
Points to user defined pre/post operator. | |
Private Member Functions | |
PrePostOperator () | |
Disallow default ctor. | |
PrePostOperator (const PrePostOperator &p) | |
Disallow copy ctor. | |
PrePostOperator & | operator= (const PrePostOperator &p) |
Disallow assignment operator. |
This is a wrapper class for a user derived NOX::Abstract::PrePostOperator (ppo) object. All solvers use this class so we don't have to repeat all parsing code in each NOX::Solver. This class searches the "Solver Options" parameter list passed into the ctor and if a ppo is found will wrap the object.
For instructions on how to implement a PrePostOperator, see NOX::Abstract::PrePostOperator.
Definition at line 81 of file NOX_Solver_PrePostOperator.H.
NOX::Solver::PrePostOperator::PrePostOperator | ( | ) | [private] |
NOX::Solver::PrePostOperator::PrePostOperator | ( | const PrePostOperator & | p | ) | [private] |
NOX::Solver::PrePostOperator::PrePostOperator | ( | const Teuchos::RCP< NOX::Utils > & | utils, | |
Teuchos::ParameterList & | solverOptionsSubList | |||
) |
NOX::Solver::PrePostOperator::~PrePostOperator | ( | ) | [virtual] |
NOX::Solver::PrePostOperator & NOX::Solver::PrePostOperator::operator= | ( | const PrePostOperator & | p | ) | [private] |
void NOX::Solver::PrePostOperator::reset | ( | const Teuchos::RCP< NOX::Utils > & | utils, | |
Teuchos::ParameterList & | solverOptionsSublist | |||
) | [virtual] |
Resets the pre/post operator.
Definition at line 72 of file NOX_Solver_PrePostOperator.C.
References havePrePostOperator, and prePostOperatorPtr.
Referenced by PrePostOperator(), NOX::Solver::TensorBased::reset(), and NOX::Multiphysics::Solver::FixedPointBased::reset().
void NOX::Solver::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().
Definition at line 133 of file NOX_Solver_PrePostOperator.H.
References havePrePostOperator, and prePostOperatorPtr.
Referenced by NOX::Epetra::BroydenOperator::runPreIterate(), NOX::Solver::TrustRegionBased::step(), NOX::Solver::TensorBased::step(), NOX::Solver::LineSearchBased::step(), NOX::Solver::InexactTrustRegionBased::step(), and NOX::Multiphysics::Solver::FixedPointBased::step().
void NOX::Solver::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().
Definition at line 140 of file NOX_Solver_PrePostOperator.H.
References havePrePostOperator, and prePostOperatorPtr.
Referenced by NOX::Epetra::BroydenOperator::runPostIterate(), NOX::Solver::TrustRegionBased::step(), NOX::Solver::TensorBased::step(), NOX::Solver::LineSearchBased::step(), NOX::Solver::InexactTrustRegionBased::step(), and NOX::Multiphysics::Solver::FixedPointBased::step().
void NOX::Solver::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().
Definition at line 147 of file NOX_Solver_PrePostOperator.H.
References havePrePostOperator, and prePostOperatorPtr.
Referenced by NOX::Epetra::BroydenOperator::runPreSolve(), NOX::Solver::TrustRegionBased::solve(), NOX::Solver::TensorBased::solve(), NOX::Solver::LineSearchBased::solve(), NOX::Solver::InexactTrustRegionBased::solve(), and NOX::Multiphysics::Solver::FixedPointBased::solve().
void NOX::Solver::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().
Definition at line 154 of file NOX_Solver_PrePostOperator.H.
References havePrePostOperator, and prePostOperatorPtr.
Referenced by NOX::Epetra::BroydenOperator::runPostSolve(), NOX::Solver::TrustRegionBased::solve(), NOX::Solver::TensorBased::solve(), NOX::Solver::LineSearchBased::solve(), NOX::Solver::InexactTrustRegionBased::solve(), and NOX::Multiphysics::Solver::FixedPointBased::solve().
bool NOX::Solver::PrePostOperator::havePrePostOperator [protected] |
Flag that determines if a pre/post operator has been supplied by user.
Definition at line 123 of file NOX_Solver_PrePostOperator.H.
Referenced by reset(), runPostIterate(), runPostSolve(), runPreIterate(), and runPreSolve().
Teuchos::RCP<NOX::Abstract::PrePostOperator> NOX::Solver::PrePostOperator::prePostOperatorPtr [protected] |
Points to user defined pre/post operator.
Definition at line 126 of file NOX_Solver_PrePostOperator.H.
Referenced by reset(), runPostIterate(), runPostSolve(), runPreIterate(), and runPreSolve().