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

#include <LOCA_MultiContinuation_MultiVecConstraint.H>

Inheritance diagram for LOCA::MultiContinuation::MultiVecConstraint:

[legend]

Collaboration diagram for LOCA::MultiContinuation::MultiVecConstraint:

[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.

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.

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.

Public Member Functions inherited from LOCA::MultiContinuation::ConstraintInterface
	ConstraintInterface ()
	Constructor.

virtual	~ConstraintInterface ()
	Destructor.

virtual void	preProcessContinuationStep (LOCA::Abstract::Iterator::StepStatus)
	Perform any preprocessing before a continuation step starts.

virtual void	postProcessContinuationStep (LOCA::Abstract::Iterator::StepStatus)
	Perform any postprocessing after a continuation step finishes.

Implementation of LOCA::MultiContinuation::ConstraintInterfaceMVDX
virtual methods
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.

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

Detailed Description

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

Member Function Documentation

◆ clone()

Teuchos::RCP< LOCA::MultiContinuation::ConstraintInterface > LOCA::MultiContinuation::MultiVecConstraint::clone ( NOX::CopyType type = NOX::DeepCopy ) const

virtual

Cloning function.

Implements LOCA::MultiContinuation::ConstraintInterface.

◆ computeConstraints()

NOX::Abstract::Group::ReturnType LOCA::MultiContinuation::MultiVecConstraint::computeConstraints ( )

virtual

Compute continuation constraint equations.

Implements LOCA::MultiContinuation::ConstraintInterface.

References NOX::Abstract::Group::Ok.

◆ 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 if isValidG is false. If isValidG is true, then the dgdp contains on input.

Implements LOCA::MultiContinuation::ConstraintInterface.

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

◆ computeDX()

NOX::Abstract::Group::ReturnType LOCA::MultiContinuation::MultiVecConstraint::computeDX ( )

virtual

Compute derivative of constraints w.r.t. solution vector x.

Implements LOCA::MultiContinuation::ConstraintInterface.

References NOX::Abstract::Group::Ok.

◆ copy()

void LOCA::MultiContinuation::MultiVecConstraint::copy ( const ConstraintInterface & source )

virtual

Copy.

Implements LOCA::MultiContinuation::ConstraintInterface.

References constraints, dx, isValidConstraints, and x.

◆ getConstraints()

const NOX::Abstract::MultiVector::DenseMatrix & LOCA::MultiContinuation::MultiVecConstraint::getConstraints ( ) const

virtual

Return constraint residuals.

Implements LOCA::MultiContinuation::ConstraintInterface.

◆ getDX()

const NOX::Abstract::MultiVector * LOCA::MultiContinuation::MultiVecConstraint::getDX ( ) const

virtual

Return solution component of constraint derivatives.

Implements LOCA::MultiContinuation::ConstraintInterfaceMVDX.

◆ isConstraints()

bool LOCA::MultiContinuation::MultiVecConstraint::isConstraints ( ) const

virtual

Return true if constraint residuals are valid.

Implements LOCA::MultiContinuation::ConstraintInterface.

◆ isDX()

bool LOCA::MultiContinuation::MultiVecConstraint::isDX ( ) const

virtual

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

Implements LOCA::MultiContinuation::ConstraintInterface.

◆ isDXZero()

bool LOCA::MultiContinuation::MultiVecConstraint::isDXZero ( ) const

virtual

Return true if solution component of constraint derivatives is zero.

Implements LOCA::MultiContinuation::ConstraintInterface.

◆ notifyCompletedStep()

void LOCA::MultiContinuation::MultiVecConstraint::notifyCompletedStep ( )

virtual

Notify constraint that the continuation step is completed.

Here we do nothing

◆ numConstraints()

int LOCA::MultiContinuation::MultiVecConstraint::numConstraints ( ) const

virtual

Return number of constraints.

Implements LOCA::MultiContinuation::ConstraintInterface.

◆ setParam()

void LOCA::MultiContinuation::MultiVecConstraint::setParam	(	int	paramID,
		double	val
	)

virtual

Sets parameter indexed by paramID.

Implements LOCA::MultiContinuation::ConstraintInterface.

◆ setParams()

void LOCA::MultiContinuation::MultiVecConstraint::setParams	(	const std::vector< int > &	paramIDs,
		const NOX::Abstract::MultiVector::DenseMatrix &	vals
	)

virtual

Sets parameters indexed by paramIDs.

Implements LOCA::MultiContinuation::ConstraintInterface.

◆ setX()

void LOCA::MultiContinuation::MultiVecConstraint::setX ( const NOX::Abstract::Vector & y )

virtual

Set the solution vector to y.

Implements LOCA::MultiContinuation::ConstraintInterface.

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

LOCA_MultiContinuation_MultiVecConstraint.H
LOCA_MultiContinuation_MultiVecConstraint.C

Public Member Functions

Implementation of LOCA::MultiContinuation::ConstraintInterfaceMVDX

Detailed Description

Member Function Documentation

◆ clone()

◆ computeConstraints()

◆ computeDP()

◆ computeDX()

◆ copy()

◆ getConstraints()

◆ getDX()

◆ isConstraints()

◆ isDX()

◆ isDXZero()

◆ notifyCompletedStep()

◆ numConstraints()

◆ setParam()

◆ setParams()

◆ setX()