LOCA::Predictor::Generic Class Reference

Generic predictor direction interface. More...

#include <LOCA_Predictor_Generic.H>

Inheritance diagram for LOCA::Predictor::Generic:

[legend]
Collaboration diagram for LOCA::Predictor::Generic:
[legend]
List of all members.

Public Member Functions

 Generic ()
 Constructor.
virtual ~Generic ()
 Destructor.
virtual NOX::Abstract::Group::ReturnType reset (NOX::Parameter::List &params)
 Reset parameters.
virtual NOX::Abstract::Group::ReturnType compute (bool baseOnSecant, double stepSize, LOCA::Continuation::ExtendedGroup &prevGroup, LOCA::Continuation::ExtendedGroup &curGroup, LOCA::Continuation::ExtendedVector &result)=0
 Compute the predictor direction given the current and previous solution groups. Set baseOnSecant to false if the predictor orientation should not be based on the secant vector (first or last steps of a continuation run).
virtual NOX::Abstract::Group::ReturnType compute (bool baseOnSecant, const vector< double > &stepSize, LOCA::MultiContinuation::ExtendedGroup &grp, LOCA::MultiContinuation::ExtendedMultiVector &prevXMultiVec, LOCA::MultiContinuation::ExtendedMultiVector &xMultiVec, LOCA::MultiContinuation::ExtendedMultiVector &result)=0
 Compute the predictor direction given the current and previous solution groups. Set baseOnSecant to false if the predictor orientation should not be based on the secant vector (first or last steps of a continuation run).

Protected Member Functions

virtual void setPredictorOrientation (bool baseOnSecant, double stepSize, LOCA::Continuation::ExtendedGroup &prevGroup, LOCA::Continuation::ExtendedGroup &curGroup, LOCA::Continuation::ExtendedVector &result)
 Sets orientation of predictor based on parameter change from previous steps.
virtual void setPredictorOrientation (bool baseOnSecant, const vector< double > &stepSize, LOCA::MultiContinuation::ExtendedGroup &grp, LOCA::MultiContinuation::ExtendedMultiVector &prevXMultiVec, LOCA::MultiContinuation::ExtendedMultiVector &xMultiVec, LOCA::MultiContinuation::ExtendedMultiVector &result)
 Sets orientation of predictor based on parameter change from previous steps.

Protected Attributes

LOCA::Continuation::ExtendedVectorsecantVecPtr
 Holds secant vector for setting predictor orientation based on the secant vector orientation.

Detailed Description

Generic predictor direction interface.

Generic interface for computing a predictor for continuation and serves as a base class for all predictor classes.

Also provides a generic method for determining the orientation of the predictor vector by comparing to the secant vector.


Constructor & Destructor Documentation

LOCA::Predictor::Generic::Generic  ) 
 

Constructor.

Constructors of derived objects should look like reset.


Member Function Documentation

void LOCA::Predictor::Generic::setPredictorOrientation bool  baseOnSecant,
const vector< double > &  stepSize,
LOCA::MultiContinuation::ExtendedGroup grp,
LOCA::MultiContinuation::ExtendedMultiVector prevXMultiVec,
LOCA::MultiContinuation::ExtendedMultiVector xMultiVec,
LOCA::MultiContinuation::ExtendedMultiVector result
[protected, virtual]
 

Sets orientation of predictor based on parameter change from previous steps.

The implementation here looks at the sign of the scaled dot product between the secant vector and the predictor and changes the sign of the predictor if this scaled dot product is a different sign than the step size. If baseOnSecant is false, then the sign is chosen so the parameter component of the predictor is positive for cases when a secant vector is not available (first step in a continuation run) or may give incorrect information (last step of a continuation run).

void LOCA::Predictor::Generic::setPredictorOrientation bool  baseOnSecant,
double  stepSize,
LOCA::Continuation::ExtendedGroup prevGroup,
LOCA::Continuation::ExtendedGroup curGroup,
LOCA::Continuation::ExtendedVector result
[protected, virtual]
 

Sets orientation of predictor based on parameter change from previous steps.

The implementation here looks at the sign of the scaled dot product between the secant vector and the predictor and changes the sign of the predictor if this scaled dot product is a different sign than the step size. If baseOnSecant is false, then the sign is chosen so the parameter component of the predictor is positive for cases when a secant vector is not available (first step in a continuation run) or may give incorrect information (last step of a continuation run).


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