ROL::DynamicTrackingObjective< Real > Class Template Reference

Defines the time-local contribution to a quadratic tracking objective. More...

#include <ROL_DynamicTrackingObjective.hpp>

Inheritance diagram for ROL::DynamicTrackingObjective< Real >:

Public Types
using	V = Vector<Real>
using	TS = TimeStamp<Real>
using	size_type = typename PartitionedVector<Real>::size_type
Public Types inherited from ROL::DynamicObjective< Real >
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
	DynamicTrackingObjective (const Ptr< PartitionedVector< Real > > &target, Real alpha=0.0)
virtual	~DynamicTrackingObjective ()
virtual Real	value (const V &uo, const V &un, const V &z, const TS &timeStamp) const override
virtual void	gradient_uo (V &g, const V &uo, const V &un, const V &z, const TS &timeStamp) const override
virtual void	gradient_un (V &g, const V &uo, const V &un, const V &z, const TS &timeStamp) const override
virtual void	gradient_z (V &g, const V &uo, const V &un, const V &z, const TS &timeStamp) const override
virtual void	hessVec_uo_uo (V &hv, const V &v, const V &uo, const V &un, const V &z, const TS &timeStamp) const override
virtual void	hessVec_uo_un (V &hv, const V &v, const V &uo, const V &un, const V &z, const TS &timeStamp) const override
virtual void	hessVec_uo_z (V &hv, const V &v, const V &uo, const V &un, const V &z, const TS &timeStamp) const override
virtual void	hessVec_un_uo (V &hv, const V &v, const V &uo, const V &un, const V &z, const TS &timeStamp) const override
virtual void	hessVec_un_un (V &hv, const V &v, const V &uo, const V &un, const V &z, const TS &timeStamp) const override
virtual void	hessVec_un_z (V &hv, const V &v, const V &uo, const V &un, const V &z, const TS &timeStamp) const override
virtual void	hessVec_z_uo (V &hv, const V &v, const V &uo, const V &un, const V &z, const TS &timeStamp) const override
virtual void	hessVec_z_un (V &hv, const V &v, const V &uo, const V &un, const V &z, const TS &timeStamp) const override
virtual void	hessVec_z_z (V &hv, const V &v, const V &uo, const V &un, const V &z, const TS &timeStamp) const override
Public Member Functions inherited from ROL::DynamicObjective< Real >
	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)
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)

Private Attributes
Ptr< PartitionedVector< Real > >	target_
size_type	Nt_
Real	alpha_
VectorWorkspace< Real >	workspace_

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::DynamicTrackingObjective< Real >

Defines the time-local contribution to a quadratic tracking objective.

\[ f_k(u,z) = \frac{1}{2} \int\limits_{t_{k-1}}^{t_k} \| u(t)-\tilde u(t)\|^2 + \alpha \|z(t)^2\,\mathrm{d}t \]

Currently approximates the integral with the trapezoidal rule.

Definition at line 34 of file ROL_DynamicTrackingObjective.hpp.

Member Typedef Documentation

V

template<typename Real>

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

Definition at line 37 of file ROL_DynamicTrackingObjective.hpp.

TS

template<typename Real>

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

Definition at line 38 of file ROL_DynamicTrackingObjective.hpp.

size_type

template<typename Real>

using ROL::DynamicTrackingObjective< Real >::size_type = typename PartitionedVector<Real>::size_type

Definition at line 39 of file ROL_DynamicTrackingObjective.hpp.

Constructor & Destructor Documentation

DynamicTrackingObjective()

template<typename Real>

ROL::DynamicTrackingObjective< Real >::DynamicTrackingObjective ( const Ptr< PartitionedVector< Real > > & target, Real alpha = 0.0 )

inline

Definition at line 52 of file ROL_DynamicTrackingObjective.hpp.

References alpha_, Nt_, and target_.

~DynamicTrackingObjective()

template<typename Real>

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

inlinevirtual

Definition at line 55 of file ROL_DynamicTrackingObjective.hpp.

Member Function Documentation

value()

template<typename Real>

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

inlineoverridevirtual

Implements ROL::DynamicObjective< Real >.

Definition at line 57 of file ROL_DynamicTrackingObjective.hpp.

References alpha_, ROL::Vector< Real >::dot(), ROL::TimeStamp< Real >::k, ROL::TimeStamp< Real >::t, target_, and workspace_.

gradient_uo()

template<typename Real>

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

inlineoverridevirtual

Reimplemented from ROL::DynamicObjective< Real >.

Definition at line 81 of file ROL_DynamicTrackingObjective.hpp.

References ROL::Vector< Real >::axpy(), ROL::TimeStamp< Real >::k, ROL::Vector< Real >::scale(), ROL::Vector< Real >::set(), ROL::TimeStamp< Real >::t, target_, and ROL::Vector< Real >::zero().

gradient_un()

template<typename Real>

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

inlineoverridevirtual

Reimplemented from ROL::DynamicObjective< Real >.

Definition at line 92 of file ROL_DynamicTrackingObjective.hpp.

References ROL::Vector< Real >::axpy(), ROL::TimeStamp< Real >::k, ROL::Vector< Real >::scale(), ROL::Vector< Real >::set(), ROL::TimeStamp< Real >::t, and target_.

gradient_z()

template<typename Real>

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

inlineoverridevirtual

Reimplemented from ROL::DynamicObjective< Real >.

Definition at line 100 of file ROL_DynamicTrackingObjective.hpp.

References alpha_, ROL::Vector< Real >::scale(), ROL::Vector< Real >::set(), and ROL::TimeStamp< Real >::t.

hessVec_uo_uo()

template<typename Real>

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

inlineoverridevirtual

Reimplemented from ROL::DynamicObjective< Real >.

Definition at line 109 of file ROL_DynamicTrackingObjective.hpp.

References ROL::TimeStamp< Real >::k, ROL::Vector< Real >::scale(), ROL::Vector< Real >::set(), ROL::TimeStamp< Real >::t, and ROL::Vector< Real >::zero().

hessVec_uo_un()

template<typename Real>

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

inlineoverridevirtual

Reimplemented from ROL::DynamicObjective< Real >.

Definition at line 119 of file ROL_DynamicTrackingObjective.hpp.

References ROL::Vector< Real >::zero().

hessVec_uo_z()

template<typename Real>

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

inlineoverridevirtual

Reimplemented from ROL::DynamicObjective< Real >.

Definition at line 124 of file ROL_DynamicTrackingObjective.hpp.

References ROL::Vector< Real >::zero().

hessVec_un_uo()

template<typename Real>

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

inlineoverridevirtual

Reimplemented from ROL::DynamicObjective< Real >.

Definition at line 129 of file ROL_DynamicTrackingObjective.hpp.

References ROL::Vector< Real >::zero().

hessVec_un_un()

template<typename Real>

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

inlineoverridevirtual

Reimplemented from ROL::DynamicObjective< Real >.

Definition at line 134 of file ROL_DynamicTrackingObjective.hpp.

References ROL::Vector< Real >::scale(), ROL::Vector< Real >::set(), and ROL::TimeStamp< Real >::t.

hessVec_un_z()

template<typename Real>

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

inlineoverridevirtual

Reimplemented from ROL::DynamicObjective< Real >.

Definition at line 141 of file ROL_DynamicTrackingObjective.hpp.

References ROL::Vector< Real >::zero().

hessVec_z_uo()

template<typename Real>

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

inlineoverridevirtual

Reimplemented from ROL::DynamicObjective< Real >.

Definition at line 146 of file ROL_DynamicTrackingObjective.hpp.

References ROL::Vector< Real >::zero().

hessVec_z_un()

template<typename Real>

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

inlineoverridevirtual

Reimplemented from ROL::DynamicObjective< Real >.

Definition at line 151 of file ROL_DynamicTrackingObjective.hpp.

References ROL::Vector< Real >::zero().

hessVec_z_z()

template<typename Real>

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

inlineoverridevirtual

Reimplemented from ROL::DynamicObjective< Real >.

Definition at line 156 of file ROL_DynamicTrackingObjective.hpp.

References alpha_, ROL::Vector< Real >::scale(), ROL::Vector< Real >::set(), and ROL::TimeStamp< Real >::t.

Member Data Documentation

target_

template<typename Real>

Ptr<PartitionedVector<Real> > ROL::DynamicTrackingObjective< Real >::target_

private

Definition at line 43 of file ROL_DynamicTrackingObjective.hpp.

Referenced by DynamicTrackingObjective(), gradient_un(), gradient_uo(), and value().

Nt_

template<typename Real>

size_type ROL::DynamicTrackingObjective< Real >::Nt_

private

Definition at line 45 of file ROL_DynamicTrackingObjective.hpp.

Referenced by DynamicTrackingObjective().

alpha_

template<typename Real>

Real ROL::DynamicTrackingObjective< Real >::alpha_

private

Definition at line 46 of file ROL_DynamicTrackingObjective.hpp.

Referenced by DynamicTrackingObjective(), gradient_z(), hessVec_z_z(), and value().

workspace_

template<typename Real>

VectorWorkspace<Real> ROL::DynamicTrackingObjective< Real >::workspace_

mutableprivate

Definition at line 48 of file ROL_DynamicTrackingObjective.hpp.

Referenced by value().

---

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

• ROL_DynamicTrackingObjective.hpp