ROL
ROL_BlockOperator.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_BLOCKOPERATOR_H
45#define ROL_BLOCKOPERATOR_H
46
49
58namespace ROL {
59
60template<class Real>
61class BlockOperator : public LinearOperator<Real> {
62
63 typedef Vector<Real> V; // ROL Vector
64 typedef PartitionedVector<Real> PV; // Partitioned Vector
65 typedef LinearOperator<Real> OP; // Linear Operator
66
67 typedef std::vector<ROL::Ptr<OP> > OpVec; // Vector (column-stacked matrix) of pointers to operators
68 typedef typename OpVec::size_type uint; // index type
69
70private:
71
72 ROL::Ptr<OpVec> blocks_;
73
74public:
76 BlockOperator( const ROL::Ptr<OpVec> &blocks ) : blocks_(blocks) {}
77
78 virtual void apply( V &Hv, const V &v, Real &tol ) const {
79
80 // Downcast to Partitioned Vectors
81 PV &Hv_part = dynamic_cast<PV&>(Hv);
82 const PV &v_part = dynamic_cast<const PV&>(v);
83
84 uint nvec1 = v_part.numVectors();
85 uint nvec2 = Hv_part.numVectors();
86 uint nblks = blocks_->size();
87
88 ROL_TEST_FOR_EXCEPTION( (nvec1 != nvec2), std::invalid_argument,
89 ">>> ERROR (ROL_BlockOperator, apply): "
90 "Mismatch between input and output number of subvectors.");
91
92 ROL_TEST_FOR_EXCEPTION( (nblks != nvec1*nvec2 ) , std::invalid_argument,
93 ">>> ERROR (ROL_BlockOperator, apply): "
94 "Block operator dimension mismatch.");
95
96 for( uint i=0; i<nvec1; ++i ) {
97
98 ROL::Ptr<V> Hvi = Hv_part.get(i);
99 ROL::Ptr<V> u = Hvi->clone();
100
101 u->zero();
102
103 for( uint j=0; j<nvec2; ++j ) {
104 uint k = i+nvec1*j;
105 (*blocks_)[k]->apply(*u,*v_part.get(j),tol);
106 Hvi->plus(*u);
107 }
108 }
109 }
110
111
112}; // class BlockOperator
113
114} // namespace ROL
115
116#endif // ROL_BLOCKOPERATOR_H
Provides the interface to apply a block operator to a partitioned vector.
virtual void apply(V &Hv, const V &v, Real &tol) const
Apply linear operator.
std::vector< ROL::Ptr< OP > > OpVec
LinearOperator< Real > OP
ROL::Ptr< OpVec > blocks_
PartitionedVector< Real > PV
OpVec::size_type uint
BlockOperator(const ROL::Ptr< OpVec > &blocks)
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
Defines the linear algebra or vector space interface.