ROL
ROL_BlockOperator2UnitLower.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_BLOCKOPERATOR2UNITLOWER_H
45#define ROL_BLOCKOPERATOR2UNITLOWER_H
46
48
60namespace ROL {
61
62template<class Real>
64
65 typedef Vector<Real> V; // ROL Vector
66 typedef PartitionedVector<Real> PV; // ROL PartitionedVector
67 typedef LinearOperator<Real> OP; // Linear Operator
68
69private:
70
71 ROL::Ptr<OP> C_;
72
73
74public:
75
76 BlockOperator2UnitLower( ROL::Ptr<OP> &C ) : C_(C) {}
77 }
78
79 void apply( V &Hv, const V &v, Real &tol ) const {
80
82 PV &Hv_pv = dynamic_cast<PV&>(Hv);
83 const PV &v_pv = dynamic_cast<const PV&>(v);
84
85 ROL::Ptr<V> Hv1 = Hv_pv.get(0);
86 ROL::Ptr<V> Hv2 = Hv_pv.get(1);
87 ROL::Ptr<const V> v1 = v_pv.get(0);
88 ROL::Ptr<const V> v2 = v_pv.get(1);
89
90 Hv1->set(*v1);
91 C_->apply(*Hv2,*v1,tol);
92 Hv2->plus(*v2);
93 }
94
95
96 void applyInverse( V &Hv, const V &v Real &tol ) const {
97
98
99 PV &Hv_pv = dynamic_cast<PV&>(Hv);
100 const PV &v_pv = dynamic_cast<const PV&>(v);
101
102 ROL::Ptr<V> Hv1 = Hv_pv.get(0);
103 ROL::Ptr<V> Hv2 = Hv_pv.get(1);
104 ROL::Ptr<const V> v1 = v_pv.get(0);
105 ROL::Ptr<const V> v2 = v_pv.get(1);
106
107 Hv1->set(*v1);
108 C_->apply(*Hv2,*v1,tol);
109 Hv2->scale(-1.0);
110 Hv2->plus(*v2);
111
112 }
113
114 ROL::Ptr<LinearOperator<Real> > getOperator( int row, int col ) const {
115 if( row == 1 && col == 0 ) {
116 return C_;
117 }
118 else {
119 ROL_TEST_FOR_EXCEPTION( true, std::invalid_argument,
120 ">>> ERROR (ROL_BlockOperator2UnitLower, getOperator): "
121 "invalid block indices.");
122 }
123
124 }
125
126
127}; // class BlockOperator2UnitLower
128
129} // namespace ROL
130
131#endif // ROL_BLOCKOPERATOR2UNITLOWER_H
Vector< Real > V
PartitionedVector< Real > PV
ROL::Ptr< OP > C_
Provides the interface to apply a 2x2 block unit lower operator to a partitioned vector.
void apply(V &Hv, const V &v, Real &tol) const
Apply linear operator.
Provides the interface to apply a linear operator.
Defines the linear algebra of vector space on a generic partitioned vector.
Defines the linear algebra or vector space interface.
ROL::BlockOperator2Diagonal BlockOperator2 apply(V &Hv, const V &v, Real &tol) const
ROL::Ptr< LinearOperator< Real > > getOperator(int row, int col) const
void applyInverse(V &Hv, const V &v Real &tol) const