Aristos::Constraints Class Reference

Provides interfaces for the evaluation of quantities related to the constraint function. More...

#include <Aristos_Constraints.hpp>

Public Member Functions
virtual void	getValue (const Vector &x, Vector &c) const =0
	Evaluates the vector of constraints. More...
virtual void	applyJacobian (bool Trans, const Vector &x, const Vector &v, Vector &Jv) const =0
	Applies the Jacobian operator to vector. More...
virtual void	applyNullSp (bool Trans, const Vector &x, const Vector &v, Vector &Wv, double *tol) const =0
	Applies the constraint null space operator to a vector. More...

Detailed Description

Provides interfaces for the evaluation of quantities related to the constraint function.

These include:

• constraint evaluation
• application of the Jacobian operator
• application of the constraint null space operator

Member Function Documentation

virtual void Aristos::Constraints::applyJacobian ( bool  Trans, const Vector &  x, const Vector &  v, Vector &  Jv  ) const

pure virtual

Applies the Jacobian operator to vector.

Parameters

Trans	[in] - If Trans==true, apply adjoint operator, otherwise apply standard operator.
x	[in] - Current SQP iterate vector.
v	[in] - The vector to which the Jacobian operator is applied.
Jv	[out] - Resulting vector.

Returns

None.

Detailed Description:

Interface function that evaluates the vector obtained by applying the Jacobian operator (or the adjoint thereof) to a vector. To be subclassed and implemented by the user.

Note

The Aristos::Vector input parameters can be recast into user-accessible quantities by using the following syntax (this is only one example):
Teuchos::RefCountPtr<const YourVectorClass> ex = (Teuchos::dyn_cast<Aristos::YourVectorAdapter>(const_cast<Aristos::Vector&>(x))).getVector();

virtual void Aristos::Constraints::applyNullSp ( bool  Trans, const Vector &  x, const Vector &  v, Vector &  Wv, double *  tol  ) const

pure virtual

Applies the constraint null space operator to a vector.

Parameters

Trans	[in] - If Trans==true, apply adjoint operator, otherwise apply standard operator.
x	[in] - Current SQP iterate vector.
v	[in] - The vector to which the constraint null space operator is applied.
Wv	[out] - Resulting vector.
tol	[in] - Tolerance for inexact computations.

Returns

None.

Detailed Description:

Interface function that evaluates the vector obtained by applying the constraint null space operator (or the adjoint thereof) to a vector. To be subclassed and implemented by the user.

Note

The Aristos::Vector input parameters can be recast into user-accessible quantities by using the following syntax (this is only one example):
Teuchos::RefCountPtr<const YourVectorClass> ex = (Teuchos::dyn_cast<Aristos::YourVectorAdapter>(const_cast<Aristos::Vector&>(x))).getVector();

virtual void Aristos::Constraints::getValue ( const Vector &  x, Vector &  c  ) const

pure virtual

Evaluates the vector of constraints.

Parameters

x	[in] - Current SQP iterate vector.
c	[out] - Value of constraints.

Returns

None.

Detailed Description:

Interface function that evaluates the vector of constraints. To be subclassed and implemented by the user.

Note

The Aristos::Vector input parameters can be recast into user-accessible quantities by using the following syntax (this is only one example):
Teuchos::RefCountPtr<const YourVectorClass> ex = (Teuchos::dyn_cast<Aristos::YourVectorAdapter>(const_cast<Aristos::Vector&>(x))).getVector();

---

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

• Aristos_Constraints.hpp