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]

List of all members.

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::AbstractStrategy
operator= (const LOCA::MultiPredictor::AbstractStrategy &source)
 Assignment operator.
virtual Teuchos::RCP
< 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::RCP< LOCA::GlobalDataglobalData
 LOCA global data object.
Teuchos::RCP
< 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:

Definition at line 69 of file LOCA_MultiPredictor_Restart.H.


Constructor & Destructor Documentation

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.

Definition at line 50 of file LOCA_MultiPredictor_Restart.C.

References NOX::DeepCopy, globalData, and predictor.

Referenced by clone().

LOCA::MultiPredictor::Restart::~Restart (  )  [virtual]

Destructor.

Definition at line 82 of file LOCA_MultiPredictor_Restart.C.

LOCA::MultiPredictor::Restart::Restart ( const Restart source,
NOX::CopyType  type = NOX::DeepCopy 
)

Copy constructor.

Definition at line 86 of file LOCA_MultiPredictor_Restart.C.


Member Function Documentation

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

Assignment operator.

Implements LOCA::MultiPredictor::AbstractStrategy.

Definition at line 95 of file LOCA_MultiPredictor_Restart.C.

References globalData, and predictor.

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

Clone function.

Implements LOCA::MultiPredictor::AbstractStrategy.

Definition at line 110 of file LOCA_MultiPredictor_Restart.C.

References Restart().

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.

Definition at line 116 of file LOCA_MultiPredictor_Restart.C.

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

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.

Definition at line 130 of file LOCA_MultiPredictor_Restart.C.

References NOX::Abstract::Group::Ok, and predictor.

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.

Definition at line 145 of file LOCA_MultiPredictor_Restart.C.

References NOX::Abstract::Group::Ok, and predictor.

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.

Definition at line 154 of file LOCA_MultiPredictor_Restart.C.


Member Data Documentation

LOCA global data object.

Definition at line 135 of file LOCA_MultiPredictor_Restart.H.

Referenced by compute(), operator=(), and Restart().

Stores predictor vector.

Definition at line 138 of file LOCA_MultiPredictor_Restart.H.

Referenced by computeTangent(), evaluate(), operator=(), and Restart().


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

Generated on Wed Oct 21 14:28:39 2009 for Nonlinear Solver Project by  doxygen 1.5.9