NOX Development
Public Member Functions
LOCA::Epetra::Interface::Required Class Reference

Used by LOCA::Epetra::Group to provide a link to the external code for setting problem parameters. More...

#include <LOCA_Epetra_Interface_Required.H>

Inheritance diagram for LOCA::Epetra::Interface::Required:
Inheritance graph
[legend]
Collaboration diagram for LOCA::Epetra::Interface::Required:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 Required ()
 Constructor.
virtual ~Required ()
 Destructor.
virtual void setParameters (const ParameterVector &p)=0
 Set parameters in the user's application.
virtual void printSolution (const Epetra_Vector &x_, double conParam)
 Call user's own print routine for vector-parameter pair.
virtual void dataForPrintSolution (const int conStep, const int timeStep, const int totalTimeSteps)
 Provides data to application for output files.
virtual void setMultiPointParameter (const int stepNum)
 Set multipoint parameter in the user's application.
virtual void preProcessContinuationStep (LOCA::Abstract::Iterator::StepStatus stepStatus, LOCA::Epetra::Group &group)
 Perform any preprocessing before a continuation step starts.
virtual void postProcessContinuationStep (LOCA::Abstract::Iterator::StepStatus stepStatus, LOCA::Epetra::Group &group)
 Perform any postprocessing after a continuation step finishes.
virtual void projectToDraw (const NOX::Epetra::Vector &x, double *px) const
 Projects solution to a few scalars for multiparameter continuation.
virtual int projectToDrawDimension () const
 Returns the dimension of the projection to draw array.

Detailed Description

Used by LOCA::Epetra::Group to provide a link to the external code for setting problem parameters.

This interface is derived from the NOX::Epetra::Interface::Required and additionally provides a method for setting problem parameters.


Member Function Documentation

virtual void LOCA::Epetra::Interface::Required::dataForPrintSolution ( const int  conStep,
const int  timeStep,
const int  totalTimeSteps 
) [inline, virtual]

Provides data to application for output files.

This routine is called from Interface::xyzt::printSolution() just before the call to Interface::Required::printSolution(x,param), and gives the application some indices that can be used for creating a unique name/index for the output files.

virtual void LOCA::Epetra::Interface::Required::postProcessContinuationStep ( LOCA::Abstract::Iterator::StepStatus  stepStatus,
LOCA::Epetra::Group group 
) [inline, virtual]

Perform any postprocessing after a continuation step finishes.

The stepStatus argument indicates whether the step was successful. The default implementation here is empty.

virtual void LOCA::Epetra::Interface::Required::preProcessContinuationStep ( LOCA::Abstract::Iterator::StepStatus  stepStatus,
LOCA::Epetra::Group group 
) [inline, virtual]

Perform any preprocessing before a continuation step starts.

The stepStatus argument indicates whether the previous step was successful. The default implementation here is empty.

virtual void LOCA::Epetra::Interface::Required::projectToDraw ( const NOX::Epetra::Vector x,
double *  px 
) const [inline, virtual]

Projects solution to a few scalars for multiparameter continuation.

Default implementation is the max norm.

References NOX::Abstract::Vector::MaxNorm, and NOX::Epetra::Vector::norm().

virtual void LOCA::Epetra::Interface::Required::setMultiPointParameter ( const int  stepNum) [inline, virtual]

Set multipoint parameter in the user's application.

Should be called prior to calling one of the compute functions.

virtual void LOCA::Epetra::Interface::Required::setParameters ( const ParameterVector p) [pure virtual]

Set parameters in the user's application.

Should be called prior to calling one of the compute functions.

Implemented in LOCAInterface, and LOCA::Epetra::ModelEvaluatorInterface.


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