LOCA::MultiPredictor::Restart Class Reference

Restart predictor strategy More...

#include <LOCA_MultiPredictor_Restart.H>

Inheritance diagram for LOCA::MultiPredictor::Restart:

[legend]Collaboration diagram for LOCA::MultiPredictor::Restart:[legend]List of all members.

Public Member Functions
	Restart (const Teuchos::RefCountPtr< LOCA::GlobalData > &global_data, const Teuchos::RefCountPtr< Teuchos::ParameterList > &predParams)
	Constructor.
virtual	~Restart ()
	Destructor.
	Restart (const Restart &source, NOX::CopyType type=NOX::DeepCopy)
	Copy constructor.
virtual LOCA::MultiPredictor::AbstractStrategy &	operator= (const LOCA::MultiPredictor::AbstractStrategy &source)
	Assignment operator.
virtual Teuchos::RefCountPtr< LOCA::MultiPredictor::AbstractStrategy >	clone (NOX::CopyType type=NOX::DeepCopy) const
	Clone function.
virtual NOX::Abstract::Group::ReturnType	compute (bool baseOnSecant, const 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 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.
Protected Attributes
Teuchos::RefCountPtr< LOCA::GlobalData >	globalData
	LOCA global data object.
Teuchos::RefCountPtr< LOCA::MultiContinuation::ExtendedMultiVector >	predictor
	Stores predictor vector.

---

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:

• "Restart Vector" - Teuchos::RefCountPtr to a LOCA::MultiContinuation::ExtendedVector or ExtendedMultiVector storing the predictor direction.

---

Constructor & Destructor Documentation

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

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

---

Member Function Documentation

NOX::Abstract::Group::ReturnType LOCA::MultiPredictor::Restart::compute (  bool  baseOnSecant, const 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.

NOX::Abstract::Group::ReturnType LOCA::MultiPredictor::Restart::evaluate (  const 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.

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.

---

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

• LOCA_MultiPredictor_Restart.H
• LOCA_MultiPredictor_Restart.C

---