ROL
Public Member Functions | List of all members
ROL::StdConstraint< Real > Class Template Referenceabstract
User Interface » Functional Interface

Defines the equality constraint operator interface for StdVectors. More...

#include <ROL_StdConstraint.hpp>

Inheritance diagram for ROL::StdConstraint< Real >:

Public Member Functions

virtual ~StdConstraint ()
void update (const Vector< Real > &x, bool flag=true, int iter=-1) override
virtual void update (const std::vector< Real > &x, bool flag=true, int iter=-1)
void update (const Vector< Real > &x, UpdateType type, int iter=-1) override
virtual void update (const std::vector< Real > &x, UpdateType type, int iter=-1)
void value (Vector< Real > &c, const Vector< Real > &x, Real &tol) override
virtual void value (std::vector< Real > &c, const std::vector< Real > &x, Real &tol)=0
void applyJacobian (Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
virtual void applyJacobian (std::vector< Real > &jv, const std::vector< Real > &v, const std::vector< Real > &x, Real &tol)
void applyAdjointJacobian (Vector< Real > &ajv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
virtual void applyAdjointJacobian (std::vector< Real > &ajv, const std::vector< Real > &v, const std::vector< Real > &x, Real &tol)
void applyAdjointHessian (Vector< Real > &ahuv, const Vector< Real > &u, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
virtual void applyAdjointHessian (std::vector< Real > &ahuv, const std::vector< Real > &u, const std::vector< Real > &v, const std::vector< Real > &x, Real &tol)
std::vector< Real > solveAugmentedSystem (Vector< Real > &v1, Vector< Real > &v2, const Vector< Real > &b1, const Vector< Real > &b2, const Vector< Real > &x, Real &tol) override
virtual std::vector< Real > solveAugmentedSystem (std::vector< Real > &v1, std::vector< Real > &v2, const std::vector< Real > &b1, const std::vector< Real > &b2, const std::vector< Real > &x, Real tol)
void applyPreconditioner (Vector< Real > &pv, const Vector< Real > &v, const Vector< Real > &x, const Vector< Real > &g, Real &tol) override
virtual void applyPreconditioner (std::vector< Real > &pv, const std::vector< Real > &v, const std::vector< Real > &x, const std::vector< Real > &g, Real &tol)
Public Member Functions inherited from ROL::ROL::Constraint< Real >
virtual ~Constraint (void)
 Constraint (void)
virtual void update (const Vector< Real > &x, UpdateType type, int iter=-1)
 Update constraint function.
virtual void update (const Vector< Real > &x, bool flag=true, int iter=-1)
 Update constraint functions.
x is the optimization variable, flag = true if optimization variable is changed, iter is the outer algorithm iterations count.
virtual void value (Vector< Real > &c, const Vector< Real > &x, Real &tol)=0
 Evaluate the constraint operator \(c:\mathcal{X} \rightarrow \mathcal{C}\) at \(x\).
virtual void applyJacobian (Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Apply the constraint Jacobian at \(x\), \(c'(x) \in L(\mathcal{X}, \mathcal{C})\), to vector \(v\).
virtual void applyAdjointJacobian (Vector< Real > &ajv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Apply the adjoint of the the constraint Jacobian at \(x\), \(c'(x)^* \in L(\mathcal{C}^*, \mathcal{X}^*)\), to vector \(v\).
virtual void applyAdjointJacobian (Vector< Real > &ajv, const Vector< Real > &v, const Vector< Real > &x, const Vector< Real > &dualv, Real &tol)
 Apply the adjoint of the the constraint Jacobian at \(x\), \(c'(x)^* \in L(\mathcal{C}^*, \mathcal{X}^*)\), to vector \(v\).
virtual void applyAdjointHessian (Vector< Real > &ahuv, const Vector< Real > &u, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Apply the derivative of the adjoint of the constraint Jacobian at \(x\) to vector \(u\) in direction \(v\), according to \( v \mapsto c''(x)(v,\cdot)^*u \).
virtual std::vector< Real > solveAugmentedSystem (Vector< Real > &v1, Vector< Real > &v2, const Vector< Real > &b1, const Vector< Real > &b2, const Vector< Real > &x, Real &tol)
 Approximately solves the augmented system .
virtual void applyPreconditioner (Vector< Real > &pv, const Vector< Real > &v, const Vector< Real > &x, const Vector< Real > &g, Real &tol)
 Apply a constraint preconditioner at \(x\), \(P(x) \in L(\mathcal{C}, \mathcal{C}^*)\), to vector \(v\). Ideally, this preconditioner satisfies the following relationship:
void activate (void)
 Turn on constraints.
void deactivate (void)
 Turn off constraints.
bool isActivated (void)
 Check if constraints are on.
virtual std::vector< std::vector< Real > > checkApplyJacobian (const Vector< Real > &x, const Vector< Real > &v, const Vector< Real > &jv, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
 Finite-difference check for the constraint Jacobian application.
virtual std::vector< std::vector< Real > > checkApplyJacobian (const Vector< Real > &x, const Vector< Real > &v, const Vector< Real > &jv, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
 Finite-difference check for the constraint Jacobian application.
virtual std::vector< std::vector< Real > > checkApplyAdjointJacobian (const Vector< Real > &x, const Vector< Real > &v, const Vector< Real > &c, const Vector< Real > &ajv, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS)
 Finite-difference check for the application of the adjoint of constraint Jacobian.
virtual Real checkAdjointConsistencyJacobian (const Vector< Real > &w, const Vector< Real > &v, const Vector< Real > &x, const bool printToStream=true, std::ostream &outStream=std::cout)
virtual Real checkAdjointConsistencyJacobian (const Vector< Real > &w, const Vector< Real > &v, const Vector< Real > &x, const Vector< Real > &dualw, const Vector< Real > &dualv, const bool printToStream=true, std::ostream &outStream=std::cout)
virtual std::vector< std::vector< Real > > checkApplyAdjointHessian (const Vector< Real > &x, const Vector< Real > &u, const Vector< Real > &v, const Vector< Real > &hv, const std::vector< Real > &step, const bool printToScreen=true, std::ostream &outStream=std::cout, const int order=1)
 Finite-difference check for the application of the adjoint of constraint Hessian.
virtual std::vector< std::vector< Real > > checkApplyAdjointHessian (const Vector< Real > &x, const Vector< Real > &u, const Vector< Real > &v, const Vector< Real > &hv, const bool printToScreen=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
 Finite-difference check for the application of the adjoint of constraint Hessian.
virtual void setParameter (const std::vector< Real > &param)

Additional Inherited Members

Protected Member Functions inherited from ROL::ROL::Constraint< Real >
const std::vector< Real > getParameter (void) const

Detailed Description

template<typename Real>
class ROL::StdConstraint< Real >

Defines the equality constraint operator interface for StdVectors.

Definition at line 25 of file ROL_StdConstraint.hpp.

Constructor & Destructor Documentation

◆ ~StdConstraint()

template<typename Real>
virtual ROL::StdConstraint< Real >::~StdConstraint ( )
inlinevirtual

Definition at line 27 of file ROL_StdConstraint.hpp.

Member Function Documentation

◆ update() [1/4]

template<typename Real>
void ROL::StdConstraint< Real >::update ( const Vector< Real > & x,
bool flag = true,
int iter = -1 )
override

Definition at line 16 of file ROL_StdConstraint_Def.hpp.

References ROL::StdVector< Real, Element >::getVector(), and update().

◆ update() [2/4]

template<typename Real>
virtual void ROL::StdConstraint< Real >::update ( const std::vector< Real > & x,
bool flag = true,
int iter = -1 )
inlinevirtual

Definition at line 31 of file ROL_StdConstraint.hpp.

◆ update() [3/4]

template<typename Real>
void ROL::StdConstraint< Real >::update ( const Vector< Real > & x,
UpdateType type,
int iter = -1 )
override

Definition at line 22 of file ROL_StdConstraint_Def.hpp.

References ROL::StdVector< Real, Element >::getVector(), and update().

◆ update() [4/4]

template<typename Real>
virtual void ROL::StdConstraint< Real >::update ( const std::vector< Real > & x,
UpdateType type,
int iter = -1 )
inlinevirtual

Definition at line 33 of file ROL_StdConstraint.hpp.

◆ value() [1/2]

template<typename Real>
void ROL::StdConstraint< Real >::value ( Vector< Real > & c,
const Vector< Real > & x,
Real & tol )
override

Definition at line 28 of file ROL_StdConstraint_Def.hpp.

◆ value() [2/2]

template<typename Real>
virtual void ROL::StdConstraint< Real >::value ( std::vector< Real > & c,
const std::vector< Real > & x,
Real & tol )
pure virtual

Implemented in con2d< Real >, con2d< Real >, ROL::ZOO::Constraint_Cantilever< Real >, ROL::ZOO::Constraint_CantileverBeam< Real >, ROL::ZOO::Constraint_Cubic< Real >, ROL::ZOO::Constraint_CylinderHead< Real >, ROL::ZOO::Constraint_HS14a< Real >, ROL::ZOO::Constraint_HS14b< Real >, ROL::ZOO::Constraint_HS21< Real >, ROL::ZOO::Constraint_HS28< Real >, ROL::ZOO::Constraint_HS41< Real >, ROL::ZOO::Constraint_HS42a< Real >, ROL::ZOO::Constraint_HS42b< Real >, ROL::ZOO::Constraint_HS48< Real >, ROL::ZOO::Constraint_HS49< Real >, ROL::ZOO::Constraint_HS50< Real >, ROL::ZOO::Constraint_HS51< Real >, ROL::ZOO::Constraint_HS52< Real >, ROL::ZOO::Constraint_HS53< Real >, ROL::ZOO::Constraint_HS55< Real >, ROL::ZOO::Constraint_HS63a< Real >, ROL::ZOO::Constraint_HS63b< Real >, ROL::ZOO::Constraint_HS9< Real >, and ROL::ZOO::Constraint_Quartic< Real >.

References applyAdjointHessian(), applyAdjointJacobian(), applyJacobian(), applyPreconditioner(), ROL::ROL::Constraint< Real >::Constraint(), and solveAugmentedSystem().

◆ applyJacobian() [1/2]

template<typename Real>
void ROL::StdConstraint< Real >::applyJacobian ( Vector< Real > & jv,
const Vector< Real > & v,
const Vector< Real > & x,
Real & tol )
override

Definition at line 35 of file ROL_StdConstraint_Def.hpp.

Referenced by value().

◆ applyJacobian() [2/2]

template<typename Real>
void ROL::StdConstraint< Real >::applyJacobian ( std::vector< Real > & jv,
const std::vector< Real > & v,
const std::vector< Real > & x,
Real & tol )
virtual

Reimplemented in con2d< Real >, con2d< Real >, ROL::ZOO::Constraint_Cantilever< Real >, ROL::ZOO::Constraint_CantileverBeam< Real >, ROL::ZOO::Constraint_Cubic< Real >, ROL::ZOO::Constraint_CylinderHead< Real >, ROL::ZOO::Constraint_HS14a< Real >, ROL::ZOO::Constraint_HS14b< Real >, ROL::ZOO::Constraint_HS21< Real >, ROL::ZOO::Constraint_HS28< Real >, ROL::ZOO::Constraint_HS41< Real >, ROL::ZOO::Constraint_HS42a< Real >, ROL::ZOO::Constraint_HS42b< Real >, ROL::ZOO::Constraint_HS48< Real >, ROL::ZOO::Constraint_HS49< Real >, ROL::ZOO::Constraint_HS50< Real >, ROL::ZOO::Constraint_HS51< Real >, ROL::ZOO::Constraint_HS52< Real >, ROL::ZOO::Constraint_HS53< Real >, ROL::ZOO::Constraint_HS55< Real >, ROL::ZOO::Constraint_HS63a< Real >, ROL::ZOO::Constraint_HS63b< Real >, ROL::ZOO::Constraint_HS9< Real >, and ROL::ZOO::Constraint_Quartic< Real >.

Definition at line 50 of file ROL_StdConstraint_Def.hpp.

◆ applyAdjointJacobian() [1/2]

template<typename Real>
void ROL::StdConstraint< Real >::applyAdjointJacobian ( Vector< Real > & ajv,
const Vector< Real > & v,
const Vector< Real > & x,
Real & tol )
override

Definition at line 58 of file ROL_StdConstraint_Def.hpp.

Referenced by value().

◆ applyAdjointJacobian() [2/2]

template<typename Real>
void ROL::StdConstraint< Real >::applyAdjointJacobian ( std::vector< Real > & ajv,
const std::vector< Real > & v,
const std::vector< Real > & x,
Real & tol )
virtual

Reimplemented in con2d< Real >, con2d< Real >, ROL::ZOO::Constraint_Cantilever< Real >, ROL::ZOO::Constraint_CantileverBeam< Real >, ROL::ZOO::Constraint_Cubic< Real >, ROL::ZOO::Constraint_CylinderHead< Real >, ROL::ZOO::Constraint_HS14a< Real >, ROL::ZOO::Constraint_HS14b< Real >, ROL::ZOO::Constraint_HS21< Real >, ROL::ZOO::Constraint_HS28< Real >, ROL::ZOO::Constraint_HS41< Real >, ROL::ZOO::Constraint_HS42a< Real >, ROL::ZOO::Constraint_HS42b< Real >, ROL::ZOO::Constraint_HS48< Real >, ROL::ZOO::Constraint_HS49< Real >, ROL::ZOO::Constraint_HS50< Real >, ROL::ZOO::Constraint_HS51< Real >, ROL::ZOO::Constraint_HS52< Real >, ROL::ZOO::Constraint_HS53< Real >, ROL::ZOO::Constraint_HS55< Real >, ROL::ZOO::Constraint_HS63a< Real >, ROL::ZOO::Constraint_HS63b< Real >, ROL::ZOO::Constraint_HS9< Real >, and ROL::ZOO::Constraint_Quartic< Real >.

Definition at line 73 of file ROL_StdConstraint_Def.hpp.

◆ applyAdjointHessian() [1/2]

template<typename Real>
void ROL::StdConstraint< Real >::applyAdjointHessian ( Vector< Real > & ahuv,
const Vector< Real > & u,
const Vector< Real > & v,
const Vector< Real > & x,
Real & tol )
override

Definition at line 81 of file ROL_StdConstraint_Def.hpp.

References ROL::Constraint< Real >::applyAdjointHessian(), applyAdjointHessian(), and ROL::StdVector< Real, Element >::getVector().

Referenced by applyAdjointHessian(), and value().

◆ applyAdjointHessian() [2/2]

template<typename Real>
void ROL::StdConstraint< Real >::applyAdjointHessian ( std::vector< Real > & ahuv,
const std::vector< Real > & u,
const std::vector< Real > & v,
const std::vector< Real > & x,
Real & tol )
virtual

Reimplemented in ROL::ZOO::Constraint_HS14a< Real >, ROL::ZOO::Constraint_HS14b< Real >, ROL::ZOO::Constraint_HS21< Real >, ROL::ZOO::Constraint_HS28< Real >, ROL::ZOO::Constraint_HS41< Real >, ROL::ZOO::Constraint_HS42a< Real >, ROL::ZOO::Constraint_HS42b< Real >, ROL::ZOO::Constraint_HS48< Real >, ROL::ZOO::Constraint_HS49< Real >, ROL::ZOO::Constraint_HS50< Real >, ROL::ZOO::Constraint_HS51< Real >, ROL::ZOO::Constraint_HS52< Real >, ROL::ZOO::Constraint_HS53< Real >, ROL::ZOO::Constraint_HS55< Real >, ROL::ZOO::Constraint_HS63a< Real >, ROL::ZOO::Constraint_HS63b< Real >, and ROL::ZOO::Constraint_HS9< Real >.

Definition at line 99 of file ROL_StdConstraint_Def.hpp.

◆ solveAugmentedSystem() [1/2]

template<typename Real>
std::vector< Real > ROL::StdConstraint< Real >::solveAugmentedSystem ( Vector< Real > & v1,
Vector< Real > & v2,
const Vector< Real > & b1,
const Vector< Real > & b2,
const Vector< Real > & x,
Real & tol )
override

Definition at line 108 of file ROL_StdConstraint_Def.hpp.

References ROL::StdVector< Real, Element >::getVector(), ROL::Constraint< Real >::solveAugmentedSystem(), and solveAugmentedSystem().

Referenced by solveAugmentedSystem(), and value().

◆ solveAugmentedSystem() [2/2]

template<typename Real>
std::vector< Real > ROL::StdConstraint< Real >::solveAugmentedSystem ( std::vector< Real > & v1,
std::vector< Real > & v2,
const std::vector< Real > & b1,
const std::vector< Real > & b2,
const std::vector< Real > & x,
Real tol )
virtual

Definition at line 128 of file ROL_StdConstraint_Def.hpp.

◆ applyPreconditioner() [1/2]

template<typename Real>
void ROL::StdConstraint< Real >::applyPreconditioner ( Vector< Real > & pv,
const Vector< Real > & v,
const Vector< Real > & x,
const Vector< Real > & g,
Real & tol )
override

Definition at line 139 of file ROL_StdConstraint_Def.hpp.

References ROL::Constraint< Real >::applyPreconditioner(), applyPreconditioner(), and ROL::StdVector< Real, Element >::getVector().

Referenced by applyPreconditioner(), and value().

◆ applyPreconditioner() [2/2]

template<typename Real>
void ROL::StdConstraint< Real >::applyPreconditioner ( std::vector< Real > & pv,
const std::vector< Real > & v,
const std::vector< Real > & x,
const std::vector< Real > & g,
Real & tol )
virtual

Definition at line 157 of file ROL_StdConstraint_Def.hpp.

The documentation for this class was generated from the following files:
Generated by doxygen 1.15.0