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