ROL
ROL_LinearOperatorFromConstraint.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_LINEAROPERATOR_FROM_EQUALITYCONSTRAINT_H
45 #define ROL_LINEAROPERATOR_FROM_EQUALITYCONSTRAINT_H
46 
47 #include "ROL_Vector.hpp"
48 #include "ROL_Constraint.hpp"
49 #include "ROL_LinearOperator.hpp"
50 
60 namespace ROL {
61 
62 template <class Real>
64 private:
65  const ROL::Ptr<const Vector<Real> > x_;
66  ROL::Ptr<Constraint<Real> > con_;
67 
68 
69 public:
70 
71  LinearOperatorFromConstraint( const ROL::Ptr<const Vector<Real> > &x,
72  const ROL::Ptr<Constraint<Real> > &con ) :
73  x_(x), con_(con) {
74  }
75 
77 
78  virtual void apply( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
79  con_->applyJacobian(Hv,v,*x_,tol);
80  }
81 
82  // Not implemented for generic equality constraint
83  virtual void applyInverse( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
84  Hv.set(v);
85  }
86 
87 }; // class LinearOperator
88 
89 } // namespace ROL
90 
91 #endif
LinearOperatorFromConstraint(const ROL::Ptr< const Vector< Real > > &x, const ROL::Ptr< Constraint< Real > > &con)
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:80
const ROL::Ptr< const Vector< Real > > x_
A simple wrapper which allows application of constraint Jacobians through the LinearOperator interfac...
virtual void apply(Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
Apply linear operator.
Provides the interface to apply a linear operator.
virtual void applyInverse(Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
Apply inverse of linear operator.
virtual void set(const Vector &x)
Set where .
Definition: ROL_Vector.hpp:209
Defines the general constraint operator interface.