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:

Collaboration diagram for LOCA::TurningPoint::MinimallyAugmented::Constraint:
List of all members.

Public Member Functions

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

virtual void copy (const LOCA::MultiContinuation::ConstraintInterface &source)
virtual Teuchos::RefCountPtr<
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 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 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::DenseMatrixgetConstraints () const
 Return constraint residuals.
virtual const NOX::Abstract::MultiVectorgetDX () 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 Attributes

Teuchos::RefCountPtr< LOCA::GlobalDataglobalData
 Pointer LOCA global data object.
Teuchos::RefCountPtr< LOCA::Parameter::SublistParserparsedParams
 Parsed top-level parameters.
Teuchos::RefCountPtr< Teuchos::ParameterListturningPointParams
 Bifurcation parameter list.
Teuchos::RefCountPtr< LOCA::TurningPoint::MinimallyAugmented::AbstractGroupgrpPtr
 Pointer to base group that defines $F$.
Teuchos::RefCountPtr< NOX::Abstract::MultiVectora_vector
 Vector for $a$.
Teuchos::RefCountPtr< NOX::Abstract::MultiVectorb_vector
 Vector for $b$.
Teuchos::RefCountPtr< NOX::Abstract::MultiVectorw_vector
 Stores left null vector.
Teuchos::RefCountPtr< NOX::Abstract::MultiVectorv_vector
 Stores right null vector.
Teuchos::RefCountPtr< NOX::Abstract::MultiVectorJv_vector
 Stores J*v.
Teuchos::RefCountPtr< NOX::Abstract::MultiVectorsigma_x
 Stores sigma_x.
NOX::Abstract::MultiVector::DenseMatrix constraints
 Constraint values.
Teuchos::RefCountPtr< LOCA::BorderedSolver::AbstractStrategyborderedSolver
 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.
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.

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 Function Documentation

NOX::Abstract::Group::ReturnType LOCA::TurningPoint::MinimallyAugmented::Constraint::computeDP const vector< int > &  paramIDs,
NOX::Abstract::MultiVector::DenseMatrix dgdp,
bool  isValidG

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.

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.

void LOCA::TurningPoint::MinimallyAugmented::Constraint::setGroup const Teuchos::RefCountPtr< 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.

The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:38:36 2008 for NOX by doxygen