NOX Development
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
LOCA::MultiPredictor::Restart Class Reference

Restart predictor strategy More...

#include <LOCA_MultiPredictor_Restart.H>

Inheritance diagram for LOCA::MultiPredictor::Restart:
Inheritance graph
[legend]
Collaboration diagram for LOCA::MultiPredictor::Restart:
Collaboration graph
[legend]

Public Member Functions

 Restart (const Teuchos::RCP< LOCA::GlobalData > &global_data, const Teuchos::RCP< Teuchos::ParameterList > &predParams)
 Constructor.
 
virtual ~Restart ()
 Destructor.
 
 Restart (const Restart &source, NOX::CopyType type=NOX::DeepCopy)
 Copy constructor.
 
virtual LOCA::MultiPredictor::AbstractStrategyoperator= (const LOCA::MultiPredictor::AbstractStrategy &source)
 Assignment operator.
 
virtual Teuchos::RCP< LOCA::MultiPredictor::AbstractStrategyclone (NOX::CopyType type=NOX::DeepCopy) const
 Clone function.
 
virtual NOX::Abstract::Group::ReturnType compute (bool baseOnSecant, const std::vector< double > &stepSize, LOCA::MultiContinuation::ExtendedGroup &grp, const LOCA::MultiContinuation::ExtendedVector &prevXVec, const LOCA::MultiContinuation::ExtendedVector &xVec)
 Compute the predictor given the current and previous solution vectors. 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 evaluate (const std::vector< double > &stepSize, const LOCA::MultiContinuation::ExtendedVector &xVec, LOCA::MultiContinuation::ExtendedMultiVector &result) const
 Evaluate predictor with step size stepSize.
 
virtual NOX::Abstract::Group::ReturnType computeTangent (LOCA::MultiContinuation::ExtendedMultiVector &tangent)
 Compute tangent to predictor and store in tangent.
 
virtual bool isTangentScalable () const
 Is the tangent vector for this predictor scalable.
 
- Public Member Functions inherited from LOCA::MultiPredictor::AbstractStrategy
 AbstractStrategy ()
 Constructor.
 
virtual ~AbstractStrategy ()
 Destructor.
 
virtual LOCA::MultiPredictor::AbstractStrategyoperator= (const LOCA::MultiPredictor::AbstractStrategy &source)=0
 Assignment operator.
 
virtual Teuchos::RCP< LOCA::MultiPredictor::AbstractStrategyclone (NOX::CopyType type=NOX::DeepCopy) const =0
 Clone function.
 
virtual NOX::Abstract::Group::ReturnType compute (bool baseOnSecant, const std::vector< double > &stepSize, LOCA::MultiContinuation::ExtendedGroup &grp, const LOCA::MultiContinuation::ExtendedVector &prevXVec, const LOCA::MultiContinuation::ExtendedVector &xVec)=0
 Compute the predictor given the current and previous solution vectors. 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 evaluate (const std::vector< double > &stepSize, const LOCA::MultiContinuation::ExtendedVector &xVec, LOCA::MultiContinuation::ExtendedMultiVector &result) const =0
 Evaluate predictor with step size stepSize.
 
virtual NOX::Abstract::Group::ReturnType computeTangent (LOCA::MultiContinuation::ExtendedMultiVector &tangent)=0
 Compute tangent to predictor and store in tangent.
 
virtual bool isTangentScalable () const =0
 Is the tangent vector for this predictor scalable.
 

Protected Attributes

Teuchos::RCP< LOCA::GlobalDataglobalData
 LOCA global data object.
 
Teuchos::RCP< LOCA::MultiContinuation::ExtendedMultiVectorpredictor
 Stores predictor vector.
 

Additional Inherited Members

- Protected Member Functions inherited from LOCA::MultiPredictor::AbstractStrategy
virtual void setPredictorOrientation (bool baseOnSecant, const std::vector< double > &stepSize, const LOCA::MultiContinuation::ExtendedGroup &grp, const LOCA::MultiContinuation::ExtendedVector &prevXVec, const LOCA::MultiContinuation::ExtendedVector &xVec, LOCA::MultiContinuation::ExtendedVector &secant, LOCA::MultiContinuation::ExtendedMultiVector &tangent)
 Sets orientation of predictor based on parameter change from previous steps.
 

Detailed Description

Restart predictor strategy

This class implements a predictor that is restarted from a previous computation. In other words, this class takes a predictor vector that would be computed previously and uses it as the predictor.

The parameters used by this class supplied in the constructor are:

Constructor & Destructor Documentation

◆ Restart()

LOCA::MultiPredictor::Restart::Restart ( const Teuchos::RCP< LOCA::GlobalData > &  global_data,
const Teuchos::RCP< Teuchos::ParameterList > &  predParams 
)

Constructor.

Parameters
global_data[in] Global data object
predParams[in] Predictor parameters as described above.

References NOX::DeepCopy, globalData, and predictor.

Member Function Documentation

◆ clone()

Teuchos::RCP< LOCA::MultiPredictor::AbstractStrategy > LOCA::MultiPredictor::Restart::clone ( NOX::CopyType  type = NOX::DeepCopy) const
virtual

Clone function.

Implements LOCA::MultiPredictor::AbstractStrategy.

◆ compute()

NOX::Abstract::Group::ReturnType LOCA::MultiPredictor::Restart::compute ( bool  baseOnSecant,
const std::vector< double > &  stepSize,
LOCA::MultiContinuation::ExtendedGroup grp,
const LOCA::MultiContinuation::ExtendedVector prevXVec,
const LOCA::MultiContinuation::ExtendedVector xVec 
)
virtual

Compute the predictor given the current and previous solution vectors. Set baseOnSecant to false if the predictor orientation should not be based on the secant vector (first or last steps of a continuation run).

This method actually implements the predictor computation described above

Implements LOCA::MultiPredictor::AbstractStrategy.

References NOX::Abstract::Group::Ok, and NOX::Utils::StepperDetails.

◆ computeTangent()

NOX::Abstract::Group::ReturnType LOCA::MultiPredictor::Restart::computeTangent ( LOCA::MultiContinuation::ExtendedMultiVector tangent)
virtual

Compute tangent to predictor and store in tangent.

Implements LOCA::MultiPredictor::AbstractStrategy.

References NOX::Abstract::Group::Ok.

◆ evaluate()

NOX::Abstract::Group::ReturnType LOCA::MultiPredictor::Restart::evaluate ( const std::vector< double > &  stepSize,
const LOCA::MultiContinuation::ExtendedVector xVec,
LOCA::MultiContinuation::ExtendedMultiVector result 
) const
virtual

Evaluate predictor with step size stepSize.

This method computes result[i] = xVec[i] + stepSize[i] * v[i] for each i, where v[i] is the ith predictor direction.

Implements LOCA::MultiPredictor::AbstractStrategy.

References NOX::Abstract::Group::Ok.

◆ isTangentScalable()

bool LOCA::MultiPredictor::Restart::isTangentScalable ( ) const
virtual

Is the tangent vector for this predictor scalable.

For the restart predictor, this always returns false.

Implements LOCA::MultiPredictor::AbstractStrategy.

◆ operator=()

LOCA::MultiPredictor::AbstractStrategy & LOCA::MultiPredictor::Restart::operator= ( const LOCA::MultiPredictor::AbstractStrategy source)
virtual

Assignment operator.

Implements LOCA::MultiPredictor::AbstractStrategy.

References globalData, and predictor.


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