NOX Development
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
LOCA::TurningPoint::MinimallyAugmented::Constraint Class Reference

Implementation of LOCA::MultiContinuation::ConstraintInterfaceMVDX for computing turning points for the minimally augmented turning point formulation. More...

#include <LOCA_TurningPoint_MinimallyAugmented_Constraint.H>

Inheritance diagram for LOCA::TurningPoint::MinimallyAugmented::Constraint:
Inheritance graph
[legend]
Collaboration diagram for LOCA::TurningPoint::MinimallyAugmented::Constraint:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 Constraint (const Teuchos::RCP< LOCA::GlobalData > &global_data, const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &tpParams, const Teuchos::RCP< LOCA::TurningPoint::MinimallyAugmented::AbstractGroup > &g, int bif_param)
 Constructor.
 Constraint (const Constraint &source, NOX::CopyType type=NOX::DeepCopy)
 Copy constructor.
virtual ~Constraint ()
 Destructor.
virtual void setGroup (const Teuchos::RCP< LOCA::TurningPoint::MinimallyAugmented::AbstractGroup > &g)
 Set the group pointer.
virtual Teuchos::RCP< const
NOX::Abstract::Vector
getLeftNullVec () const
 Returns left null vector w.
virtual Teuchos::RCP< const
NOX::Abstract::Vector
getRightNullVec () const
 Returns right null vector v.
virtual Teuchos::RCP< const
NOX::Abstract::Vector
getAVec () const
 Returns a vector.
virtual Teuchos::RCP< const
NOX::Abstract::Vector
getBVec () const
 Returns b vector.
virtual double getSigma () const
 Returns sigma.
Implementation of LOCA::MultiContinuation::ConstraintInterface

virtual methods

virtual void copy (const LOCA::MultiContinuation::ConstraintInterface &source)
 Copy.
virtual Teuchos::RCP
< LOCA::MultiContinuation::ConstraintInterface
clone (NOX::CopyType type=NOX::DeepCopy) const
 Cloning function.
virtual int numConstraints () const
 Return number of constraints.
virtual void setX (const NOX::Abstract::Vector &y)
 Set the solution vector to y.
virtual void setParam (int paramID, double val)
 Sets parameter indexed by paramID.
virtual void setParams (const std::vector< int > &paramIDs, const NOX::Abstract::MultiVector::DenseMatrix &vals)
 Sets parameters indexed by paramIDs.
virtual
NOX::Abstract::Group::ReturnType 
computeConstraints ()
 Compute continuation constraint equations.
virtual
NOX::Abstract::Group::ReturnType 
computeDX ()
 Compute derivative of constraints w.r.t. solution vector x.
virtual
NOX::Abstract::Group::ReturnType 
computeDP (const std::vector< int > &paramIDs, NOX::Abstract::MultiVector::DenseMatrix &dgdp, bool isValidG)
 Compute derivative of constraints w.r.t. supplied parameters.
virtual bool isConstraints () const
 Return true if constraint residuals are valid.
virtual bool isDX () const
 Return true if derivatives of constraints w.r.t. x are valid.
virtual const
NOX::Abstract::MultiVector::DenseMatrix
getConstraints () const
 Return constraint residuals.
virtual const
NOX::Abstract::MultiVector
getDX () const
 Return solution component of constraint derivatives.
virtual bool isDXZero () const
 Return true if solution component of constraint derivatives is zero.
virtual void postProcessContinuationStep (LOCA::Abstract::Iterator::StepStatus stepStatus)
 Perform any postprocessing after a continuation step finishes.

Protected Types

enum  NullVectorScaling { NVS_None, NVS_OrderOne, NVS_OrderN }
 Enumerated type determining type of scaling. More...

Protected Member Functions

virtual void scaleNullVectors (NOX::Abstract::Vector &a, NOX::Abstract::Vector &b)
 Scale a & b vectors.
virtual void getInitialVectors (NOX::Abstract::Vector &a, NOX::Abstract::Vector &b)
 Get initial a & b vectors.

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
turningPointParams
 Bifurcation parameter list.
Teuchos::RCP
< LOCA::TurningPoint::MinimallyAugmented::AbstractGroup
grpPtr
 Pointer to base group that defines $F$.
Teuchos::RCP
< NOX::Abstract::MultiVector
a_vector
 Vector for $a$.
Teuchos::RCP
< NOX::Abstract::MultiVector
b_vector
 Vector for $b$.
Teuchos::RCP
< NOX::Abstract::MultiVector
w_vector
 Stores left null vector.
Teuchos::RCP
< NOX::Abstract::MultiVector
v_vector
 Stores right null vector.
Teuchos::RCP
< NOX::Abstract::MultiVector
Jv_vector
 Stores J*v.
Teuchos::RCP
< NOX::Abstract::MultiVector
Jtw_vector
 Stores J^T*w.
Teuchos::RCP
< NOX::Abstract::MultiVector
sigma_x
 Stores sigma_x.
NOX::Abstract::MultiVector::DenseMatrix constraints
 Constraint values.
Teuchos::RCP
< LOCA::BorderedSolver::AbstractStrategy
borderedSolver
 Stores bordered solver strategy.
double dn
 Stores vector length as a double.
double sigma_scale
 Stores scale factor on sigma.
bool isSymmetric
 Flag indicating whether Jacobian is symmetric.
bool isValidConstraints
 Flag indicating whether constraints are valid.
bool isValidDX
 Flag indicating whether sigma_x is valid.
std::vector< int > bifParamID
 Stores the bifurcation parameter index.
bool updateVectorsEveryContinuationStep
 Flag indicating whether to update $a$ and $b$ every continuation step.
bool updateVectorsEveryIteration
 Flag indicating whether to update $a$ and $b$ every nonlinear iteration.
NullVectorScaling nullVecScaling
 Null vector scaling method.
bool multiplyMass
 Multiply null vectors by mass matrix.
Teuchos::RCP
< LOCA::TimeDependent::AbstractGroup
tdGrp
 Time dependent group interface for multiplying by mass matrix.
Teuchos::RCP
< NOX::Abstract::Vector
tmp_mass
 Temporary vector for mulplying null vectors by mass matrix.

Detailed Description

Implementation of LOCA::MultiContinuation::ConstraintInterfaceMVDX for computing turning points for the minimally augmented turning point formulation.

This class implements the turning point constraint equation $\sigma(x,p) = 0$ for the minimally augmented turning point formulation where $\sigma$ is defined via

\[ \begin{bmatrix} J & a \\ b^T & 0 \end{bmatrix} \begin{bmatrix} v \\ \sigma_1 \end{bmatrix} = \begin{bmatrix} 0 \\ n \end{bmatrix}, \]

\[ \begin{bmatrix} J^T & b \\ a^T & 0 \end{bmatrix} \begin{bmatrix} w \\ \sigma_2 \end{bmatrix} = \begin{bmatrix} 0 \\ n \end{bmatrix}, \]

\[ \sigma = -w^T J v/n \]

for any vectors $a$ and $b$ in $\Re^n$. Using these relationships, it is easy to show

\[ \begin{split} \sigma_x &= -(w^T J v)_x/n = -w^T J_x v/n \\ \sigma_p &= -(w^T J v)_p/n = -w^T J_p v/n \end{split} \]

The class is intialized via the tpParams parameter list argument to the constructor. The parameters this class recognizes are:


Member Enumeration Documentation

Enumerated type determining type of scaling.

Enumerator:
NVS_OrderOne 

No scaling.

NVS_OrderN 

Scale to O(1)

Scale to O(N) when N is the vector length


Member Function Documentation

NOX::Abstract::Group::ReturnType LOCA::TurningPoint::MinimallyAugmented::Constraint::computeDP ( const std::vector< int > &  paramIDs,
NOX::Abstract::MultiVector::DenseMatrix dgdp,
bool  isValidG 
) [virtual]

Compute derivative of constraints w.r.t. supplied parameters.

The first column of dgdp should be filled with the constraint residuals $g$ if isValidG is false. If isValidG is true, then the dgdp contains $g$ on input.

Implements LOCA::MultiContinuation::ConstraintInterface.

Reimplemented in LOCA::Pitchfork::MinimallyAugmented::Constraint.

References NOX::Abstract::Group::Ok, and Teuchos::SerialDenseMatrix< OrdinalType, ScalarType >::scale().

Referenced by LOCA::Pitchfork::MinimallyAugmented::Constraint::computeDP().

void LOCA::TurningPoint::MinimallyAugmented::Constraint::postProcessContinuationStep ( LOCA::Abstract::Iterator::StepStatus  stepStatus) [virtual]

Perform any postprocessing after a continuation step finishes.

The stepStatus argument indicates whether the step was successful. Here we update the $a$ and $b$ vectors to $w$ and $v$ respectively if requested.

Reimplemented from LOCA::MultiContinuation::ConstraintInterface.

Reimplemented in LOCA::TurningPoint::MinimallyAugmented::ModifiedConstraint.

References NOX::Utils::StepperDetails, and LOCA::Abstract::Iterator::Successful.

Referenced by LOCA::TurningPoint::MinimallyAugmented::ModifiedConstraint::postProcessContinuationStep().

void LOCA::TurningPoint::MinimallyAugmented::Constraint::setGroup ( const Teuchos::RCP< LOCA::TurningPoint::MinimallyAugmented::AbstractGroup > &  g) [virtual]

Set the group pointer.

This method should be called when ever the constrained group is copied, since we don't explicitly copy the underlying group here.

Reimplemented in LOCA::Pitchfork::MinimallyAugmented::Constraint.

Referenced by LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup::copy(), LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup::ExtendedGroup(), and LOCA::Pitchfork::MinimallyAugmented::Constraint::setGroup().


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