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>
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.
Definition at line 79 of file LOCA_Epetra_Interface_Required.H.
Constructor & Destructor Documentation
| LOCA::Epetra::Interface::Required::Required | ( | ) | [inline] |
Constructor.
Reimplemented from NOX::Epetra::Interface::Required.
Definition at line 84 of file LOCA_Epetra_Interface_Required.H.
| virtual LOCA::Epetra::Interface::Required::~Required | ( | ) | [inline, virtual] |
Destructor.
Reimplemented from NOX::Epetra::Interface::Required.
Definition at line 87 of file LOCA_Epetra_Interface_Required.H.
Member Function Documentation
| 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 LOCA::Epetra::Interface::MultiPoint, LOCA::Epetra::Interface::xyzt, and LOCA::Epetra::ModelEvaluatorInterface.
| virtual void LOCA::Epetra::Interface::Required::printSolution | ( | const Epetra_Vector & | x_, | |
| double | conParam | |||
| ) | [inline, virtual] |
Call user's own print routine for vector-parameter pair.
Reimplemented in LOCA::Epetra::Interface::MultiPoint, and LOCA::Epetra::Interface::xyzt.
Definition at line 97 of file LOCA_Epetra_Interface_Required.H.
| 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.
Definition at line 108 of file LOCA_Epetra_Interface_Required.H.
| 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.
Definition at line 116 of file LOCA_Epetra_Interface_Required.H.
| 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.
Definition at line 125 of file LOCA_Epetra_Interface_Required.H.
| 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.
Definition at line 135 of file LOCA_Epetra_Interface_Required.H.
| 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.
Definition at line 145 of file LOCA_Epetra_Interface_Required.H.
References NOX::Abstract::Vector::MaxNorm, and NOX::Epetra::Vector::norm().
| virtual int LOCA::Epetra::Interface::Required::projectToDrawDimension | ( | ) | const [inline, virtual] |
Returns the dimension of the projection to draw array.
Definition at line 151 of file LOCA_Epetra_Interface_Required.H.
The documentation for this class was generated from the following file:
