ROL
ROL_AugmentedSystemPrecOperator.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_AUGMENTED_SYSTEM_PREC_OPERATOR_H
45#define ROL_AUGMENTED_SYSTEM_PREC_OPERATOR_H
46
47#include "ROL_Constraint.hpp"
49
57namespace ROL {
58
59template <class Real>
61private:
62 const Ptr<Constraint<Real>> con_;
63 const Ptr<const Vector<Real>> x_;
64
65public:
68 const Ptr<const Vector<Real>> &x)
69 : con_(con), x_(x) {}
70
71 void apply( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
72 throw Exception::NotImplemented(">>> AugmentedSystemPrecOperator::apply : Not Implemented!");
73 }
74
75 void applyAdjoint( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
76 throw Exception::NotImplemented(">>> AugmentedSystemPrecOperator::applyAdjoint : Not Implemented!");
77 }
78
79 void applyInverse( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
80 Real zero(0);
81 PartitionedVector<Real> &Hvp = dynamic_cast<PartitionedVector<Real>&>(Hv);
82 const PartitionedVector<Real> &vp = dynamic_cast<const PartitionedVector<Real>&>(v);
83
84 Hvp.set(0, *(vp.get(0)));
85 // Second x should be dual, but unused?
86 con_->applyPreconditioner(*(Hvp.get(1)),*(vp.get(1)),*x_,*x_, zero);
87 }
88
89 void applyAdjointInverse( Vector<Real> &Hv, const Vector<Real> &v, Real &tol ) const {
90 applyInverse(Hv,v,tol);
91 }
92
93}; // class AugmentedSystemPrecOperator
94
95} // namespace ROL
96
97#endif
Objective_SerialSimOpt(const Ptr< Obj > &obj, const V &ui) z0 zero)()
Implements a preconditioner for the augmented system.
void apply(Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
Apply linear operator.
void applyAdjointInverse(Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
Apply adjoint of the inverse linear operator.
AugmentedSystemPrecOperator(const Ptr< Constraint< Real > > &con, const Ptr< const Vector< Real > > &x)
void applyAdjoint(Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
Apply adjoint of linear operator.
void applyInverse(Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
Apply inverse of linear operator.
Defines the general constraint operator interface.
Provides the interface to apply a linear operator.
Defines the linear algebra of vector space on a generic partitioned vector.
ROL::Ptr< const Vector< Real > > get(size_type i) const
void set(const V &x)
Set where .
Defines the linear algebra or vector space interface.