ROL
Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
ROL::SerialConstraint< Real > Class Template Reference
User Interface » Functional Interface

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

Definition at line 88 of file ROL_SerialConstraint.hpp.

References con_, ROL::SerialFunction< Real >::getInitialCondition(), ROL::SerialFunction< Real >::getSkipInitialCondition(), ROL::SerialFunction< Real >::numTimeSteps(), ROL::partition(), and ROL::SerialFunction< Real >::ts().

◆ 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

Definition at line 105 of file ROL_SerialConstraint.hpp.

References con_, ROL::SerialFunction< Real >::getInitialCondition(), ROL::SerialFunction< Real >::getSkipInitialCondition(), ROL::SerialFunction< Real >::numTimeSteps(), ROL::partition(), and ROL::SerialFunction< Real >::ts().

◆ value()

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

Definition at line 118 of file ROL_SerialConstraint.hpp.

References con_, ROL::SerialFunction< Real >::getInitialCondition(), ROL::SerialFunction< Real >::getSkipInitialCondition(), ROL::SerialFunction< Real >::numTimeSteps(), ROL::partition(), and ROL::SerialFunction< Real >::ts().

◆ 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

Definition at line 136 of file ROL_SerialConstraint.hpp.

References ROL::SerialFunction< Real >::clone(), con_, ROL::SerialFunction< Real >::getSkipInitialCondition(), ROL::SerialFunction< Real >::getZeroState(), ROL::SerialFunction< Real >::numTimeSteps(), ROL::partition(), and ROL::SerialFunction< Real >::ts().

◆ 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

Definition at line 162 of file ROL_SerialConstraint.hpp.

References ROL::SerialFunction< Real >::clone(), con_, ROL::SerialFunction< Real >::getSkipInitialCondition(), ROL::SerialFunction< Real >::getZeroState(), ROL::SerialFunction< Real >::numTimeSteps(), ROL::partition(), and ROL::SerialFunction< Real >::ts().

◆ 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

Definition at line 191 of file ROL_SerialConstraint.hpp.

References ROL::SerialFunction< Real >::clone(), con_, ROL::SerialFunction< Real >::getSkipInitialCondition(), ROL::SerialFunction< Real >::getZeroState(), ROL::SerialFunction< Real >::numTimeSteps(), ROL::partition(), and ROL::SerialFunction< Real >::ts().

◆ 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

Definition at line 217 of file ROL_SerialConstraint.hpp.

References ROL::SerialFunction< Real >::clone(), con_, ROL::SerialFunction< Real >::getSkipInitialCondition(), ROL::SerialFunction< Real >::getZeroState(), ROL::SerialFunction< Real >::numTimeSteps(), ROL::partition(), and ROL::SerialFunction< Real >::ts().

◆ 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

Definition at line 255 of file ROL_SerialConstraint.hpp.

References con_, ROL::SerialFunction< Real >::getInitialCondition(), ROL::SerialFunction< Real >::getSkipInitialCondition(), ROL::SerialFunction< Real >::numTimeSteps(), ROL::partition(), and ROL::SerialFunction< Real >::ts().

◆ 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

Definition at line 274 of file ROL_SerialConstraint.hpp.

References con_, ROL::SerialFunction< Real >::getInitialCondition(), ROL::SerialFunction< Real >::getSkipInitialCondition(), ROL::SerialFunction< Real >::numTimeSteps(), ROL::partition(), and ROL::SerialFunction< Real >::ts().

◆ 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

Definition at line 293 of file ROL_SerialConstraint.hpp.

References ROL::SerialFunction< Real >::clone(), con_, ROL::SerialFunction< Real >::getSkipInitialCondition(), ROL::SerialFunction< Real >::getZeroState(), ROL::SerialFunction< Real >::numTimeSteps(), ROL::partition(), and ROL::SerialFunction< Real >::ts().

◆ 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

Definition at line 352 of file ROL_SerialConstraint.hpp.

References con_, ROL::SerialFunction< Real >::getInitialCondition(), ROL::SerialFunction< Real >::numTimeSteps(), ROL::partition(), and ROL::SerialFunction< Real >::ts().

Member Data Documentation

◆ con_

template<typename Real>
Ptr<DynamicConstraint<Real> > ROL::SerialConstraint< Real >::con_
private

Definition at line 72 of file ROL_SerialConstraint.hpp.

Referenced by applyAdjointHessian_11(), applyAdjointHessian_22(), applyAdjointJacobian_1(), applyAdjointJacobian_2(), applyInverseAdjointJacobian_1(), applyInverseJacobian_1(), applyJacobian_1(), applyJacobian_2(), SerialConstraint(), solve(), update(), and value().

The documentation for this class was generated from the following file:
Generated by doxygen 1.17.0