ROL
ROL::SerialConstraint< Real > Class Template Reference

Evaluates ROL::DynamicConstraint over a sequential set of time intervals. More...

#include <ROL_SerialConstraint.hpp>

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

Public Types

using size_type = typename std::vector<Real>::size_type
 
- Public Types inherited from ROL::SerialFunction< Real >
using size_type = typename std::vector<Real>::size_type
 

Public Member Functions

 SerialConstraint (const Ptr< DynamicConstraint< Real > > &con, const Vector< Real > &u_initial, const TimeStampsPtr< Real > &timeStampsPtr)
 
virtual void solve (Vector< Real > &c, Vector< Real > &u, const Vector< Real > &z, Real &tol) override
 
virtual void update (const Vector< Real > &u, const Vector< Real > &z, bool flag=true, int iter=-1) override
 
virtual void value (Vector< Real > &c, const Vector< Real > &u, const Vector< Real > &z, Real &tol) override
 
virtual void applyJacobian_1 (Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol) override
 
virtual void applyInverseJacobian_1 (Vector< Real > &ijv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol) override
 
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) override
 
void applyInverseAdjointJacobian_1 (Vector< Real > &iajv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol) override
 
virtual void applyJacobian_2 (Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol) override
 
virtual void applyAdjointJacobian_2 (Vector< Real > &ajv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol) override
 
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) override
 
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) override
 
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) override
 
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) override
 
- Public Member Functions inherited from ROL::SerialFunction< Real >
 SerialFunction (const Vector< Real > &u_initial, const TimeStampsPtr< Real > &timeStampsPtr)
 
size_type numTimeSteps () const
 
const Vector< Real > & getInitialCondition () const
 
void setInitialCondition (const Vector< Real > &u_initial)
 
const Vector< Real > & getZeroState () const
 
bool getSkipInitialCondition () const
 
void setSkipInitialCondition (bool skip)
 
TimeStampsPtr< Real > getTimeStampsPtr () const
 
void setTimeStampsPtr (const TimeStampsPtr< Real > &timeStampsPtr)
 
TimeStamp< Real > & getTimeStamp (size_type i)
 
const TimeStamp< Real > & getTimeStamp (size_type i) const
 
void setTimeStamp (size_type i, const TimeStamp< Real > &timeStamp)
 

Private Types

using PV = PartitionedVector<Real>
 

Private Attributes

Ptr< DynamicConstraint< Real > > con_
 

Additional Inherited Members

- Protected Member Functions inherited from ROL::SerialFunction< Real >
const TimeStamp< Real > & ts (size_type i) const
 
Ptr< Vector< Real > > clone (const Vector< Real > &x)
 

Detailed Description

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

Evaluates ROL::DynamicConstraint over a sequential set of time intervals.


Definition at line 64 of file ROL_SerialConstraint.hpp.

Member Typedef Documentation

◆ PV

template<typename Real>
using ROL::SerialConstraint< Real >::PV = PartitionedVector<Real>
private

Definition at line 68 of file ROL_SerialConstraint.hpp.

◆ size_type

template<typename Real>
using ROL::SerialConstraint< Real >::size_type = typename std::vector<Real>::size_type

Definition at line 76 of file ROL_SerialConstraint.hpp.

Constructor & Destructor Documentation

◆ SerialConstraint()

template<typename Real>
ROL::SerialConstraint< Real >::SerialConstraint ( const Ptr< DynamicConstraint< Real > > & con,
const Vector< Real > & u_initial,
const TimeStampsPtr< Real > & timeStampsPtr )
inline

Definition at line 82 of file ROL_SerialConstraint.hpp.

References con_, and ROL::SerialFunction< Real >::SerialFunction().

Member Function Documentation

◆ solve()

template<typename Real>
virtual void ROL::SerialConstraint< Real >::solve ( Vector< Real > & c,
Vector< Real > & u,
const Vector< Real > & z,
Real & tol )
inlineoverridevirtual

◆ update()

template<typename Real>
virtual void ROL::SerialConstraint< Real >::update ( const Vector< Real > & u,
const Vector< Real > & z,
bool flag = true,
int iter = -1 )
inlineoverridevirtual

◆ value()

template<typename Real>
virtual void ROL::SerialConstraint< Real >::value ( Vector< Real > & c,
const Vector< Real > & u,
const Vector< Real > & z,
Real & tol )
inlineoverridevirtual

◆ applyJacobian_1()

template<typename Real>
virtual void ROL::SerialConstraint< Real >::applyJacobian_1 ( Vector< Real > & jv,
const Vector< Real > & v,
const Vector< Real > & u,
const Vector< Real > & z,
Real & tol )
inlineoverridevirtual

◆ applyInverseJacobian_1()

template<typename Real>
virtual void ROL::SerialConstraint< Real >::applyInverseJacobian_1 ( Vector< Real > & ijv,
const Vector< Real > & v,
const Vector< Real > & u,
const Vector< Real > & z,
Real & tol )
inlineoverridevirtual

◆ applyAdjointJacobian_1()

template<typename Real>
virtual void ROL::SerialConstraint< Real >::applyAdjointJacobian_1 ( Vector< Real > & ajv,
const Vector< Real > & v,
const Vector< Real > & u,
const Vector< Real > & z,
const Vector< Real > & dualv,
Real & tol )
inlineoverridevirtual

◆ applyInverseAdjointJacobian_1()

template<typename Real>
void ROL::SerialConstraint< Real >::applyInverseAdjointJacobian_1 ( Vector< Real > & iajv,
const Vector< Real > & v,
const Vector< Real > & u,
const Vector< Real > & z,
Real & tol )
inlineoverride

◆ applyJacobian_2()

template<typename Real>
virtual void ROL::SerialConstraint< Real >::applyJacobian_2 ( Vector< Real > & jv,
const Vector< Real > & v,
const Vector< Real > & u,
const Vector< Real > & z,
Real & tol )
inlineoverridevirtual

◆ applyAdjointJacobian_2()

template<typename Real>
virtual void ROL::SerialConstraint< Real >::applyAdjointJacobian_2 ( Vector< Real > & ajv,
const Vector< Real > & v,
const Vector< Real > & u,
const Vector< Real > & z,
Real & tol )
inlineoverridevirtual

◆ applyAdjointHessian_11()

template<typename Real>
virtual void ROL::SerialConstraint< Real >::applyAdjointHessian_11 ( Vector< Real > & ahwv,
const Vector< Real > & w,
const Vector< Real > & v,
const Vector< Real > & u,
const Vector< Real > & z,
Real & tol )
inlineoverridevirtual

◆ applyAdjointHessian_12()

template<typename Real>
virtual void ROL::SerialConstraint< Real >::applyAdjointHessian_12 ( Vector< Real > & ahwv,
const Vector< Real > & w,
const Vector< Real > & v,
const Vector< Real > & u,
const Vector< Real > & z,
Real & tol )
inlineoverridevirtual

Definition at line 335 of file ROL_SerialConstraint.hpp.

◆ applyAdjointHessian_21()

template<typename Real>
virtual void ROL::SerialConstraint< Real >::applyAdjointHessian_21 ( Vector< Real > & ahwv,
const Vector< Real > & w,
const Vector< Real > & v,
const Vector< Real > & u,
const Vector< Real > & z,
Real & tol )
inlineoverridevirtual

Definition at line 344 of file ROL_SerialConstraint.hpp.

◆ applyAdjointHessian_22()

template<typename Real>
virtual void ROL::SerialConstraint< Real >::applyAdjointHessian_22 ( Vector< Real > & ahwv,
const Vector< Real > & w,
const Vector< Real > & v,
const Vector< Real > & u,
const Vector< Real > & z,
Real & tol )
inlineoverridevirtual

Member Data Documentation

◆ con_


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