NOX Development
Public Member Functions | Protected Attributes
NOX::Solver::PrePostOperator Class Reference

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

#include <NOX_Solver_PrePostOperator.H>

Collaboration diagram for NOX::Solver::PrePostOperator:
Collaboration graph
[legend]

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.

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.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends