ROL
ROL_NullSpaceOperator.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_NULL_SPACE_OPERATOR_H
45#define ROL_NULL_SPACE_OPERATOR_H
46
48#include "ROL_Constraint.hpp"
49
57namespace ROL {
58
59template <class Real>
60class NullSpaceOperator : public LinearOperator<Real> {
61private:
62 const Ptr<Constraint<Real>> con_;
63 const Ptr<Vector<Real>> x_;
64 const bool useAugSys_;
65
66 mutable Ptr<Vector<Real>> b1_;
67 mutable Ptr<Vector<Real>> b1dual_;
68 mutable Ptr<Vector<Real>> b2_;
69 mutable Ptr<Vector<Real>> mul_;
70
71 int dim_;
72 Real b1sqr_;
73
74public:
75 virtual ~NullSpaceOperator() {}
77 const Vector<Real> &dom,
78 const Vector<Real> &ran,
79 const bool useAugSys = false)
80 : con_(con), x_(dom.clone()), useAugSys_(useAugSys) {
81 x_->set(dom);
82 dim_ = ran.dimension();
83 if (dim_==1 && !useAugSys_) {
84 Real tol = std::sqrt(ROL_EPSILON<Real>());
85 b1_ = dom.dual().clone();
86 b1dual_ = dom.clone();
87 b2_ = ran.dual().clone(); b2_->setScalar(1.0);
88 con_->applyAdjointJacobian(*b1_,*b2_,dom,tol);
89 b1dual_->set(b1_->dual());
90 b1sqr_ = b1_->dot(*b1_);
91 }
92 else {
93 b1_ = dom.dual().clone();
94 b2_ = ran.clone();
95 mul_ = ran.dual().clone();
96 }
97 }
98
100 const Ptr<const Vector<Real>> &dom,
101 const Ptr<const Vector<Real>> &ran)
102 : NullSpaceOperator(con,*dom,*ran) {}
103
104 virtual void update( const Vector<Real> &x, bool flag = true, int iter = -1 ) {
105 x_->set(x);
106 if (dim_==1 && !useAugSys_) {
107 Real tol = std::sqrt(ROL_EPSILON<Real>());
108 con_->applyAdjointJacobian(*b1_,*b2_,x,tol);
109 b1dual_->set(b1_->dual());
110 b1sqr_ = b1_->dot(*b1_);
111 }
112 }
113
114 virtual void apply( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
115 if (dim_==1 && !useAugSys_) {
116 Real dot = v.dot(*b1dual_);
117 Hv.set(v);
118 Hv.axpy(-dot/b1sqr_,*b1dual_);
119 }
120 else {
121 b1_->set(v.dual()); b2_->zero();
122 con_->solveAugmentedSystem(Hv,*mul_,*b1_,*b2_,*x_,tol);
123 }
124 }
125
126 void applyAdjoint( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
127 apply(Hv,v,tol);
128 }
129
130 void applyInverse( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
131 throw Exception::NotImplemented(">>> NullSpaceOperator::applyInverse : Not Implemented!");
132 }
133
134 void applyAdjointInverse( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
135 throw Exception::NotImplemented(">>> NullSpaceOperator::applyAdjointInverse : Not Implemented!");
136 }
137
138}; // class NullSpaceOperator
139
140} // namespace ROL
141
142#endif
Defines the general constraint operator interface.
Provides the interface to apply a linear operator.
Projects on to the null space of a linear constraint.
Ptr< Vector< Real > > b1dual_
virtual void update(const Vector< Real > &x, bool flag=true, int iter=-1)
Update linear operator.
void applyAdjoint(Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
Apply adjoint of linear operator.
NullSpaceOperator(const Ptr< Constraint< Real > > &con, const Ptr< const Vector< Real > > &dom, const Ptr< const Vector< Real > > &ran)
void applyInverse(Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
Apply inverse of linear operator.
virtual void apply(Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
Apply linear operator.
NullSpaceOperator(const Ptr< Constraint< Real > > &con, const Vector< Real > &dom, const Vector< Real > &ran, const bool useAugSys=false)
void applyAdjointInverse(Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
Apply adjoint of the inverse linear operator.
const Ptr< Constraint< Real > > con_
const Ptr< Vector< Real > > x_
Defines the linear algebra or vector space interface.
virtual void set(const Vector &x)
Set where .
virtual const Vector & dual() const
Return dual representation of , for example, the result of applying a Riesz map, or change of basis,...
virtual ROL::Ptr< Vector > clone() const =0
Clone to make a new (uninitialized) vector.
virtual int dimension() const
Return dimension of the vector space.
virtual void axpy(const Real alpha, const Vector &x)
Compute where .
virtual Real dot(const Vector &x) const =0
Compute where .