ROL
Public Member Functions | Private Member Functions | Private Attributes | List of all members
ROL::Reduced_Objective_SimOpt< Real > Class Template Reference

#include <ROL_Reduced_Objective_SimOpt.hpp>

+ Inheritance diagram for ROL::Reduced_Objective_SimOpt< Real >:

Public Member Functions

 Reduced_Objective_SimOpt (const Teuchos::RCP< Objective_SimOpt< Real > > &obj, const Teuchos::RCP< EqualityConstraint_SimOpt< Real > > &con, const Teuchos::RCP< Vector< Real > > &state, const Teuchos::RCP< Vector< Real > > &adjoint, const bool storage=true, const bool useFDhessVec=false)
 Constructor. More...
 
 Reduced_Objective_SimOpt (const Teuchos::RCP< Objective_SimOpt< Real > > &obj, const Teuchos::RCP< EqualityConstraint_SimOpt< Real > > &con, const Teuchos::RCP< Vector< Real > > &state, const Teuchos::RCP< Vector< Real > > &adjoint, const Teuchos::RCP< Vector< Real > > &dualstate, const Teuchos::RCP< Vector< Real > > &dualadjoint, const bool storage=true, const bool useFDhessVec=false)
 Secondary, general constructor for use with dual optimization vector spaces where the user does not define the dual() method. More...
 
void update (const Vector< Real > &x, bool flag=true, int iter=-1)
 Update the SimOpt objective function and equality constraint. More...
 
Real value (const Vector< Real > &x, Real &tol)
 Given \(z\in\mathcal{Z}\), evaluate the objective function \(\widehat{J}(z) = J(u(z),z)\) where \(u=u(z)\in\mathcal{U}\) solves \(e(u,z) = 0\). More...
 
void gradient (Vector< Real > &g, const Vector< Real > &x, Real &tol)
 Given \(z\in\mathcal{Z}\), evaluate the gradient of the objective function \(\nabla\widehat{J}(z) = J_z(z) + c_z(u,z)^*\lambda\) where \(\lambda=\lambda(u,z)\in\mathcal{C}^*\) solves \(e_u(u,z)^*\lambda+J_u(u,z) = 0\). More...
 
void hessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Given \(z\in\mathcal{Z}\), evaluate the Hessian of the objective function \(\nabla^2\widehat{J}(z)\) in the direction \(v\in\mathcal{Z}\). More...
 
virtual void precond (Vector< Real > &Pv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Apply a reduced Hessian preconditioner. More...
 
void setParameter (const std::vector< Real > &param)
 
- Public Member Functions inherited from ROL::Objective< Real >
virtual ~Objective ()
 
virtual Real dirDeriv (const Vector< Real > &x, const Vector< Real > &d, Real &tol)
 Compute directional derivative. More...
 
virtual void invHessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Apply inverse Hessian approximation to vector. More...
 
virtual std::vector< std::vector< Real > > checkGradient (const Vector< Real > &x, const Vector< Real > &d, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
 Finite-difference gradient check. More...
 
virtual std::vector< std::vector< Real > > checkGradient (const Vector< Real > &x, const Vector< Real > &g, const Vector< Real > &d, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
 Finite-difference gradient check. More...
 
virtual std::vector< std::vector< Real > > checkGradient (const Vector< Real > &x, const Vector< Real > &d, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
 Finite-difference gradient check with specified step sizes. More...
 
virtual std::vector< std::vector< Real > > checkGradient (const Vector< Real > &x, const Vector< Real > &g, const Vector< Real > &d, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
 Finite-difference gradient check with specified step sizes. More...
 
virtual std::vector< std::vector< Real > > checkHessVec (const Vector< Real > &x, const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
 Finite-difference Hessian-applied-to-vector check. More...
 
virtual std::vector< std::vector< Real > > checkHessVec (const Vector< Real > &x, const Vector< Real > &hv, const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
 Finite-difference Hessian-applied-to-vector check. More...
 
virtual std::vector< std::vector< Real > > checkHessVec (const Vector< Real > &x, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
 Finite-difference Hessian-applied-to-vector check with specified step sizes. More...
 
virtual std::vector< std::vector< Real > > checkHessVec (const Vector< Real > &x, const Vector< Real > &hv, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
 Finite-difference Hessian-applied-to-vector check with specified step sizes. More...
 
virtual std::vector< Real > checkHessSym (const Vector< Real > &x, const Vector< Real > &v, const Vector< Real > &w, const bool printToStream=true, std::ostream &outStream=std::cout)
 Hessian symmetry check. More...
 
virtual std::vector< Real > checkHessSym (const Vector< Real > &x, const Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &w, const bool printToStream=true, std::ostream &outStream=std::cout)
 Hessian symmetry check. More...
 

Private Member Functions

void solve_state_equation (const Vector< Real > &x, Real &tol, bool flag=true, int iter=-1)
 
void solve_adjoint_equation (const Vector< Real > &x, Real &tol)
 Given \((u,z)\in\mathcal{U}\times\mathcal{Z}\) which solves the state equation, solve the adjoint equation \(c_u(u,z)^*\lambda + J_u(u,z) = 0\) for \(\lambda=\lambda(u,z)\in\mathcal{C}^*\). More...
 
void solve_state_sensitivity (const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Given \((u,z)\in\mathcal{U}\times\mathcal{Z}\) which solves the state equation and a direction \(v\in\mathcal{Z}\), solve the state senstivity equation \(c_u(u,z)s + c_z(u,z)v = 0\) for \(s=u_z(z)v\in\mathcal{U}\). More...
 
void solve_adjoint_sensitivity (const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Given \((u,z)\in\mathcal{U}\times\mathcal{Z}\), the adjoint variable \(\lambda\in\mathcal{C}^*\), and a direction \(v\in\mathcal{Z}\), solve the adjoint sensitvity equation \(c_u(u,z)^*p + J_{uu}(u,z)s + J_{uz}(u,z)v + c_{uu}(u,z)(\cdot,s)^*\lambda + c_{zu}(u,z)(\cdot,v)^*\lambda = 0\) for \(p = \lambda_z(u(z),z)v\in\mathcal{C}^*\). More...
 

Private Attributes

Teuchos::RCP< Objective_SimOpt< Real > > obj_
 
Teuchos::RCP< EqualityConstraint_SimOpt< Real > > con_
 
Teuchos::RCP< Vector< Real > > state_
 
Teuchos::RCP< Vector< Real > > state_sens_
 
Teuchos::RCP< Vector< Real > > adjoint_
 
Teuchos::RCP< Vector< Real > > adjoint_sens_
 
Teuchos::RCP< Vector< Real > > dualstate_
 
Teuchos::RCP< Vector< Real > > dualstate1_
 
Teuchos::RCP< Vector< Real > > dualadjoint_
 
Teuchos::RCP< Vector< Real > > dualcontrol_
 
std::map< std::vector< Real >, Teuchos::RCP< Vector< Real > > > state_storage_
 
std::map< std::vector< Real >, Teuchos::RCP< Vector< Real > > > adjoint_storage_
 
bool storage_
 
bool useFDhessVec_
 
bool is_initialized_
 

Additional Inherited Members

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

Detailed Description

template<class Real>
class ROL::Reduced_Objective_SimOpt< Real >

Definition at line 54 of file ROL_Reduced_Objective_SimOpt.hpp.

Constructor & Destructor Documentation

◆ Reduced_Objective_SimOpt() [1/2]

template<class Real>
ROL::Reduced_Objective_SimOpt< Real >::Reduced_Objective_SimOpt ( const Teuchos::RCP< Objective_SimOpt< Real > > &  obj,
const Teuchos::RCP< EqualityConstraint_SimOpt< Real > > &  con,
const Teuchos::RCP< Vector< Real > > &  state,
const Teuchos::RCP< Vector< Real > > &  adjoint,
const bool  storage = true,
const bool  useFDhessVec = false 
)
inline

Constructor.

Parameters
[in]objis a pointer to a SimOpt objective function.
[in]conis a pointer to a SimOpt equality constraint.
[in]stateis a pointer to a state space vector, \(\mathcal{U}\).
[in]adjointis a pointer to a dual constraint space vector, \(\mathcal{C}^*\).
[in]storageis a flag whether or not to store computed states and adjoints.

Definition at line 170 of file ROL_Reduced_Objective_SimOpt.hpp.

References ROL::Reduced_Objective_SimOpt< Real >::adjoint_storage_, and ROL::Reduced_Objective_SimOpt< Real >::state_storage_.

◆ Reduced_Objective_SimOpt() [2/2]

template<class Real>
ROL::Reduced_Objective_SimOpt< Real >::Reduced_Objective_SimOpt ( const Teuchos::RCP< Objective_SimOpt< Real > > &  obj,
const Teuchos::RCP< EqualityConstraint_SimOpt< Real > > &  con,
const Teuchos::RCP< Vector< Real > > &  state,
const Teuchos::RCP< Vector< Real > > &  adjoint,
const Teuchos::RCP< Vector< Real > > &  dualstate,
const Teuchos::RCP< Vector< Real > > &  dualadjoint,
const bool  storage = true,
const bool  useFDhessVec = false 
)
inline

Secondary, general constructor for use with dual optimization vector spaces where the user does not define the dual() method.

Parameters
[in]objis a pointer to a SimOpt objective function.
[in]conis a pointer to a SimOpt equality constraint.
[in]stateis a pointer to a state space vector, \(\mathcal{U}\).
[in]adjointis a pointer to a dual constraint space vector, \(\mathcal{C}^*\).
[in]dualstateis a pointer to a dual state space vector, \(\mathcal{U}^*\).
[in]dualadjointis a pointer to a constraint space vector, \(\mathcal{C}\).
[in]storageis a flag whether or not to store computed states and adjoints.
[in]useFDhessVecis a flag whether or not to use a finite-difference Hessian approximation.

Definition at line 198 of file ROL_Reduced_Objective_SimOpt.hpp.

References ROL::Reduced_Objective_SimOpt< Real >::adjoint_storage_, and ROL::Reduced_Objective_SimOpt< Real >::state_storage_.

Member Function Documentation

◆ solve_state_equation()

template<class Real>
void ROL::Reduced_Objective_SimOpt< Real >::solve_state_equation ( const Vector< Real > &  x,
Real &  tol,
bool  flag = true,
int  iter = -1 
)
inlineprivate

◆ solve_adjoint_equation()

template<class Real>
void ROL::Reduced_Objective_SimOpt< Real >::solve_adjoint_equation ( const Vector< Real > &  x,
Real &  tol 
)
inlineprivate

◆ solve_state_sensitivity()

template<class Real>
void ROL::Reduced_Objective_SimOpt< Real >::solve_state_sensitivity ( const Vector< Real > &  v,
const Vector< Real > &  x,
Real &  tol 
)
inlineprivate

Given \((u,z)\in\mathcal{U}\times\mathcal{Z}\) which solves the state equation and a direction \(v\in\mathcal{Z}\), solve the state senstivity equation \(c_u(u,z)s + c_z(u,z)v = 0\) for \(s=u_z(z)v\in\mathcal{U}\).

Definition at line 132 of file ROL_Reduced_Objective_SimOpt.hpp.

References ROL::Reduced_Objective_SimOpt< Real >::con_, ROL::Reduced_Objective_SimOpt< Real >::dualadjoint_, ROL::Reduced_Objective_SimOpt< Real >::state_, and ROL::Reduced_Objective_SimOpt< Real >::state_sens_.

Referenced by ROL::Reduced_Objective_SimOpt< Real >::hessVec().

◆ solve_adjoint_sensitivity()

template<class Real>
void ROL::Reduced_Objective_SimOpt< Real >::solve_adjoint_sensitivity ( const Vector< Real > &  v,
const Vector< Real > &  x,
Real &  tol 
)
inlineprivate

Given \((u,z)\in\mathcal{U}\times\mathcal{Z}\), the adjoint variable \(\lambda\in\mathcal{C}^*\), and a direction \(v\in\mathcal{Z}\), solve the adjoint sensitvity equation \(c_u(u,z)^*p + J_{uu}(u,z)s + J_{uz}(u,z)v + c_{uu}(u,z)(\cdot,s)^*\lambda + c_{zu}(u,z)(\cdot,v)^*\lambda = 0\) for \(p = \lambda_z(u(z),z)v\in\mathcal{C}^*\).

Definition at line 146 of file ROL_Reduced_Objective_SimOpt.hpp.

References ROL::Reduced_Objective_SimOpt< Real >::adjoint_, ROL::Reduced_Objective_SimOpt< Real >::adjoint_sens_, ROL::Reduced_Objective_SimOpt< Real >::con_, ROL::Reduced_Objective_SimOpt< Real >::dualstate1_, ROL::Reduced_Objective_SimOpt< Real >::dualstate_, ROL::Reduced_Objective_SimOpt< Real >::obj_, ROL::Reduced_Objective_SimOpt< Real >::state_, and ROL::Reduced_Objective_SimOpt< Real >::state_sens_.

Referenced by ROL::Reduced_Objective_SimOpt< Real >::hessVec().

◆ update()

template<class Real>
void ROL::Reduced_Objective_SimOpt< Real >::update ( const Vector< Real > &  x,
bool  flag = true,
int  iter = -1 
)
inlinevirtual

Update the SimOpt objective function and equality constraint.

Reimplemented from ROL::Objective< Real >.

Definition at line 218 of file ROL_Reduced_Objective_SimOpt.hpp.

References ROL::Reduced_Objective_SimOpt< Real >::adjoint_storage_, and ROL::Reduced_Objective_SimOpt< Real >::state_storage_.

◆ value()

template<class Real>
Real ROL::Reduced_Objective_SimOpt< Real >::value ( const Vector< Real > &  x,
Real &  tol 
)
inlinevirtual

Given \(z\in\mathcal{Z}\), evaluate the objective function \(\widehat{J}(z) = J(u(z),z)\) where \(u=u(z)\in\mathcal{U}\) solves \(e(u,z) = 0\).

Implements ROL::Objective< Real >.

Definition at line 230 of file ROL_Reduced_Objective_SimOpt.hpp.

References ROL::Reduced_Objective_SimOpt< Real >::obj_, ROL::Reduced_Objective_SimOpt< Real >::solve_state_equation(), and ROL::Reduced_Objective_SimOpt< Real >::state_.

◆ gradient()

template<class Real>
void ROL::Reduced_Objective_SimOpt< Real >::gradient ( Vector< Real > &  g,
const Vector< Real > &  x,
Real &  tol 
)
inlinevirtual

◆ hessVec()

template<class Real>
void ROL::Reduced_Objective_SimOpt< Real >::hessVec ( Vector< Real > &  hv,
const Vector< Real > &  v,
const Vector< Real > &  x,
Real &  tol 
)
inlinevirtual

◆ precond()

template<class Real>
virtual void ROL::Reduced_Objective_SimOpt< Real >::precond ( Vector< Real > &  Pv,
const Vector< Real > &  v,
const Vector< Real > &  x,
Real &  tol 
)
inlinevirtual

Apply a reduced Hessian preconditioner.

Reimplemented from ROL::Objective< Real >.

Definition at line 293 of file ROL_Reduced_Objective_SimOpt.hpp.

References ROL::Vector< Real >::dual(), and ROL::Vector< Real >::set().

◆ setParameter()

template<class Real>
void ROL::Reduced_Objective_SimOpt< Real >::setParameter ( const std::vector< Real > &  param)
inlinevirtual

Member Data Documentation

◆ obj_

template<class Real>
Teuchos::RCP<Objective_SimOpt<Real> > ROL::Reduced_Objective_SimOpt< Real >::obj_
private

◆ con_

template<class Real>
Teuchos::RCP<EqualityConstraint_SimOpt<Real> > ROL::Reduced_Objective_SimOpt< Real >::con_
private

◆ state_

template<class Real>
Teuchos::RCP<Vector<Real> > ROL::Reduced_Objective_SimOpt< Real >::state_
private

◆ state_sens_

template<class Real>
Teuchos::RCP<Vector<Real> > ROL::Reduced_Objective_SimOpt< Real >::state_sens_
private

◆ adjoint_

template<class Real>
Teuchos::RCP<Vector<Real> > ROL::Reduced_Objective_SimOpt< Real >::adjoint_
private

◆ adjoint_sens_

template<class Real>
Teuchos::RCP<Vector<Real> > ROL::Reduced_Objective_SimOpt< Real >::adjoint_sens_
private

◆ dualstate_

template<class Real>
Teuchos::RCP<Vector<Real> > ROL::Reduced_Objective_SimOpt< Real >::dualstate_
private

◆ dualstate1_

template<class Real>
Teuchos::RCP<Vector<Real> > ROL::Reduced_Objective_SimOpt< Real >::dualstate1_
private

◆ dualadjoint_

template<class Real>
Teuchos::RCP<Vector<Real> > ROL::Reduced_Objective_SimOpt< Real >::dualadjoint_
private

◆ dualcontrol_

template<class Real>
Teuchos::RCP<Vector<Real> > ROL::Reduced_Objective_SimOpt< Real >::dualcontrol_
private

◆ state_storage_

template<class Real>
std::map<std::vector<Real>,Teuchos::RCP<Vector<Real> > > ROL::Reduced_Objective_SimOpt< Real >::state_storage_
private

◆ adjoint_storage_

template<class Real>
std::map<std::vector<Real>,Teuchos::RCP<Vector<Real> > > ROL::Reduced_Objective_SimOpt< Real >::adjoint_storage_
private

◆ storage_

template<class Real>
bool ROL::Reduced_Objective_SimOpt< Real >::storage_
private

◆ useFDhessVec_

template<class Real>
bool ROL::Reduced_Objective_SimOpt< Real >::useFDhessVec_
private

◆ is_initialized_

template<class Real>
bool ROL::Reduced_Objective_SimOpt< Real >::is_initialized_
private

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