ROL
ROL_BlockOperator2.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_BLOCKOPERATOR2_H
45#define ROL_BLOCKOPERATOR2_H
46
47#include "ROL_BlockOperator.hpp"
48
57namespace ROL {
58
59template<class Real>
60class BlockOperator2 : public LinearOperator<Real> {
61
62 typedef Vector<Real> V; // ROL Vector
63 typedef PartitionedVector<Real> PV; // ROL PartitionedVector
64 typedef LinearOperator<Real> OP; // Linear Operator
65
66private:
67
68 ROL::Ptr<OP> bkop_;
69 ROL::Ptr<std::vector<ROL::Ptr<OP> > > ops_;
70
71public:
72
73 BlockOperator2( ROL::Ptr<OP> &a11, ROL::Ptr<OP> &a12,
74 ROL::Ptr<OP> &a21, ROL::Ptr<OP> &a22 ) {
75
76 using std::vector;
77
78
79
80 ops_ = ROL::makePtr<vector<ROL::Ptr<OP> >>();
81 ops_->push_back(a11);
82 ops_->push_back(a12);
83 ops_->push_back(a21);
84 ops_->push_back(a22);
85
86 bkop_ = ROL::makePtr<BlockOperator<Real>>(ops_);
87
88 }
89
90
91 void apply( V &Hv, const V &v, Real &tol ) const {
92 bkop_->apply(Hv,v,tol);
93 }
94
95
96 void applyInverse( V &Hv, const V &v, Real &tol ) const {
97
98 ROL_TEST_FOR_EXCEPTION( true , std::logic_error,
99 ">>> ERROR (ROL_BlockOperator2, applyInverse): "
100 "Not implemented.");
101
102 }
103
104 ROL::Ptr<LinearOperator<Real> > getOperator( int row, int col ) const {
105 int dex = 2*row+col;
106 if( 0<=dex && dex<=3 ) {
107 return (*ops_)[dex];
108 }
109 else {
110 ROL_TEST_FOR_EXCEPTION( true, std::invalid_argument,
111 ">>> ERROR (ROL_BlockOperator2, getOperator): "
112 "invalid block indices.");
113 }
114
115 }
116
117
118}; // class BlockOperator2
119
120} // namespace ROL
121
122#endif // ROL_BLOCKOPERATOR2_H
Provides the interface to apply a 2x2 block operator to a partitioned vector.
PartitionedVector< Real > PV
LinearOperator< Real > OP
void applyInverse(V &Hv, const V &v, Real &tol) const
Apply inverse of linear operator.
ROL::Ptr< LinearOperator< Real > > getOperator(int row, int col) const
BlockOperator2(ROL::Ptr< OP > &a11, ROL::Ptr< OP > &a12, ROL::Ptr< OP > &a21, ROL::Ptr< OP > &a22)
void apply(V &Hv, const V &v, Real &tol) const
Apply linear operator.
ROL::Ptr< std::vector< ROL::Ptr< OP > > > ops_
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.