NOX  Development
Public Types | Public Member Functions | List of all members
NOX::PrePostOperatorVector Class Reference

Concrete implementation of PrePostOperator that stores a vector of PrePostOperators. More...

#include <NOX_PrePostOperator_Vector.H>

Inheritance diagram for NOX::PrePostOperatorVector:
Inheritance graph
[legend]
Collaboration diagram for NOX::PrePostOperatorVector:
Collaboration graph
[legend]

Public Types

typedef std::vector< Teuchos::RCP< NOX::Abstract::PrePostOperator > >::iterator it
 

Public Member Functions

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().
 
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().
 
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().
 
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().
 
void runPreSolutionUpdate (const NOX::Abstract::Vector &update, const NOX::Solver::Generic &solver)
 User defined method that will be executed prior to the update of the solution vector during a call to NOX::Solver::Generic::step(). This is intended to allow users to adjust the direction before the solution update, typically based on knowledge of the problem formulation. The direction is const as we can't guarantee that changes to the direction won't violate assumptions of the solution algorithm. Users can change the update/direciton after a const cast, but NOX may not function as expected. Use at your own risk! More...
 
void runPreLineSearch (const NOX::Solver::Generic &solver)
 User defined method that will be executed before a call to NOX::LineSearch::Generic::compute(). Only to be used in NOX::Solver::LineSearchBased!
 
void runPostLineSearch (const NOX::Solver::Generic &solver)
 User defined method that will be executed after a call to NOX::LineSearch::Generic::compute(). Only to be used in NOX::Solver::LineSearchBased!
 
void pushBack (const Teuchos::RCP< NOX::Abstract::PrePostOperator > &ppop)
 Add PrePostOperator to end of vector.
 
void popBack ()
 Remove PrePostOperator from end of vector.
 
void clear ()
 Clear the vector of PrePostOperators.
 
- Public Member Functions inherited from NOX::Abstract::PrePostOperator
 PrePostOperator ()
 Constructor.
 
 PrePostOperator (const NOX::Abstract::PrePostOperator &)
 Copy constructor.
 
virtual ~PrePostOperator ()
 Destructor.
 

Detailed Description

Concrete implementation of PrePostOperator that stores a vector of PrePostOperators.

The intent of this object to to aggregate a set of PrePostOperator objects.

Author
Roger Pawlowski (SNL 1444)

Member Function Documentation

◆ runPreSolutionUpdate()

void NOX::PrePostOperatorVector::runPreSolutionUpdate ( const NOX::Abstract::Vector update,
const NOX::Solver::Generic solver 
)
virtual

User defined method that will be executed prior to the update of the solution vector during a call to NOX::Solver::Generic::step(). This is intended to allow users to adjust the direction before the solution update, typically based on knowledge of the problem formulation. The direction is const as we can't guarantee that changes to the direction won't violate assumptions of the solution algorithm. Users can change the update/direciton after a const cast, but NOX may not function as expected. Use at your own risk!

Parameters
[in]update- the direction vector that will be used to update the solution. This will not
[in]solver- the nox solver

Reimplemented from NOX::Abstract::PrePostOperator.


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