Implementation of LOCA::MultiContinuation::ConstraintInterface for natural continuation. More...

#include <LOCA_MultiContinuation_NaturalConstraint.H>

Inheritance diagram for LOCA::MultiContinuation::NaturalConstraint:

Collaboration diagram for LOCA::MultiContinuation::NaturalConstraint:

Public Member Functions
	NaturalConstraint (const Teuchos::RCP< LOCA::GlobalData > &global_data, const Teuchos::RCP< LOCA::MultiContinuation::NaturalGroup > &grp)
	Constructor.

	NaturalConstraint (const NaturalConstraint &source, NOX::CopyType type=NOX::DeepCopy)
	Copy constructor.

	~NaturalConstraint ()
	Destructor.

virtual void	setNaturalGroup (const Teuchos::RCP< LOCA::MultiContinuation::NaturalGroup > &grp)
	Set pointer to natural group.

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)
	Perform any preprocessing before a continuation step starts. More...

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

Implementation of LOCA::MultiContinuation::ConstraintInterface
virtual methods
Teuchos::RCP< LOCA::GlobalData >	globalData
	LOCA global data object.

Teuchos::RCP< LOCA::MultiContinuation::NaturalGroup >	naturalGroup
	Pointer to arc-length group.

NOX::Abstract::MultiVector::DenseMatrix	constraints
	Constraint values.

bool	isValidConstraints
	Flag indicating whether constraints are valid.

std::vector< int >	conParamIDs
	Continuation parameter IDs.

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. 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::DenseMatrix &	getConstraints () const
	Return constraint residuals.

virtual const NOX::Abstract::MultiVector *	getDX () const
	Return solution component of constraint derivatives. More...

virtual bool	isDXZero () const
	Return `true` if solution component of constraint derivatives is zero.

Detailed Description

Implementation of LOCA::MultiContinuation::ConstraintInterface for natural continuation.

This class implements the natural constraint equation for natural continuation:

$g(x,p,x_0,p_0,x^\ast,p^\ast,v,\Delta s)= p-p_0-v_p \Delta s$

where $v_p$ is the parameter component of the predictor direction $v$ .

Member Function Documentation

◆ computeDP()

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

◆ getDX()

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

virtual

Return solution component of constraint derivatives.

Since the solution component of the derivative is always zero, this always returns NULL.

Implements LOCA::MultiContinuation::ConstraintInterfaceMVDX.

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

LOCA_MultiContinuation_NaturalConstraint.H
LOCA_MultiContinuation_NaturalConstraint.C

Public Member Functions

Implementation of LOCA::MultiContinuation::ConstraintInterface

Detailed Description

Member Function Documentation

◆ computeDP()

◆ getDX()