ROL
ROL_Constraint_DynamicState.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ************************************************************************
3 //
4 // Rapid Optimization Library (ROL) Package
5 // Copyright (2014) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact lead developers:
38 // Drew Kouri (dpkouri@sandia.gov) and
39 // Denis Ridzal (dridzal@sandia.gov)
40 //
41 // ************************************************************************
42 // @HEADER
43 
44 #ifndef ROL_CONSTRAINT_DYNAMICSTATE_H
45 #define ROL_CONSTRAINT_DYNAMICSTATE_H
46 
48 #include "ROL_Constraint.hpp"
49 
50 namespace ROL {
51 
52 template <class Real>
53 class Constraint_DynamicState : public Constraint<Real> {
54 private:
55  const Ptr<DynamicConstraint<Real>> con_;
56  const Ptr<const Vector<Real>> uo_;
57  const Ptr<const Vector<Real>> z_;
58  const Ptr<const TimeStamp<Real>> ts_;
59 
60  Ptr<Vector<Real>> ijv_;
61  bool isInit_;
62 
63 public:
65  const Ptr<const Vector<Real>> &uo,
66  const Ptr<const Vector<Real>> &z,
67  const Ptr<const TimeStamp<Real>> &ts)
68  : con_(con), uo_(uo), z_(z), ts_(ts), isInit_(false) {}
69 
70  void value(Vector<Real> &c,const Vector<Real> &u,Real &tol) {
71  con_->value(c,*uo_,u,*z_,*ts_);
72  }
73 
74  void applyJacobian(Vector<Real> &jv,const Vector<Real> &v,const Vector<Real> &u,Real &tol) {
75  con_->applyJacobian_un(jv,v,*uo_,u,*z_,*ts_);
76  }
77 
78  void applyAdjointJacobian(Vector<Real> &ajv,const Vector<Real> &v,const Vector<Real> &u,Real &tol) {
79  con_->applyAdjointJacobian_un(ajv,v,*uo_,u,*z_,*ts_);
80  }
81 
82  void applyAdjointHessian(Vector<Real> &ahwv,const Vector<Real> &w,const Vector<Real> &v,const Vector<Real> &u,Real &tol) {
83  con_->applyAdjointHessian_un_un(ahwv,w,v,*uo_,u,*z_,*ts_);
84  }
85 
86  void update( const Vector<Real> &u, bool flag = true, int iter = -1 ) {
87  //con_->update_un(u,*ts_);
88  con_->update(*uo_,u,*z_,*ts_);
89  }
90 
91  void applyPreconditioner(Vector<Real> &pv,const Vector<Real> &v,const Vector<Real> &u,const Vector<Real> &g,Real &tol) {
92  if (!isInit_) {
93  ijv_ = u.clone();
94  isInit_ = true;
95  }
96  con_->applyInverseJacobian_un(*ijv_,v,*uo_,u,*z_,*ts_);
97  con_->applyInverseAdjointJacobian_un(pv,ijv_->dual(),*uo_,u,*z_,*ts_);
98  }
99 
100  // Definitions for parametrized (stochastic) equality constraints
101  //void setParameter(const std::vector<Real> &param) {
102  // con_->setParameter(param);
103  // Constraint<Real>::setParameter(param);
104  //}
105 
106 }; // class Constraint_State
107 
108 } // namespace ROL
109 
110 #endif
const Ptr< DynamicConstraint< Real > > con_
virtual ROL::Ptr< Vector > clone() const =0
Clone to make a new (uninitialized) vector.
void update(const Vector< Real > &u, bool flag=true, int iter=-1)
Update constraint functions. x is the optimization variable, flag = true if optimization variable is ...
Defines the time-dependent constraint operator interface for simulation-based optimization.
void value(Vector< Real > &c, const Vector< Real > &u, Real &tol)
Evaluate the constraint operator at .
void applyJacobian(Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &u, Real &tol)
Apply the constraint Jacobian at , , to vector .
Contains local time step information.
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:80
const Ptr< const Vector< Real > > z_
void applyAdjointHessian(Vector< Real > &ahwv, const Vector< Real > &w, const Vector< Real > &v, const Vector< Real > &u, Real &tol)
Apply the derivative of the adjoint of the constraint Jacobian at to vector in direction ...
Constraint_DynamicState(const Ptr< DynamicConstraint< Real >> &con, const Ptr< const Vector< Real >> &uo, const Ptr< const Vector< Real >> &z, const Ptr< const TimeStamp< Real >> &ts)
const Ptr< const TimeStamp< Real > > ts_
void applyAdjointJacobian(Vector< Real > &ajv, const Vector< Real > &v, const Vector< Real > &u, Real &tol)
Apply the adjoint of the the constraint Jacobian at , , to vector .
const Ptr< const Vector< Real > > uo_
void applyPreconditioner(Vector< Real > &pv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &g, Real &tol)
Apply a constraint preconditioner at , , to vector . Ideally, this preconditioner satisfies the follo...
Defines the general constraint operator interface.