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:

[legend]

Collaboration diagram for LOCA::MultiContinuation::MultiVecConstraint:

[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.
Private Member Functions
MultiVecConstraint &	operator= (const MultiVecConstraint &source)
	Prohibit generation and use of operator=().

---

Detailed Description

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

Definition at line 57 of file LOCA_MultiContinuation_MultiVecConstraint.H.

---

Constructor & Destructor Documentation

LOCA::MultiContinuation::MultiVecConstraint::MultiVecConstraint

(

const Teuchos::RCP< const NOX::Abstract::MultiVector > &

dx

)

Constructor.

Definition at line 44 of file LOCA_MultiContinuation_MultiVecConstraint.C.

Referenced by clone().

LOCA::MultiContinuation::MultiVecConstraint::MultiVecConstraint	(	const MultiVecConstraint &	source,
		NOX::CopyType	type = NOX::DeepCopy
	)

Copy constructor.

Definition at line 53 of file LOCA_MultiContinuation_MultiVecConstraint.C.

References NOX::DeepCopy, and isValidConstraints.

LOCA::MultiContinuation::MultiVecConstraint::~MultiVecConstraint

(

)

Destructor.

Definition at line 65 of file LOCA_MultiContinuation_MultiVecConstraint.C.

---

Member Function Documentation

void LOCA::MultiContinuation::MultiVecConstraint::setDx

(

const Teuchos::RCP< const NOX::Abstract::MultiVector > &

dx

)

[virtual]

Set constraint vector.

Definition at line 70 of file LOCA_MultiContinuation_MultiVecConstraint.C.

References dx.

void LOCA::MultiContinuation::MultiVecConstraint::copy

(

const ConstraintInterface &

source

)

[virtual]

Copy.

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 77 of file LOCA_MultiContinuation_MultiVecConstraint.C.

References constraints, dx, isValidConstraints, and x.

Teuchos::RCP< LOCA::MultiContinuation::ConstraintInterface > LOCA::MultiContinuation::MultiVecConstraint::clone

(

NOX::CopyType

type = NOX::DeepCopy

)

const [virtual]

Cloning function.

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 92 of file LOCA_MultiContinuation_MultiVecConstraint.C.

References MultiVecConstraint().

int LOCA::MultiContinuation::MultiVecConstraint::numConstraints

(

)

const [virtual]

Return number of constraints.

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 98 of file LOCA_MultiContinuation_MultiVecConstraint.C.

References constraints.

void LOCA::MultiContinuation::MultiVecConstraint::setX

(

const NOX::Abstract::Vector &

y

)

[virtual]

Set the solution vector to y.

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 104 of file LOCA_MultiContinuation_MultiVecConstraint.C.

References isValidConstraints.

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

Sets parameter indexed by paramID.

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 112 of file LOCA_MultiContinuation_MultiVecConstraint.C.

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

Sets parameters indexed by paramIDs.

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 117 of file LOCA_MultiContinuation_MultiVecConstraint.C.

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

(

)

[virtual]

Compute continuation constraint equations.

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 124 of file LOCA_MultiContinuation_MultiVecConstraint.C.

References constraints, dx, isValidConstraints, NOX::Abstract::Group::Ok, and x.

Referenced by computeDP().

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

(

)

[virtual]

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

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 135 of file LOCA_MultiContinuation_MultiVecConstraint.C.

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

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

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 141 of file LOCA_MultiContinuation_MultiVecConstraint.C.

References computeConstraints(), constraints, and isValidConstraints.

bool LOCA::MultiContinuation::MultiVecConstraint::isConstraints

(

)

const [virtual]

Return true if constraint residuals are valid.

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 168 of file LOCA_MultiContinuation_MultiVecConstraint.C.

References isValidConstraints.

bool LOCA::MultiContinuation::MultiVecConstraint::isDX

(

)

const [virtual]

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

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 174 of file LOCA_MultiContinuation_MultiVecConstraint.C.

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

(

)

const [virtual]

Return constraint residuals.

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 180 of file LOCA_MultiContinuation_MultiVecConstraint.C.

References constraints.

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

(

)

const [virtual]

Return solution component of constraint derivatives.

Implements LOCA::MultiContinuation::ConstraintInterfaceMVDX.

Definition at line 186 of file LOCA_MultiContinuation_MultiVecConstraint.C.

References dx.

bool LOCA::MultiContinuation::MultiVecConstraint::isDXZero

(

)

const [virtual]

Return true if solution component of constraint derivatives is zero.

Implements LOCA::MultiContinuation::ConstraintInterface.

Definition at line 192 of file LOCA_MultiContinuation_MultiVecConstraint.C.

void LOCA::MultiContinuation::MultiVecConstraint::notifyCompletedStep

(

)

[virtual]

Notify constraint that the continuation step is completed.

Here we do nothing

Definition at line 198 of file LOCA_MultiContinuation_MultiVecConstraint.C.

MultiVecConstraint& LOCA::MultiContinuation::MultiVecConstraint::operator=

(

const MultiVecConstraint &

source

)

[private]

Prohibit generation and use of operator=().

---

Member Data Documentation

Teuchos::RCP<NOX::Abstract::MultiVector> LOCA::MultiContinuation::MultiVecConstraint::dx [protected]

Constraint vector.

Definition at line 160 of file LOCA_MultiContinuation_MultiVecConstraint.H.

Referenced by computeConstraints(), copy(), getDX(), and setDx().

Teuchos::RCP<NOX::Abstract::MultiVector> LOCA::MultiContinuation::MultiVecConstraint::x [protected]

Solution vector.

Definition at line 163 of file LOCA_MultiContinuation_MultiVecConstraint.H.

Referenced by computeConstraints(), and copy().

NOX::Abstract::MultiVector::DenseMatrix LOCA::MultiContinuation::MultiVecConstraint::constraints [protected]

Constraint values.

Definition at line 166 of file LOCA_MultiContinuation_MultiVecConstraint.H.

Referenced by computeConstraints(), computeDP(), copy(), getConstraints(), and numConstraints().

bool LOCA::MultiContinuation::MultiVecConstraint::isValidConstraints [protected]

Flag indicating whether constraints are valid.

Definition at line 169 of file LOCA_MultiContinuation_MultiVecConstraint.H.

Referenced by computeConstraints(), computeDP(), copy(), isConstraints(), MultiVecConstraint(), and setX().

---

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

• LOCA_MultiContinuation_MultiVecConstraint.H
• LOCA_MultiContinuation_MultiVecConstraint.C