redConstraint< Real > Class Template Reference

Inheritance diagram for redConstraint< Real >:

Public Member Functions
	redConstraint (void)
void	value (ROL::Vector< Real > &c, const ROL::Vector< Real > &u, const ROL::Vector< Real > &z, Real &tol)
void	applyJacobian_1 (ROL::Vector< Real > &jv, const ROL::Vector< Real > &v, const ROL::Vector< Real > &u, const ROL::Vector< Real > &z, Real &tol)
void	applyJacobian_2 (ROL::Vector< Real > &jv, const ROL::Vector< Real > &v, const ROL::Vector< Real > &u, const ROL::Vector< Real > &z, Real &tol)
void	applyAdjointJacobian_1 (ROL::Vector< Real > &ajv, const ROL::Vector< Real > &v, const ROL::Vector< Real > &u, const ROL::Vector< Real > &z, Real &tol)
void	applyAdjointJacobian_2 (ROL::Vector< Real > &ajv, const ROL::Vector< Real > &v, const ROL::Vector< Real > &u, const ROL::Vector< Real > &z, Real &tol)
void	applyInverseJacobian_1 (ROL::Vector< Real > &ijv, const ROL::Vector< Real > &v, const ROL::Vector< Real > &u, const ROL::Vector< Real > &z, Real &tol)
void	applyInverseAdjointJacobian_1 (ROL::Vector< Real > &ijv, const ROL::Vector< Real > &v, const ROL::Vector< Real > &u, const ROL::Vector< Real > &z, Real &tol)
void	applyAdjointHessian_11 (ROL::Vector< Real > &ahwv, const ROL::Vector< Real > &w, const ROL::Vector< Real > &v, const ROL::Vector< Real > &u, const ROL::Vector< Real > &z, Real &tol)
void	applyAdjointHessian_12 (ROL::Vector< Real > &ahwv, const ROL::Vector< Real > &w, const ROL::Vector< Real > &v, const ROL::Vector< Real > &u, const ROL::Vector< Real > &z, Real &tol)
void	applyAdjointHessian_21 (ROL::Vector< Real > &ahwv, const ROL::Vector< Real > &w, const ROL::Vector< Real > &v, const ROL::Vector< Real > &u, const ROL::Vector< Real > &z, Real &tol)
void	applyAdjointHessian_22 (ROL::Vector< Real > &ahwv, const ROL::Vector< Real > &w, const ROL::Vector< Real > &v, const ROL::Vector< Real > &u, const ROL::Vector< Real > &z, Real &tol)
Public Member Functions inherited from Constraint_SimOpt< Real >
	Constraint_SimOpt ()
virtual void	update (const Vector< Real > &u, const Vector< Real > &z, 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	update (const Vector< Real > &u, const Vector< Real > &z, UpdateType type, int iter=-1)
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	update (const Vector< Real > &x, UpdateType type, int iter=-1)
virtual void	update_1 (const Vector< Real > &u, bool flag=true, int iter=-1)
	Update constraint functions with respect to Sim variable. x is the optimization variable, flag = true if optimization variable is changed, iter is the outer algorithm iterations count.
virtual void	update_1 (const Vector< Real > &u, UpdateType type, int iter=-1)
virtual void	update_2 (const Vector< Real > &z, bool flag=true, int iter=-1)
	Update constraint functions with respect to Opt variable. x is the optimization variable, flag = true if optimization variable is changed, iter is the outer algorithm iterations count.
virtual void	update_2 (const Vector< Real > &z, UpdateType type, int iter=-1)
virtual void	solve_update (const Vector< Real > &u, const Vector< Real > &z, UpdateType type, int iter=-1)
	Update SimOpt constraint during solve (disconnected from optimization updates).
virtual void	value (Vector< Real > &c, const Vector< Real > &u, const Vector< Real > &z, Real &tol)=0
	Evaluate the constraint operator \(c:\mathcal{U}\times\mathcal{Z} \rightarrow \mathcal{C}\) at \((u,z)\).
virtual void	value (Vector< Real > &c, const Vector< Real > &x, Real &tol)
virtual void	solve (Vector< Real > &c, Vector< Real > &u, const Vector< Real > &z, Real &tol)
	Given \(z\), solve \(c(u,z)=0\) for \(u\).
virtual void	setSolveParameters (ParameterList &parlist)
	Set solve parameters.
virtual void	applyJacobian_1 (Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
	Apply the partial constraint Jacobian at \((u,z)\), \(c_u(u,z) \in L(\mathcal{U}, \mathcal{C})\), to the vector \(v\).
virtual void	applyJacobian_2 (Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
	Apply the partial constraint Jacobian at \((u,z)\), \(c_z(u,z) \in L(\mathcal{Z}, \mathcal{C})\), to the vector \(v\).
virtual void	applyInverseJacobian_1 (Vector< Real > &ijv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
	Apply the inverse partial constraint Jacobian at \((u,z)\), \(c_u(u,z)^{-1} \in L(\mathcal{C}, \mathcal{U})\), to the vector \(v\).
virtual void	applyAdjointJacobian_1 (Vector< Real > &ajv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
	Apply the adjoint of the partial constraint Jacobian at \((u,z)\), \(c_u(u,z)^* \in L(\mathcal{C}^*, \mathcal{U}^*)\), to the vector \(v\). This is the primary interface.
virtual void	applyAdjointJacobian_1 (Vector< Real > &ajv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &dualv, Real &tol)
	Apply the adjoint of the partial constraint Jacobian at \((u,z)\), \(c_u(u,z)^* \in L(\mathcal{C}^*, \mathcal{U}^*)\), to the vector \(v\). This is the secondary interface, for use with dual spaces where the user does not define the dual() operation.
virtual void	applyAdjointJacobian_2 (Vector< Real > &ajv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
	Apply the adjoint of the partial constraint Jacobian at \((u,z)\), \(c_z(u,z)^* \in L(\mathcal{C}^*, \mathcal{Z}^*)\), to vector \(v\). This is the primary interface.
virtual void	applyAdjointJacobian_2 (Vector< Real > &ajv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &dualv, Real &tol)
	Apply the adjoint of the partial constraint Jacobian at \((u,z)\), \(c_z(u,z)^* \in L(\mathcal{C}^*, \mathcal{Z}^*)\), to vector \(v\). This is the secondary interface, for use with dual spaces where the user does not define the dual() operation.
virtual void	applyInverseAdjointJacobian_1 (Vector< Real > &iajv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
	Apply the inverse of the adjoint of the partial constraint Jacobian at \((u,z)\), \(c_u(u,z)^{-*} \in L(\mathcal{U}^*, \mathcal{C}^*)\), to the vector \(v\).
virtual void	applyAdjointHessian_11 (Vector< Real > &ahwv, const Vector< Real > &w, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
	Apply the simulation-space derivative of the adjoint of the constraint simulation-space Jacobian at \((u,z)\) to the vector \(w\) in the direction \(v\), according to \(v\mapsto c_{uu}(u,z)(v,\cdot)^*w\).
virtual void	applyAdjointHessian_12 (Vector< Real > &ahwv, const Vector< Real > &w, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
	Apply the optimization-space derivative of the adjoint of the constraint simulation-space Jacobian at \((u,z)\) to the vector \(w\) in the direction \(v\), according to \(v\mapsto c_{uz}(u,z)(v,\cdot)^*w\).
virtual void	applyAdjointHessian_21 (Vector< Real > &ahwv, const Vector< Real > &w, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
	Apply the simulation-space derivative of the adjoint of the constraint optimization-space Jacobian at \((u,z)\) to the vector \(w\) in the direction \(v\), according to \(v\mapsto c_{zu}(u,z)(v,\cdot)^*w\).
virtual void	applyAdjointHessian_22 (Vector< Real > &ahwv, const Vector< Real > &w, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
	Apply the optimization-space derivative of the adjoint of the constraint optimization-space Jacobian at \((u,z)\) to the vector \(w\) in the direction \(v\), according to \(v\mapsto c_{zz}(u,z)(v,\cdot)^*w\).
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\). In general, this preconditioner satisfies the following relationship:
virtual void	applyJacobian (Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
virtual void	applyAdjointJacobian (Vector< Real > &ajv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
virtual void	applyAdjointHessian (Vector< Real > &ahwv, const Vector< Real > &w, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
virtual Real	checkSolve (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &c, const bool printToStream=true, std::ostream &outStream=std::cout)
virtual Real	checkAdjointConsistencyJacobian_1 (const Vector< Real > &w, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, const bool printToStream=true, std::ostream &outStream=std::cout)
	Check the consistency of the Jacobian and its adjoint. This is the primary interface.
virtual Real	checkAdjointConsistencyJacobian_1 (const Vector< Real > &w, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &dualw, const Vector< Real > &dualv, const bool printToStream=true, std::ostream &outStream=std::cout)
	Check the consistency of the Jacobian and its adjoint. This is the secondary interface, for use with dual spaces where the user does not define the dual() operation.
virtual Real	checkAdjointConsistencyJacobian_2 (const Vector< Real > &w, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, const bool printToStream=true, std::ostream &outStream=std::cout)
	Check the consistency of the Jacobian and its adjoint. This is the primary interface.
virtual Real	checkAdjointConsistencyJacobian_2 (const Vector< Real > &w, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &dualw, const Vector< Real > &dualv, const bool printToStream=true, std::ostream &outStream=std::cout)
	Check the consistency of the Jacobian and its adjoint. This is the secondary interface, for use with dual spaces where the user does not define the dual() operation.
virtual Real	checkInverseJacobian_1 (const Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, const bool printToStream=true, std::ostream &outStream=std::cout)
virtual Real	checkInverseAdjointJacobian_1 (const Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, const bool printToStream=true, std::ostream &outStream=std::cout)
std::vector< std::vector< Real > >	checkApplyJacobian_1 (const Vector< Real > &u, const Vector< Real > &z, 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)
std::vector< std::vector< Real > >	checkApplyJacobian_1 (const Vector< Real > &u, const Vector< Real > &z, 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)
std::vector< std::vector< Real > >	checkApplyJacobian_2 (const Vector< Real > &u, const Vector< Real > &z, 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)
std::vector< std::vector< Real > >	checkApplyJacobian_2 (const Vector< Real > &u, const Vector< Real > &z, 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)
std::vector< std::vector< Real > >	checkApplyAdjointHessian_11 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &p, const Vector< Real > &v, const Vector< Real > &hv, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
std::vector< std::vector< Real > >	checkApplyAdjointHessian_11 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &p, const Vector< Real > &v, const Vector< Real > &hv, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
std::vector< std::vector< Real > >	checkApplyAdjointHessian_21 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &p, const Vector< Real > &v, const Vector< Real > &hv, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
	\( u\in U \), \( z\in Z \), \( p\in C^\ast \), \( v \in U \), \( hv \in U^\ast \)
std::vector< std::vector< Real > >	checkApplyAdjointHessian_21 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &p, const Vector< Real > &v, const Vector< Real > &hv, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
	\( u\in U \), \( z\in Z \), \( p\in C^\ast \), \( v \in U \), \( hv \in U^\ast \)
std::vector< std::vector< Real > >	checkApplyAdjointHessian_12 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &p, const Vector< Real > &v, const Vector< Real > &hv, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
	\( u\in U \), \( z\in Z \), \( p\in C^\ast \), \( v \in U \), \( hv \in U^\ast \)
std::vector< std::vector< Real > >	checkApplyAdjointHessian_12 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &p, const Vector< Real > &v, const Vector< Real > &hv, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
std::vector< std::vector< Real > >	checkApplyAdjointHessian_22 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &p, const Vector< Real > &v, const Vector< Real > &hv, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
std::vector< std::vector< Real > >	checkApplyAdjointHessian_22 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &p, const Vector< Real > &v, const Vector< Real > &hv, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)

Additional Inherited Members
Protected Attributes inherited from Constraint_SimOpt< Real >
Real	atol_
Real	rtol_
Real	stol_
Real	factor_
Real	decr_
int	maxit_
bool	print_
bool	zero_
int	solverType_
bool	firstSolve_

Detailed Description

template<class Real>
class redConstraint< Real >

Definition at line 194 of file function/test_10.cpp.

Constructor & Destructor Documentation

redConstraint()

template<class Real >

redConstraint< Real >::redConstraint ( void )

inline

Definition at line 196 of file function/test_10.cpp.

Member Function Documentation

value()

template<class Real >

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

inline

Definition at line 198 of file function/test_10.cpp.

applyJacobian_1()

template<class Real >

void redConstraint< Real >::applyJacobian_1 ( ROL::Vector< Real > & jv, const ROL::Vector< Real > & v, const ROL::Vector< Real > & u, const ROL::Vector< Real > & z, Real & tol )

inline

Definition at line 211 of file function/test_10.cpp.

applyJacobian_2()

template<class Real >

void redConstraint< Real >::applyJacobian_2 ( ROL::Vector< Real > & jv, const ROL::Vector< Real > & v, const ROL::Vector< Real > & u, const ROL::Vector< Real > & z, Real & tol )

inline

Definition at line 224 of file function/test_10.cpp.

applyAdjointJacobian_1()

template<class Real >

void redConstraint< Real >::applyAdjointJacobian_1 ( ROL::Vector< Real > & ajv, const ROL::Vector< Real > & v, const ROL::Vector< Real > & u, const ROL::Vector< Real > & z, Real & tol )

inline

Definition at line 239 of file function/test_10.cpp.

applyAdjointJacobian_2()

template<class Real >

void redConstraint< Real >::applyAdjointJacobian_2 ( ROL::Vector< Real > & ajv, const ROL::Vector< Real > & v, const ROL::Vector< Real > & u, const ROL::Vector< Real > & z, Real & tol )

inline

Definition at line 252 of file function/test_10.cpp.

applyInverseJacobian_1()

template<class Real >

void redConstraint< Real >::applyInverseJacobian_1 ( ROL::Vector< Real > & ijv, const ROL::Vector< Real > & v, const ROL::Vector< Real > & u, const ROL::Vector< Real > & z, Real & tol )

inline

Definition at line 267 of file function/test_10.cpp.

applyInverseAdjointJacobian_1()

template<class Real >

void redConstraint< Real >::applyInverseAdjointJacobian_1 ( ROL::Vector< Real > & ijv, const ROL::Vector< Real > & v, const ROL::Vector< Real > & u, const ROL::Vector< Real > & z, Real & tol )

inline

Definition at line 280 of file function/test_10.cpp.

applyAdjointHessian_11()

template<class Real >

void redConstraint< Real >::applyAdjointHessian_11 ( ROL::Vector< Real > & ahwv, const ROL::Vector< Real > & w, const ROL::Vector< Real > & v, const ROL::Vector< Real > & u, const ROL::Vector< Real > & z, Real & tol )

inline

Definition at line 293 of file function/test_10.cpp.

applyAdjointHessian_12()

template<class Real >

void redConstraint< Real >::applyAdjointHessian_12 ( ROL::Vector< Real > & ahwv, const ROL::Vector< Real > & w, const ROL::Vector< Real > & v, const ROL::Vector< Real > & u, const ROL::Vector< Real > & z, Real & tol )

inline

Definition at line 308 of file function/test_10.cpp.

applyAdjointHessian_21()

template<class Real >

void redConstraint< Real >::applyAdjointHessian_21 ( ROL::Vector< Real > & ahwv, const ROL::Vector< Real > & w, const ROL::Vector< Real > & v, const ROL::Vector< Real > & u, const ROL::Vector< Real > & z, Real & tol )

inline

Definition at line 323 of file function/test_10.cpp.

applyAdjointHessian_22()

template<class Real >

void redConstraint< Real >::applyAdjointHessian_22 ( ROL::Vector< Real > & ahwv, const ROL::Vector< Real > & w, const ROL::Vector< Real > & v, const ROL::Vector< Real > & u, const ROL::Vector< Real > & z, Real & tol )

inline

Definition at line 338 of file function/test_10.cpp.

---

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

• function/test_10.cpp