NOX Development
Public Member Functions | Protected Attributes
LOCA::MultiPredictor::Tangent Class Reference

Tangent predictor strategy More...

#include <LOCA_MultiPredictor_Tangent.H>

Inheritance diagram for LOCA::MultiPredictor::Tangent:
Inheritance graph
Collaboration diagram for LOCA::MultiPredictor::Tangent:
Collaboration graph

List of all members.

Public Member Functions

 Tangent (const Teuchos::RCP< LOCA::GlobalData > &global_data, const Teuchos::RCP< Teuchos::ParameterList > &predParams, const Teuchos::RCP< Teuchos::ParameterList > &solverParams)
virtual ~Tangent ()
 Tangent (const Tangent &source, NOX::CopyType type=NOX::DeepCopy)
 Copy constructor.
operator= (const LOCA::MultiPredictor::AbstractStrategy &source)
 Assignment operator.
virtual Teuchos::RCP
< LOCA::MultiPredictor::AbstractStrategy
clone (NOX::CopyType type=NOX::DeepCopy) const
 Clone function.
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).
evaluate (const std::vector< double > &stepSize, const LOCA::MultiContinuation::ExtendedVector &xVec, LOCA::MultiContinuation::ExtendedMultiVector &result) const
 Evaluate predictor with step size stepSize.
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::ParameterList
 Stores linear solver parameters.
< NOX::Abstract::MultiVector
 Stores derivative of residual w.r.t. parameters.
< LOCA::MultiContinuation::ExtendedMultiVector
 Stores tangent vector.
< LOCA::MultiContinuation::ExtendedVector
 Stores secant vector for setting orientation.
bool initialized
 Flag indicating whether vectors have been initialized.

Detailed Description

Tangent predictor strategy

This class implements a predictor strategy based on computing the tangent to the continuation curve. If $p$ is the vector of continuation parameters, then the solution component of the tangent vectors $v_x$ are computed by solving

\[ J v_x = - \frac{\partial f}{\partial p}. \]

The parameter component $v_p$ is set to the identity matrix.

Constructor & Destructor Documentation

LOCA::MultiPredictor::Tangent::Tangent ( const Teuchos::RCP< LOCA::GlobalData > &  global_data,
const Teuchos::RCP< Teuchos::ParameterList > &  predParams,
const Teuchos::RCP< Teuchos::ParameterList > &  solverParams 


global_data[in] Global data object
predParams[in] Predictor parameters. Currently no parameters are used by the Tangent predictor.
solverParams[in] Linear solver parameters used in linear solve to compute tangent vectors $v$.

Member Function Documentation

NOX::Abstract::Group::ReturnType LOCA::MultiPredictor::Tangent::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 solve described above

Implements LOCA::MultiPredictor::AbstractStrategy.

References LOCA::MultiContinuation::ExtendedVector::clone(), LOCA::Extended::Vector::createMultiVector(), LOCA::MultiContinuation::ExtendedGroup::getContinuationParameterIDs(), LOCA::MultiContinuation::ExtendedGroup::getUnderlyingGroup(), NOX::ShapeCopy, and NOX::Utils::StepperDetails.

NOX::Abstract::Group::ReturnType LOCA::MultiPredictor::Tangent::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.

bool LOCA::MultiPredictor::Tangent::isTangentScalable ( ) const [virtual]

Is the tangent vector for this predictor scalable.

For the tangent predictor, this always returns true.

Implements LOCA::MultiPredictor::AbstractStrategy.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends