NOX::Solver::PrePostOperator Class Reference

Functor to process the pre/post operator object in the parameter list. More...

#include <NOX_Solver_PrePostOperator.H>

List of all members.

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.
PrePostOperatoroperator= (const PrePostOperator &p)
 Disallow assignment operator.


Detailed Description

Functor to process the pre/post operator object in the parameter list.

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.


Constructor & Destructor Documentation

NOX::Solver::PrePostOperator::PrePostOperator (  )  [private]

Disallow default ctor.

Definition at line 50 of file NOX_Solver_PrePostOperator.C.

NOX::Solver::PrePostOperator::PrePostOperator ( const PrePostOperator p  )  [private]

Disallow copy ctor.

Definition at line 54 of file NOX_Solver_PrePostOperator.C.

NOX::Solver::PrePostOperator::PrePostOperator ( const Teuchos::RCP< NOX::Utils > &  utils,
Teuchos::ParameterList &  solverOptionsSubList 
)

Ctor.

Definition at line 63 of file NOX_Solver_PrePostOperator.C.

References reset().

NOX::Solver::PrePostOperator::~PrePostOperator (  )  [virtual]

Destructor.

Definition at line 68 of file NOX_Solver_PrePostOperator.C.


Member Function Documentation

NOX::Solver::PrePostOperator & NOX::Solver::PrePostOperator::operator= ( const PrePostOperator p  )  [private]

Disallow assignment operator.

Definition at line 59 of file NOX_Solver_PrePostOperator.C.

void NOX::Solver::PrePostOperator::reset ( const Teuchos::RCP< NOX::Utils > &  utils,
Teuchos::ParameterList &  solverOptionsSublist 
) [virtual]

void NOX::Solver::PrePostOperator::runPreIterate ( const NOX::Solver::Generic solver  )  [inline, virtual]

void NOX::Solver::PrePostOperator::runPostIterate ( const NOX::Solver::Generic solver  )  [inline, virtual]

void NOX::Solver::PrePostOperator::runPreSolve ( const NOX::Solver::Generic solver  )  [inline, virtual]

void NOX::Solver::PrePostOperator::runPostSolve ( const NOX::Solver::Generic solver  )  [inline, virtual]


Member Data Documentation

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().

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().


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

Generated on Wed Oct 21 14:28:48 2009 for Nonlinear Solver Project by  doxygen 1.5.9