ROL::DynamicObjective< Real > Class Template Reference

Defines the time-dependent objective function interface for simulation-based optimization. Computes time-local contributions of value, gradient, Hessian-vector product etc to a larger composite objective defined over the simulation time. In contrast to other objective classes Objective_TimeSimOpt has a default implementation of value which returns zero, as time-dependent simulation based optimization problems may have an objective value which depends only on the final state of the system. More...

#include <ROL_DynamicObjective.hpp>

Inheritance diagram for ROL::DynamicObjective< Real >:

Public Types
using	V = Vector<Real>
using	TS = TimeStamp<Real>
Public Types inherited from ROL::DynamicFunction< Real >
using	V = Vector<Real>
using	PV = PartitionedVector<Real>
using	TS = TimeStamp<Real>

Public Member Functions
	DynamicObjective ()
	DynamicObjective (std::initializer_list< std::string > zero_deriv_terms)
virtual	~DynamicObjective ()
virtual void	update (const V &uo, const V &un, const V &z, const TS &timeStamp)
virtual Real	value (const V &uo, const V &un, const V &z, const TS &timeStamp) const =0
virtual void	gradient_uo (V &g, const V &uo, const V &un, const V &z, const TS &timeStamp) const
virtual void	gradient_un (V &g, const V &uo, const V &un, const V &z, const TS &timeStamp) const
virtual void	gradient_z (V &g, const V &uo, const V &un, const V &z, const TS &timeStamp) const
virtual void	hessVec_uo_uo (V &hv, const V &v, const V &uo, const V &un, const V &z, const TS &timeStamp) const
virtual void	hessVec_uo_un (V &hv, const V &v, const V &uo, const V &un, const V &z, const TS &timeStamp) const
virtual void	hessVec_uo_z (V &hv, const V &v, const V &uo, const V &un, const V &z, const TS &timeStamp) const
virtual void	hessVec_un_uo (V &hv, const V &v, const V &uo, const V &un, const V &z, const TS &timeStamp) const
virtual void	hessVec_un_un (V &hv, const V &v, const V &uo, const V &un, const V &z, const TS &timeStamp) const
virtual void	hessVec_un_z (V &hv, const V &v, const V &uo, const V &un, const V &z, const TS &timeStamp) const
virtual void	hessVec_z_uo (V &hv, const V &v, const V &uo, const V &un, const V &z, const TS &timeStamp) const
virtual void	hessVec_z_un (V &hv, const V &v, const V &uo, const V &un, const V &z, const TS &timeStamp) const
virtual void	hessVec_z_z (V &hv, const V &v, const V &uo, const V &un, const V &z, const TS &timeStamp) const
Public Member Functions inherited from ROL::DynamicFunction< Real >
	DynamicFunction (std::initializer_list< std::string > zero_deriv_terms={})
virtual	~DynamicFunction ()
virtual void	update_uo (const V &x, const TS &ts)
virtual void	update_un (const V &x, const TS &ts)
virtual void	update_z (const V &x, const TS &ts)
bool	is_zero_derivative (const std::string &key)

Additional Inherited Members
Protected Member Functions inherited from ROL::DynamicFunction< Real >
VectorWorkspace< Real > &	getVectorWorkspace () const
PV &	partition (V &x) const
const PV &	partition (const V &x) const
V &	getNew (V &x) const
const V &	getNew (const V &x) const
V &	getOld (V &x) const
const V &	getOld (const V &x) const

Detailed Description

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

Defines the time-dependent objective function interface for simulation-based optimization. Computes time-local contributions of value, gradient, Hessian-vector product etc to a larger composite objective defined over the simulation time. In contrast to other objective classes Objective_TimeSimOpt has a default implementation of value which returns zero, as time-dependent simulation based optimization problems may have an objective value which depends only on the final state of the system.

Often in applications, the objective is separable into a state objective and a control objective so the state-control cross terms in the Hessian are zero.

A typical use case involves quadratic terms for the state and control, such that all of the diagonal blocks of the Hessian are nonzero and the off-diagonal blocks are zero.

Definition at line 38 of file ROL_DynamicObjective.hpp.

Member Typedef Documentation

V

template<typename Real>

using ROL::DynamicObjective< Real >::V = Vector<Real>

Definition at line 41 of file ROL_DynamicObjective.hpp.

TS

template<typename Real>

using ROL::DynamicObjective< Real >::TS = TimeStamp<Real>

Definition at line 42 of file ROL_DynamicObjective.hpp.

Constructor & Destructor Documentation

DynamicObjective() [1/2]

template<typename Real>

ROL::DynamicObjective< Real >::DynamicObjective ( )

inline

Definition at line 44 of file ROL_DynamicObjective.hpp.

References DynamicObjective().

Referenced by DynamicObjective().

DynamicObjective() [2/2]

template<typename Real>

ROL::DynamicObjective< Real >::DynamicObjective ( std::initializer_list< std::string > zero_deriv_terms )

inline

Definition at line 46 of file ROL_DynamicObjective.hpp.

References ROL::DynamicFunction< Real >::DynamicFunction().

~DynamicObjective()

template<typename Real>

virtual ROL::DynamicObjective< Real >::~DynamicObjective ( )

inlinevirtual

Definition at line 49 of file ROL_DynamicObjective.hpp.

Member Function Documentation

update()

template<typename Real>

virtual void ROL::DynamicObjective< Real >::update ( const V & uo, const V & un, const V & z, const TS & timeStamp )

inlinevirtual

Definition at line 51 of file ROL_DynamicObjective.hpp.

References ROL::DynamicFunction< Real >::update_un(), ROL::DynamicFunction< Real >::update_uo(), and ROL::DynamicFunction< Real >::update_z().

Referenced by ROL::details::DynamicObjective_CheckInterface< Real >::update_un(), ROL::details::DynamicObjective_CheckInterface< Real >::update_uo(), and ROL::details::DynamicObjective_CheckInterface< Real >::update_z().

value()

template<typename Real>

virtual Real ROL::DynamicObjective< Real >::value ( const V & uo, const V & un, const V & z, const TS & timeStamp ) const

pure virtual

Implemented in ROL::DynamicTrackingFEMObjective< Real >, and ROL::DynamicTrackingObjective< Real >.

Referenced by ROL::details::DynamicObjective_CheckInterface< Real >::value_un(), ROL::details::DynamicObjective_CheckInterface< Real >::value_uo(), and ROL::details::DynamicObjective_CheckInterface< Real >::value_z().

gradient_uo()

template<typename Real>

virtual void ROL::DynamicObjective< Real >::gradient_uo ( V & g, const V & uo, const V & un, const V & z, const TS & timeStamp ) const

inlinevirtual

Reimplemented in ROL::DynamicTrackingFEMObjective< Real >, and ROL::DynamicTrackingObjective< Real >.

Definition at line 66 of file ROL_DynamicObjective.hpp.

Referenced by ROL::details::DynamicObjective_CheckInterface< Real >::gradient_uo(), ROL::details::DynamicObjective_CheckInterface< Real >::gradient_uo_un(), ROL::details::DynamicObjective_CheckInterface< Real >::gradient_uo_uo(), and ROL::details::DynamicObjective_CheckInterface< Real >::gradient_uo_z().

gradient_un()

template<typename Real>

virtual void ROL::DynamicObjective< Real >::gradient_un ( V & g, const V & uo, const V & un, const V & z, const TS & timeStamp ) const

inlinevirtual

Reimplemented in ROL::DynamicTrackingFEMObjective< Real >, and ROL::DynamicTrackingObjective< Real >.

Definition at line 69 of file ROL_DynamicObjective.hpp.

Referenced by ROL::details::DynamicObjective_CheckInterface< Real >::gradient_un(), ROL::details::DynamicObjective_CheckInterface< Real >::gradient_un_un(), ROL::details::DynamicObjective_CheckInterface< Real >::gradient_un_uo(), and ROL::details::DynamicObjective_CheckInterface< Real >::gradient_un_z().

gradient_z()

template<typename Real>

virtual void ROL::DynamicObjective< Real >::gradient_z ( V & g, const V & uo, const V & un, const V & z, const TS & timeStamp ) const

inlinevirtual

Reimplemented in ROL::DynamicTrackingFEMObjective< Real >, and ROL::DynamicTrackingObjective< Real >.

Definition at line 72 of file ROL_DynamicObjective.hpp.

Referenced by ROL::details::DynamicObjective_CheckInterface< Real >::gradient_z(), ROL::details::DynamicObjective_CheckInterface< Real >::gradient_z_un(), ROL::details::DynamicObjective_CheckInterface< Real >::gradient_z_uo(), and ROL::details::DynamicObjective_CheckInterface< Real >::gradient_z_z().

hessVec_uo_uo()

template<typename Real>

virtual void ROL::DynamicObjective< Real >::hessVec_uo_uo ( V & hv, const V & v, const V & uo, const V & un, const V & z, const TS & timeStamp ) const

inlinevirtual

Reimplemented in ROL::DynamicTrackingFEMObjective< Real >, and ROL::DynamicTrackingObjective< Real >.

Definition at line 77 of file ROL_DynamicObjective.hpp.

Referenced by ROL::details::DynamicObjective_CheckInterface< Real >::hessVec_uo_uo().

hessVec_uo_un()

template<typename Real>

virtual void ROL::DynamicObjective< Real >::hessVec_uo_un ( V & hv, const V & v, const V & uo, const V & un, const V & z, const TS & timeStamp ) const

inlinevirtual

Reimplemented in ROL::DynamicTrackingFEMObjective< Real >, and ROL::DynamicTrackingObjective< Real >.

Definition at line 80 of file ROL_DynamicObjective.hpp.

Referenced by ROL::details::DynamicObjective_CheckInterface< Real >::hessVec_uo_un().

hessVec_uo_z()

template<typename Real>

virtual void ROL::DynamicObjective< Real >::hessVec_uo_z ( V & hv, const V & v, const V & uo, const V & un, const V & z, const TS & timeStamp ) const

inlinevirtual

Reimplemented in ROL::DynamicTrackingFEMObjective< Real >, and ROL::DynamicTrackingObjective< Real >.

Definition at line 83 of file ROL_DynamicObjective.hpp.

Referenced by ROL::details::DynamicObjective_CheckInterface< Real >::hessVec_uo_z().

hessVec_un_uo()

template<typename Real>

virtual void ROL::DynamicObjective< Real >::hessVec_un_uo ( V & hv, const V & v, const V & uo, const V & un, const V & z, const TS & timeStamp ) const

inlinevirtual

Reimplemented in ROL::DynamicTrackingFEMObjective< Real >, and ROL::DynamicTrackingObjective< Real >.

Definition at line 87 of file ROL_DynamicObjective.hpp.

Referenced by ROL::details::DynamicObjective_CheckInterface< Real >::hessVec_un_uo().

hessVec_un_un()

template<typename Real>

virtual void ROL::DynamicObjective< Real >::hessVec_un_un ( V & hv, const V & v, const V & uo, const V & un, const V & z, const TS & timeStamp ) const

inlinevirtual

Reimplemented in ROL::DynamicTrackingFEMObjective< Real >, and ROL::DynamicTrackingObjective< Real >.

Definition at line 90 of file ROL_DynamicObjective.hpp.

Referenced by ROL::details::DynamicObjective_CheckInterface< Real >::hessVec_un_un().

hessVec_un_z()

template<typename Real>

virtual void ROL::DynamicObjective< Real >::hessVec_un_z ( V & hv, const V & v, const V & uo, const V & un, const V & z, const TS & timeStamp ) const

inlinevirtual

Reimplemented in ROL::DynamicTrackingFEMObjective< Real >, and ROL::DynamicTrackingObjective< Real >.

Definition at line 93 of file ROL_DynamicObjective.hpp.

Referenced by ROL::details::DynamicObjective_CheckInterface< Real >::hessVec_un_z().

hessVec_z_uo()

template<typename Real>

virtual void ROL::DynamicObjective< Real >::hessVec_z_uo ( V & hv, const V & v, const V & uo, const V & un, const V & z, const TS & timeStamp ) const

inlinevirtual

Reimplemented in ROL::DynamicTrackingFEMObjective< Real >, and ROL::DynamicTrackingObjective< Real >.

Definition at line 97 of file ROL_DynamicObjective.hpp.

Referenced by ROL::details::DynamicObjective_CheckInterface< Real >::hessVec_z_uo().

hessVec_z_un()

template<typename Real>

virtual void ROL::DynamicObjective< Real >::hessVec_z_un ( V & hv, const V & v, const V & uo, const V & un, const V & z, const TS & timeStamp ) const

inlinevirtual

Reimplemented in ROL::DynamicTrackingFEMObjective< Real >, and ROL::DynamicTrackingObjective< Real >.

Definition at line 100 of file ROL_DynamicObjective.hpp.

Referenced by ROL::details::DynamicObjective_CheckInterface< Real >::hessVec_z_un().

hessVec_z_z()

template<typename Real>

virtual void ROL::DynamicObjective< Real >::hessVec_z_z ( V & hv, const V & v, const V & uo, const V & un, const V & z, const TS & timeStamp ) const

inlinevirtual

Reimplemented in ROL::DynamicTrackingFEMObjective< Real >, and ROL::DynamicTrackingObjective< Real >.

Definition at line 103 of file ROL_DynamicObjective.hpp.

Referenced by ROL::details::DynamicObjective_CheckInterface< Real >::hessVec_z_z().

---

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

• ROL_DynamicObjective.hpp