LOCA::MultiContinuation::ExtendedGroup Class Reference

Base class for all continuation groups. More...

#include <LOCA_MultiContinuation_ExtendedGroup.H>

Inheritance diagram for LOCA::MultiContinuation::ExtendedGroup:
Inheritance graph
[legend]
Collaboration diagram for LOCA::MultiContinuation::ExtendedGroup:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ExtendedGroup (const ExtendedGroup &source, NOX::CopyType type=NOX::DeepCopy)
 Copy constructor.
virtual ~ExtendedGroup ()
 Destructor.
Implementation of NOX::Abstract::Group virtual methods

virtual NOX::Abstract::Groupoperator= (const NOX::Abstract::Group &source)
 Assignment operator.
virtual Teuchos::RCP
< NOX::Abstract::Group
clone (NOX::CopyType type=NOX::DeepCopy) const
 Cloning function.
virtual void setX (const NOX::Abstract::Vector &y)
 Set the solution vector to y.
virtual void computeX (const NOX::Abstract::Group &g, const NOX::Abstract::Vector &d, double step)
 Compute and return solution vector, x, where this.x = grp.x + step * d.
virtual
NOX::Abstract::Group::ReturnType 
computeF ()
 Compute extended continuation equations.
virtual
NOX::Abstract::Group::ReturnType 
computeJacobian ()
 Compute extended continuation jacobian.
virtual
NOX::Abstract::Group::ReturnType 
computeGradient ()
 Gradient is not defined for this system.
virtual
NOX::Abstract::Group::ReturnType 
computeNewton (Teuchos::ParameterList &params)
 Compute Newton direction for extended continuation system.
virtual
NOX::Abstract::Group::ReturnType 
applyJacobian (const NOX::Abstract::Vector &input, NOX::Abstract::Vector &result) const
 Applies Jacobian for extended system.
virtual
NOX::Abstract::Group::ReturnType 
applyJacobianTranspose (const NOX::Abstract::Vector &input, NOX::Abstract::Vector &result) const
 Jacobian transpose not defined for this system.
virtual
NOX::Abstract::Group::ReturnType 
applyJacobianInverse (Teuchos::ParameterList &params, const NOX::Abstract::Vector &input, NOX::Abstract::Vector &result) const
 Applies Jacobian inverse for extended system.
virtual
NOX::Abstract::Group::ReturnType 
applyJacobianMultiVector (const NOX::Abstract::MultiVector &input, NOX::Abstract::MultiVector &result) const
 Applies Jacobian for extended system.
virtual
NOX::Abstract::Group::ReturnType 
applyJacobianTransposeMultiVector (const NOX::Abstract::MultiVector &input, NOX::Abstract::MultiVector &result) const
 Jacobian transpose not defined for this system.
virtual
NOX::Abstract::Group::ReturnType 
applyJacobianInverseMultiVector (Teuchos::ParameterList &params, const NOX::Abstract::MultiVector &input, NOX::Abstract::MultiVector &result) const
 Applies Jacobian inverse for extended system.
virtual bool isF () const
 Return true if extended residual is valid.
virtual bool isJacobian () const
 Return true if the extended Jacobian is valid.
virtual bool isGradient () const
 Always returns false.
virtual bool isNewton () const
 Return true if the extended Newton direction is valid.
virtual const
NOX::Abstract::Vector
getX () const
 Return extended solution vector.
virtual const
NOX::Abstract::Vector
getF () const
 Return extended residual.
virtual double getNormF () const
 Return 2-norm of extended residual.
virtual const
NOX::Abstract::Vector
getGradient () const
 Gradient is never valid.
virtual const
NOX::Abstract::Vector
getNewton () const
 Return extended Newton direction.
virtual double getNormNewtonSolveResidual () const
 Returns 2-norm of extended Newton solve residual.
Implementation of LOCA::Extended::MultiAbstractGroup

virtual methods

virtual Teuchos::RCP< const
LOCA::MultiContinuation::AbstractGroup
getUnderlyingGroup () const
 Return underlying group.
virtual Teuchos::RCP
< LOCA::MultiContinuation::AbstractGroup
getUnderlyingGroup ()
 Return underlying group.
Implementation of LOCA::MultiContinuation::AbstractStrategy

virtual methods

virtual void copy (const NOX::Abstract::Group &source)
 Assignment operator.
virtual int getNumParams () const
 Returns number of parameters.
virtual void preProcessContinuationStep (LOCA::Abstract::Iterator::StepStatus stepStatus)
 Perform any preprocessing before a continuation step starts.
virtual void postProcessContinuationStep (LOCA::Abstract::Iterator::StepStatus stepStatus)
 Perform any postprocessing after a continuation step finishes.
virtual
NOX::Abstract::Group::ReturnType 
computePredictor ()
 Compute predictor directions.
virtual bool isPredictor () const
 Is Predictor valid.
virtual void scaleTangent ()
 Scales tangent to predictor.
virtual void setPredictorTangentDirection (const LOCA::MultiContinuation::ExtendedVector &v, int i)
 Sets tangent to predictor.
virtual const
LOCA::MultiContinuation::ExtendedMultiVector
getPredictorTangent () const
 Returns tangent to predictor.
virtual const
LOCA::MultiContinuation::ExtendedMultiVector
getScaledPredictorTangent () const
 Returns scaled tangent to predictor.
virtual void setPrevX (const NOX::Abstract::Vector &y)
 Set the previous solution vector y.
virtual const
LOCA::MultiContinuation::ExtendedVector
getPrevX () const
 Gets the previous solution vector.
virtual void setStepSize (double deltaS, int i=0)
 Set step size for continuation constraint equation i.
virtual double getStepSize (int i=0) const
 Get step size for continuation constraint equation i.
virtual void setContinuationParameter (double val, int i=0)
 Sets the value for continuation parameter i.
virtual double getContinuationParameter (int i=0) const
 Returns the value for continuation parameter i.
virtual int getContinuationParameterID (int i=0) const
 Get the continuation parameter id for parameter i.
virtual const vector< int > & getContinuationParameterIDs () const
 Get the continuation parameter ids.
virtual string getContinuationParameterName (int i=0) const
 Get the continuation parameter id for parameter i.
virtual double getStepSizeScaleFactor (int i=0) const
 Returns step size scale factor for constraint equation i.
virtual void printSolution () const
 Prints the group.
virtual double computeScaledDotProduct (const NOX::Abstract::Vector &x, const NOX::Abstract::Vector &y) const
 Computes a scaled dot product between two continuation vectors.
virtual int projectToDrawDimension () const
 Returns dimension of project to draw array.
virtual void projectToDraw (const LOCA::MultiContinuation::ExtendedVector &x, double *px) const
 Fills the project to draw array.
Implementation of
virtual int getBorderedWidth () const
 Return the total width of the bordered rows/columns.
virtual Teuchos::RCP< const
NOX::Abstract::Group
getUnborderedGroup () const
 Get bottom-level unbordered group.
virtual bool isCombinedAZero () const
 Indicates whether combined A block is zero.
virtual bool isCombinedBZero () const
 Indicates whether combined B block is zero.
virtual bool isCombinedCZero () const
 Indicates whether combined C block is zero.
virtual void extractSolutionComponent (const NOX::Abstract::MultiVector &v, NOX::Abstract::MultiVector &v_x) const
virtual void extractParameterComponent (bool use_transpose, const NOX::Abstract::MultiVector &v, NOX::Abstract::MultiVector::DenseMatrix &v_p) const
virtual void loadNestedComponents (const NOX::Abstract::MultiVector &v_x, const NOX::Abstract::MultiVector::DenseMatrix &v_p, NOX::Abstract::MultiVector &v) const
virtual void fillA (NOX::Abstract::MultiVector &A) const
 Fill the combined A block as described above.
virtual void fillB (NOX::Abstract::MultiVector &B) const
 Fill the combined B block as described above.
virtual void fillC (NOX::Abstract::MultiVector::DenseMatrix &C) const
 Fill the combined C block as described above.

Protected Member Functions

 ExtendedGroup (const Teuchos::RCP< LOCA::GlobalData > &global_data, const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &continuationParams, const Teuchos::RCP< LOCA::MultiContinuation::AbstractGroup > &grp, const Teuchos::RCP< LOCA::MultiPredictor::AbstractStrategy > &pred, const vector< int > &paramIDs)
 Constructor used by derived classes.
virtual void setConstraints (const Teuchos::RCP< LOCA::MultiContinuation::ConstraintInterface > &constraints, bool skip_dfdp)
 Set constraint object.

Protected Attributes

Teuchos::RCP< LOCA::GlobalDataglobalData
 Pointer LOCA global data object.
Teuchos::RCP
< LOCA::Parameter::SublistParser
parsedParams
 Parsed top-level parameters.
Teuchos::RCP
< Teuchos::ParameterList
continuationParams
 Continuation parameter list.
Teuchos::RCP
< LOCA::MultiContinuation::AbstractGroup
grpPtr
 Pointer to underlying group.
Teuchos::RCP
< LOCA::MultiPredictor::AbstractStrategy
predictor
 Pointer to predictor object.
Teuchos::RCP
< LOCA::MultiContinuation::ConstrainedGroup
conGroup
 Pointer to constrained group implementation.
int numParams
 Number of parameters.
LOCA::MultiContinuation::ExtendedMultiVector tangentMultiVec
 Stores the tangent to the predictor.
LOCA::MultiContinuation::ExtendedMultiVector scaledTangentMultiVec
 Stores the scaled tangent to the predictor.
LOCA::MultiContinuation::ExtendedVector prevXVec
 Stores the previous extended solution vector.
vector< int > conParamIDs
 integer id of continuation parameters
vector< double > stepSize
 continuation step size
vector< double > stepSizeScaleFactor
 step size scale factors
bool isValidPredictor
 Is Predictor vector valid.
bool baseOnSecant
 Flag indicating whether to base predictor direction on secant.

Detailed Description

Base class for all continuation groups.

Continuation is defined as computing some curve $(x(s),p(s))\in\Re^{n+1}$ such that $F(x(s),p(s))=0$ for some parameterization $s$. Given some point $(x_0,p_0)$ on the curve, another nearby point on the curve is calculated by first computing a predictor direction $v\in\Re^{n+1}$ and the approximate point $(x^\ast,p^\ast) = (x_0,p_0) + v\Delta s$ where $\Delta s$ is the step size. Then the next point on the curve is computed by solving the extended set of equations

\[ \begin{array}{cc} F(x,p) &= 0 \\ g(x,p,x_0,p_0,x^\ast,p^\ast,v,\Delta s) &= 0 \end{array} \]

for $(x,p)$. The equation $g(x,p,x_0,p_0,x^\ast,p^\ast,v,\Delta s)=0$ is called the continuation equation and different choices of $g$ yield different continuation methods.

Mathematically, this computation amounts to repeatedly computing solutions to a constrained nonlinear system. This class provides a common implementation for all continuation groups in terms of the LOCA::MultiContinuation::ConstrainedGroup using a supplied group to represent $F$ and an implementation of LOCA::MultiContinuation::ConstraintInterface to represent $g$.

Note that this class has no public constructor other than the copy constructor since it is intended to only provide an implemenation of much of the continuation work. Each derived class that implements a specific continuation strategy should provide its own public constructor.


Member Function Documentation

void LOCA::MultiContinuation::ExtendedGroup::extractParameterComponent ( bool  use_transpose,
const NOX::Abstract::MultiVector v,
NOX::Abstract::MultiVector::DenseMatrix v_p 
) const [virtual]

Given the vector v, extract the parameter components of all of the nested subvectors in v down to the solution component for the unbordered group.

Implements LOCA::BorderedSystem::AbstractGroup.

References conGroup.

void LOCA::MultiContinuation::ExtendedGroup::extractSolutionComponent ( const NOX::Abstract::MultiVector v,
NOX::Abstract::MultiVector v_x 
) const [virtual]

Given the vector v, extract the underlying solution component corresponding to the unbordered group.

Implements LOCA::BorderedSystem::AbstractGroup.

References conGroup.

void LOCA::MultiContinuation::ExtendedGroup::loadNestedComponents ( const NOX::Abstract::MultiVector v_x,
const NOX::Abstract::MultiVector::DenseMatrix v_p,
NOX::Abstract::MultiVector v 
) const [virtual]

Given the solution component v_x and combined parameter components v_p, distribute these components through the nested sub-vectors in v.

Implements LOCA::BorderedSystem::AbstractGroup.

References conGroup.

void LOCA::MultiContinuation::ExtendedGroup::postProcessContinuationStep ( LOCA::Abstract::Iterator::StepStatus  stepStatus  )  [virtual]

Perform any postprocessing after a continuation step finishes.

The stepStatus argument indicates whether the step was successful.

Implements LOCA::MultiContinuation::AbstractStrategy.

References baseOnSecant, conGroup, isValidPredictor, and LOCA::Abstract::Iterator::Successful.

void LOCA::MultiContinuation::ExtendedGroup::preProcessContinuationStep ( LOCA::Abstract::Iterator::StepStatus  stepStatus  )  [virtual]

Perform any preprocessing before a continuation step starts.

The stepStatus argument indicates whether the previous step was successful.

Implements LOCA::MultiContinuation::AbstractStrategy.

References conGroup.

void LOCA::MultiContinuation::ExtendedGroup::setConstraints ( const Teuchos::RCP< LOCA::MultiContinuation::ConstraintInterface > &  constraints,
bool  skip_dfdp 
) [protected, virtual]

Set constraint object.

This allows the constraint object to be set after the group is constructed using the above constructor.

References conGroup, conParamIDs, continuationParams, globalData, grpPtr, parsedParams, and Teuchos::rcp().

Referenced by LOCA::MultiContinuation::ArcLengthGroup::ArcLengthGroup(), and LOCA::MultiContinuation::NaturalGroup::NaturalGroup().

void LOCA::MultiContinuation::ExtendedGroup::setPredictorTangentDirection ( const LOCA::MultiContinuation::ExtendedVector v,
int  i 
) [virtual]

Sets tangent to predictor.

This is required by MF which takes the tangent space, orthogonalizes it, and then sets it back in the group.

Implements LOCA::MultiContinuation::AbstractStrategy.

References tangentMultiVec.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Generated on Wed Apr 13 09:59:43 2011 for NOX by  doxygen 1.6.3