NOX::Parameter::PrePostOperator Class Reference

NOX's pure virtual class to allow users to insert pre and post operations into nox's solvers (before and after the NOX::Solver::Generic::iterate() and NOX::Solver::Generic::solve() methods). More...

#include <NOX_Parameter_PrePostOperator.H>

Inheritance diagram for NOX::Parameter::PrePostOperator:

[legend]
Collaboration diagram for NOX::Parameter::PrePostOperator:
[legend]
List of all members.

Public Member Functions

 PrePostOperator ()
 Abstract Vector constructor (does nothing)
 PrePostOperator (const NOX::Parameter::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().

Detailed Description

NOX's pure virtual class to allow users to insert pre and post operations into nox's solvers (before and after the NOX::Solver::Generic::iterate() and NOX::Solver::Generic::solve() methods).

This class is a member of the namespace NOX::Parameter and is derived from the NOX:Parameter::Arbitrary class.

The user should implement their own concrete implementation of this class and register it in the "Solver Options" sublist.

To create and use a user defined pre/post operators:

  1. Create a pre/post operator that derives from NOX::Parameter::PrePostOperator. For example, the pre/post oeprator Foo might be defined as shown below.

      class Foo : public NOX::Parameter::PrePostOperator {
      // Insert class definition here
      }
    

  2. Create the appropriate entries in the parameter list, as follows.

      Foo foo();
      params.sublist("Sovler Options").setParameter("User Defined Pre/Post Operator", foo);
    

Author:
Tammy Kolda (SNL 8950), Roger Pawlowski (SNL 9233)


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:43:33 2008 for NOX by doxygen 1.3.9.1