ROL::Constraint_DynamicState< Real > Class Template Reference

#include <ROL_Constraint_DynamicState.hpp>

Inheritance diagram for ROL::Constraint_DynamicState< Real >:

Public Member Functions
	Constraint_DynamicState (const Ptr< DynamicConstraint< Real > > &con, const Ptr< const Vector< Real > > &uo, const Ptr< const Vector< Real > > &z, const Ptr< const TimeStamp< Real > > &ts)
void	value (Vector< Real > &c, const Vector< Real > &u, Real &tol)
void	applyJacobian (Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &u, Real &tol)
void	applyAdjointJacobian (Vector< Real > &ajv, const Vector< Real > &v, const Vector< Real > &u, Real &tol)
void	applyAdjointHessian (Vector< Real > &ahwv, const Vector< Real > &w, const Vector< Real > &v, const Vector< Real > &u, Real &tol)
void	update (const Vector< Real > &u, bool flag=true, int iter=-1)
void	applyPreconditioner (Vector< Real > &pv, const Vector< Real > &v, const Vector< Real > &u, const 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)

Private Attributes
const Ptr< DynamicConstraint< Real > >	con_
const Ptr< const Vector< Real > >	uo_
const Ptr< const Vector< Real > >	z_
const Ptr< const TimeStamp< Real > >	ts_
Ptr< Vector< Real > >	ijv_
bool	isInit_

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

Detailed Description

template<class Real>
class ROL::Constraint_DynamicState< Real >

Definition at line 19 of file ROL_Constraint_DynamicState.hpp.

Constructor & Destructor Documentation

Constraint_DynamicState()

template<class Real>

ROL::Constraint_DynamicState< Real >::Constraint_DynamicState ( const Ptr< DynamicConstraint< Real > > & con, const Ptr< const Vector< Real > > & uo, const Ptr< const Vector< Real > > & z, const Ptr< const TimeStamp< Real > > & ts )

inline

Definition at line 30 of file ROL_Constraint_DynamicState.hpp.

References con_, isInit_, ts_, uo_, and z_.

Member Function Documentation

value()

template<class Real>

void ROL::Constraint_DynamicState< Real >::value ( Vector< Real > & c, const Vector< Real > & u, Real & tol )

inline

Definition at line 36 of file ROL_Constraint_DynamicState.hpp.

References con_, ts_, uo_, and z_.

applyJacobian()

template<class Real>

void ROL::Constraint_DynamicState< Real >::applyJacobian ( Vector< Real > & jv, const Vector< Real > & v, const Vector< Real > & u, Real & tol )

inline

Definition at line 40 of file ROL_Constraint_DynamicState.hpp.

References con_, ts_, uo_, and z_.

applyAdjointJacobian()

template<class Real>

void ROL::Constraint_DynamicState< Real >::applyAdjointJacobian ( Vector< Real > & ajv, const Vector< Real > & v, const Vector< Real > & u, Real & tol )

inline

Definition at line 45 of file ROL_Constraint_DynamicState.hpp.

References con_, ts_, uo_, and z_.

applyAdjointHessian()

template<class Real>

void ROL::Constraint_DynamicState< Real >::applyAdjointHessian ( Vector< Real > & ahwv, const Vector< Real > & w, const Vector< Real > & v, const Vector< Real > & u, Real & tol )

inline

Definition at line 49 of file ROL_Constraint_DynamicState.hpp.

References con_, ts_, uo_, and z_.

update()

template<class Real>

void ROL::Constraint_DynamicState< Real >::update ( const Vector< Real > & u, bool flag = true, int iter = -1 )

inline

Definition at line 53 of file ROL_Constraint_DynamicState.hpp.

References con_, ts_, uo_, and z_.

applyPreconditioner()

template<class Real>

void ROL::Constraint_DynamicState< Real >::applyPreconditioner ( Vector< Real > & pv, const Vector< Real > & v, const Vector< Real > & u, const Vector< Real > & g, Real & tol )

inline

Definition at line 58 of file ROL_Constraint_DynamicState.hpp.

References ROL::Vector< Real >::clone(), con_, ijv_, isInit_, ts_, uo_, and z_.

Member Data Documentation

con_

template<class Real>

const Ptr<DynamicConstraint<Real> > ROL::Constraint_DynamicState< Real >::con_

private

Definition at line 21 of file ROL_Constraint_DynamicState.hpp.

Referenced by applyAdjointHessian(), applyAdjointJacobian(), applyJacobian(), applyPreconditioner(), Constraint_DynamicState(), update(), and value().

uo_

template<class Real>

const Ptr<const Vector<Real> > ROL::Constraint_DynamicState< Real >::uo_

private

Definition at line 22 of file ROL_Constraint_DynamicState.hpp.

Referenced by applyAdjointHessian(), applyAdjointJacobian(), applyJacobian(), applyPreconditioner(), Constraint_DynamicState(), update(), and value().

z_

template<class Real>

const Ptr<const Vector<Real> > ROL::Constraint_DynamicState< Real >::z_

private

Definition at line 23 of file ROL_Constraint_DynamicState.hpp.

Referenced by applyAdjointHessian(), applyAdjointJacobian(), applyJacobian(), applyPreconditioner(), Constraint_DynamicState(), update(), and value().

ts_

template<class Real>

const Ptr<const TimeStamp<Real> > ROL::Constraint_DynamicState< Real >::ts_

private

Definition at line 24 of file ROL_Constraint_DynamicState.hpp.

Referenced by applyAdjointHessian(), applyAdjointJacobian(), applyJacobian(), applyPreconditioner(), Constraint_DynamicState(), update(), and value().

ijv_

template<class Real>

Ptr<Vector<Real> > ROL::Constraint_DynamicState< Real >::ijv_

private

Definition at line 26 of file ROL_Constraint_DynamicState.hpp.

Referenced by applyPreconditioner().

isInit_

template<class Real>

bool ROL::Constraint_DynamicState< Real >::isInit_

private

Definition at line 27 of file ROL_Constraint_DynamicState.hpp.

Referenced by applyPreconditioner(), and Constraint_DynamicState().

---

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

• ROL_Constraint_DynamicState.hpp