ROL
ROL_Constraint_State.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_STATE_H
45 #define ROL_CONSTRAINT_STATE_H
46 
48 
49 namespace ROL {
50 
51 template <class Real>
52 class Constraint_State : public Constraint<Real> {
53 private:
54  const ROL::Ptr<Constraint_SimOpt<Real> > con_;
55  const ROL::Ptr<const Vector<Real> > z_;
56 
57 public:
59  const ROL::Ptr<const Vector<Real> > &z) : con_(con), z_(z) {}
60 
61  void value(Vector<Real> &c,const Vector<Real> &u,Real &tol) {
62  con_->value(c,u,*z_,tol);
63  }
64 
65  void applyJacobian(Vector<Real> &jv,const Vector<Real> &v,const Vector<Real> &u,Real &tol) {
66  con_->applyJacobian_1(jv,v,u,*z_,tol);
67  }
68 
69  void applyAdjointJacobian(Vector<Real> &ajv,const Vector<Real> &v,const Vector<Real> &u,Real &tol) {
70  con_->applyAdjointJacobian_1(ajv,v,u,*z_,tol);
71  }
72 
73  void applyAdjointHessian(Vector<Real> &ahwv,const Vector<Real> &w,const Vector<Real> &v,const Vector<Real> &u,Real &tol) {
74  con_->applyAdjointHessian_11(ahwv,w,v,u,*z_,tol);
75  }
76 
77  void update( const Vector<Real> &u, bool flag = true, int iter = -1 ) {
78  con_->update_1(u,flag,iter);
79  //con_->update(u,*z_,flag,iter);
80  }
81 
82  void applyPreconditioner(Vector<Real> &pv,const Vector<Real> &v,const Vector<Real> &u,const Vector<Real> &g,Real &tol) {
83  ROL::Ptr<Vector<Real> > ijv = u.clone();
84  con_->applyInverseJacobian_1(*ijv,v,u,*z_,tol);
85  con_->applyInverseAdjointJacobian_1(pv,ijv->dual(),u,*z_,tol);
86  }
87 
88  // Definitions for parametrized (stochastic) equality constraints
89  void setParameter(const std::vector<Real> &param) {
90  con_->setParameter(param);
92  }
93 
94 }; // class Constraint_State
95 
96 } // namespace ROL
97 
98 #endif
virtual const Vector & dual() const
Return dual representation of , for example, the result of applying a Riesz map, or change of basis...
Definition: ROL_Vector.hpp:226
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 .
virtual ROL::Ptr< Vector > clone() const =0
Clone to make a new (uninitialized) vector.
const ROL::Ptr< const Vector< Real > > z_
void applyJacobian(Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &u, Real &tol)
Apply the constraint Jacobian at , , to vector .
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 linear algebra or vector space interface.
Definition: ROL_Vector.hpp:80
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 ...
void setParameter(const std::vector< Real > &param)
void value(Vector< Real > &c, const Vector< Real > &u, Real &tol)
Evaluate the constraint operator at .
virtual void setParameter(const std::vector< Real > &param)
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 constraint operator interface for simulation-based optimization.
Constraint_State(const ROL::Ptr< Constraint_SimOpt< Real > > &con, const ROL::Ptr< const Vector< Real > > &z)
Defines the general constraint operator interface.
const ROL::Ptr< Constraint_SimOpt< Real > > con_