NOX  Development
Public Member Functions | Protected Attributes | List of all members
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]

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::ConstraintInterfaceclone (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. More...
 
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 notifyCompletedStep ()
 Notify constraint that the continuation step is completed. More...
 
- Public Member Functions inherited from LOCA::MultiContinuation::ConstraintInterfaceMVDX
 ConstraintInterfaceMVDX ()
 Constructor.
 
virtual ~ConstraintInterfaceMVDX ()
 Destructor.
 
virtual NOX::Abstract::Group::ReturnType multiplyDX (double alpha, const NOX::Abstract::MultiVector &input_x, NOX::Abstract::MultiVector::DenseMatrix &result_p) const
 Compute result_p = alpha * dg/dx * input_x. More...
 
virtual NOX::Abstract::Group::ReturnType addDX (Teuchos::ETransp transb, double alpha, const NOX::Abstract::MultiVector::DenseMatrix &b, double beta, NOX::Abstract::MultiVector &result_x) const
 Compute result_x = alpha * dg/dx^T * op(b) + beta * result_x. More...
 
- Public Member Functions inherited from LOCA::MultiContinuation::ConstraintInterface
 ConstraintInterface ()
 Constructor.
 
virtual ~ConstraintInterface ()
 Destructor.
 
virtual void preProcessContinuationStep (LOCA::Abstract::Iterator::StepStatus stepStatus)
 Perform any preprocessing before a continuation step starts. More...
 
virtual void postProcessContinuationStep (LOCA::Abstract::Iterator::StepStatus stepStatus)
 Perform any postprocessing after a continuation step finishes. More...
 

Protected Attributes

Teuchos::RCP< NOX::Abstract::MultiVectordx
 Constraint vector.
 
Teuchos::RCP< NOX::Abstract::MultiVectorx
 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

◆ computeDP()

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

References NOX::Abstract::Group::NotDefined.

◆ notifyCompletedStep()

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: