LOCA::MultiContinuation::MultiVecConstraint Class Reference

Implementation of LOCA::MultiContinuation::ConstraintInterfaceMVDX for a simple linear multivector constraint. More...

#include <LOCA_MultiContinuation_MultiVecConstraint.H>

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

List of all members.

Public Member Functions

 MultiVecConstraint (const Teuchos::RCP< const NOX::Abstract::MultiVector > &dx)
 Constructor.
 MultiVecConstraint (const MultiVecConstraint &source, NOX::CopyType type=NOX::DeepCopy)
 Copy constructor.
 ~MultiVecConstraint ()
 Destructor.
virtual void setDx (const Teuchos::RCP< const NOX::Abstract::MultiVector > &dx)
 Set constraint vector.
Implementation of LOCA::MultiContinuation::ConstraintInterfaceMVDX

virtual methods

virtual void copy (const 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 notifyCompletedStep ()
 Notify constraint that the continuation step is completed.

Protected Attributes

Teuchos::RCP
< NOX::Abstract::MultiVector
dx
 Constraint vector.
Teuchos::RCP
< NOX::Abstract::MultiVector
x
 Solution vector.
NOX::Abstract::MultiVector::DenseMatrix constraints
 Constraint values.
bool isValidConstraints
 Flag indicating whether constraints are valid.

Detailed Description

Implementation of LOCA::MultiContinuation::ConstraintInterfaceMVDX for a simple linear multivector constraint.


Member Function Documentation

NOX::Abstract::Group::ReturnType LOCA::MultiContinuation::MultiVecConstraint::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.

References computeConstraints(), constraints, isValidConstraints, and Teuchos::SerialDenseMatrix< OrdinalType, ScalarType >::numRows().

void LOCA::MultiContinuation::MultiVecConstraint::notifyCompletedStep (  )  [virtual]

Notify constraint that the continuation step is completed.

Here we do nothing


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