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, bool is_symmetric, const NOX::Abstract::Vector &a, const NOX::Abstract::Vector *b, 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 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 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::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 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
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.
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.

Private Member Functions

Constraintoperator= (const Constraint &source)
 Prohibit generation and use of operator=().


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:

Definition at line 132 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.H.


Constructor & Destructor Documentation

LOCA::TurningPoint::MinimallyAugmented::Constraint::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,
bool  is_symmetric,
const NOX::Abstract::Vector a,
const NOX::Abstract::Vector b,
int  bif_param 
)

LOCA::TurningPoint::MinimallyAugmented::Constraint::Constraint ( const Constraint source,
NOX::CopyType  type = NOX::DeepCopy 
)

LOCA::TurningPoint::MinimallyAugmented::Constraint::~Constraint (  )  [virtual]


Member Function Documentation

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.

Definition at line 151 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.C.

References grpPtr.

Teuchos::RCP< const NOX::Abstract::Vector > LOCA::TurningPoint::MinimallyAugmented::Constraint::getLeftNullVec (  )  const [virtual]

Returns left null vector w.

Definition at line 158 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.C.

References w_vector.

Teuchos::RCP< const NOX::Abstract::Vector > LOCA::TurningPoint::MinimallyAugmented::Constraint::getRightNullVec (  )  const [virtual]

Returns right null vector v.

Definition at line 165 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.C.

References v_vector.

double LOCA::TurningPoint::MinimallyAugmented::Constraint::getSigma (  )  const [virtual]

Returns sigma.

Definition at line 172 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.C.

References constraints.

void LOCA::TurningPoint::MinimallyAugmented::Constraint::copy ( const LOCA::MultiContinuation::ConstraintInterface source  )  [virtual]

Teuchos::RCP< LOCA::MultiContinuation::ConstraintInterface > LOCA::TurningPoint::MinimallyAugmented::Constraint::clone ( NOX::CopyType  type = NOX::DeepCopy  )  const [virtual]

int LOCA::TurningPoint::MinimallyAugmented::Constraint::numConstraints (  )  const [virtual]

void LOCA::TurningPoint::MinimallyAugmented::Constraint::setX ( const NOX::Abstract::Vector y  )  [virtual]

Set the solution vector to y.

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 233 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.C.

References grpPtr, isValidConstraints, and isValidDX.

void LOCA::TurningPoint::MinimallyAugmented::Constraint::setParam ( int  paramID,
double  val 
) [virtual]

Sets parameter indexed by paramID.

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 242 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.C.

References grpPtr, isValidConstraints, and isValidDX.

void LOCA::TurningPoint::MinimallyAugmented::Constraint::setParams ( const vector< int > &  paramIDs,
const NOX::Abstract::MultiVector::DenseMatrix vals 
) [virtual]

Sets parameters indexed by paramIDs.

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 251 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.C.

References grpPtr, isValidConstraints, and isValidDX.

NOX::Abstract::Group::ReturnType LOCA::TurningPoint::MinimallyAugmented::Constraint::computeConstraints (  )  [virtual]

NOX::Abstract::Group::ReturnType LOCA::TurningPoint::MinimallyAugmented::Constraint::computeDX (  )  [virtual]

NOX::Abstract::Group::ReturnType LOCA::TurningPoint::MinimallyAugmented::Constraint::computeDP ( const 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.

Definition at line 418 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.C.

References computeConstraints(), constraints, globalData, grpPtr, isValidConstraints, NOX::Abstract::Group::Ok, sigma_scale, v_vector, and w_vector.

bool LOCA::TurningPoint::MinimallyAugmented::Constraint::isConstraints (  )  const [virtual]

Return true if constraint residuals are valid.

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 453 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.C.

References isValidConstraints.

bool LOCA::TurningPoint::MinimallyAugmented::Constraint::isDX (  )  const [virtual]

Return true if derivatives of constraints w.r.t. x are valid.

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 460 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.C.

References isValidDX.

const NOX::Abstract::MultiVector::DenseMatrix & LOCA::TurningPoint::MinimallyAugmented::Constraint::getConstraints (  )  const [virtual]

Return constraint residuals.

Implements LOCA::MultiContinuation::ConstraintInterface.

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

Definition at line 467 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.C.

References constraints.

const NOX::Abstract::MultiVector * LOCA::TurningPoint::MinimallyAugmented::Constraint::getDX (  )  const [virtual]

Return solution component of constraint derivatives.

Implements LOCA::MultiContinuation::ConstraintInterfaceMVDX.

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

Definition at line 474 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.C.

References sigma_x.

bool LOCA::TurningPoint::MinimallyAugmented::Constraint::isDXZero (  )  const [virtual]

Return true if solution component of constraint derivatives is zero.

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 481 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.C.

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.

Definition at line 488 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.C.

References a_vector, b_vector, dn, globalData, NOX::Utils::StepperDetails, LOCA::Abstract::Iterator::Successful, updateVectorsEveryContinuationStep, v_vector, and w_vector.

Constraint& LOCA::TurningPoint::MinimallyAugmented::Constraint::operator= ( const Constraint source  )  [private]

Prohibit generation and use of operator=().


Member Data Documentation

Teuchos::RCP<Teuchos::ParameterList> LOCA::TurningPoint::MinimallyAugmented::Constraint::turningPointParams [protected]

Bifurcation parameter list.

Definition at line 268 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.H.

Referenced by Constraint(), and copy().

Stores sigma_x.

Definition at line 289 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.H.

Referenced by computeDX(), copy(), and getDX().

Stores the bifurcation parameter index.

Definition at line 315 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.H.

Referenced by LOCA::TurningPoint::MinimallyAugmented::ModifiedConstraint::computeConstraints(), and copy().

Flag indicating whether to update $a$ and $b$ every continuation step.

Definition at line 321 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.H.

Referenced by Constraint(), copy(), and postProcessContinuationStep().

Flag indicating whether to update $a$ and $b$ every nonlinear iteration.

Definition at line 327 of file LOCA_TurningPoint_MinimallyAugmented_Constraint.H.

Referenced by LOCA::TurningPoint::MinimallyAugmented::ModifiedConstraint::computeConstraints(), computeConstraints(), Constraint(), and copy().


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

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