Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_ProductEpetraOperator.cpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Stokhos Package
5// Copyright (2009) 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 Eric T. Phipps (etphipp@sandia.gov).
38//
39// ***********************************************************************
40// @HEADER
41
43#include "EpetraExt_BlockUtility.h"
44#include "EpetraExt_BlockMultiVector.h"
45
48 const Teuchos::RCP<const Epetra_BlockMap>& block_map,
49 const Teuchos::RCP<const Epetra_Map>& domain_base_map_,
50 const Teuchos::RCP<const Epetra_Map>& range_base_map_,
51 const Teuchos::RCP<const EpetraExt::MultiComm>& product_comm_) :
53 domain_base_map(domain_base_map_),
54 range_base_map(range_base_map_),
55 product_range_map(Teuchos::rcp(EpetraExt::BlockUtility::GenerateBlockMap(*range_base_map, *block_map, *product_comm_))),
56 product_comm(product_comm_),
57 useTranspose(false)
58{
59}
60
63 const Teuchos::RCP<const Epetra_BlockMap>& block_map,
64 const Teuchos::RCP<const Epetra_Map>& domain_base_map_,
65 const Teuchos::RCP<const Epetra_Map>& range_base_map_,
66 const Teuchos::RCP<const Epetra_Map>& product_range_map_,
67 const Teuchos::RCP<const EpetraExt::MultiComm>& product_comm_) :
69 domain_base_map(domain_base_map_),
70 range_base_map(range_base_map_),
71 product_range_map(product_range_map_),
72 product_comm(product_comm_),
73 useTranspose(false)
74{
75}
76
80 domain_base_map(v.domain_base_map),
81 range_base_map(v.range_base_map),
82 product_range_map(v.product_range_map),
83 product_comm(v.product_comm),
84 useTranspose(v.useTranspose)
85{
86}
87
90
95 domain_base_map = v.domain_base_map;
96 range_base_map = v.range_base_map;
97 product_range_map = v.product_range_map;
98 product_comm = v.product_comm;
99 useTranspose = v.useTranspose;
100 return *this;
101}
102
103Teuchos::RCP<const EpetraExt::MultiComm>
105productComm() const {
106 return product_comm;
107}
108
109int
111SetUseTranspose(bool UseTheTranspose)
112{
113 useTranspose = UseTheTranspose;
114 for (int i=0; i<coeff_.size(); i++)
115 coeff_[i]->SetUseTranspose(useTranspose);
116
117 return 0;
118}
119
120int
122Apply(const Epetra_MultiVector& Input, Epetra_MultiVector& Result) const
123{
124 if (useTranspose) {
125 EpetraExt::BlockMultiVector sg_input(View, *range_base_map, Input);
126 Epetra_MultiVector tmp(Result.Map(), Result.NumVectors());
127 Result.PutScalar(0.0);
128 for (int i=0; i<coeff_.size(); i++) {
129 coeff_[i]->Apply(*(sg_input.GetBlock(i)), tmp);
130 Result.Update(1.0, tmp, 1.0);
131 }
132 }
133 else {
134 EpetraExt::BlockMultiVector sg_result(View, *range_base_map, Result);
135 for (int i=0; i<coeff_.size(); i++)
136 coeff_[i]->Apply(Input, *(sg_result.GetBlock(i)));
137 }
138
139 return 0;
140}
141
142int
145 Epetra_MultiVector& Result) const
146{
147 throw "ProductEpetraOperator::ApplyInverse not defined!";
148 return -1;
149}
150
151double
153NormInf() const
154{
155 return 1.0;
156}
157
158
159const char*
161Label () const
162{
163 return "Stokhos::ProductEpetraOperator";
164}
165
166bool
168UseTranspose() const
169{
170 return useTranspose;
171}
172
173bool
175HasNormInf() const
176{
177 return false;
178}
179
180const Epetra_Comm &
182Comm() const
183{
184 return *product_comm;
185}
186const Epetra_Map&
188OperatorDomainMap() const
189{
190 if (useTranspose)
191 return *product_range_map;
192 return *domain_base_map;
193}
194
195const Epetra_Map&
197OperatorRangeMap() const
198{
199 if (useTranspose)
200 return *domain_base_map;
201 return *product_range_map;
202}
203
206 const Teuchos::RCP<const Epetra_BlockMap>& block_map,
207 const Teuchos::RCP<const EpetraExt::MultiComm>& product_comm_) :
209 product_comm(product_comm_),
210 useTranspose(false)
211{
212}
213
214void
216setup(const Teuchos::RCP<const Epetra_Map>& domain_base_map_,
217 const Teuchos::RCP<const Epetra_Map>& range_base_map_)
218{
219 domain_base_map = domain_base_map_;
220 range_base_map = range_base_map_;
221 product_range_map =
222 Teuchos::rcp(EpetraExt::BlockUtility::GenerateBlockMap(*range_base_map,
223 *(this->map_),
224 *product_comm));
225}
A product (in the mathematical sense) container class whose coefficients are vectors,...
ProductContainer & operator=(const ProductContainer &)
Assignment.
A container class for products of Epetra_Vector's.
virtual int Apply(const Epetra_MultiVector &Input, Epetra_MultiVector &Result) const
Returns the result of a Epetra_Operator applied to a Epetra_MultiVector Input in Result as described ...
bool useTranspose
Whether to use transpose in Apply()
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.
Teuchos::RCP< const EpetraExt::MultiComm > product_comm
Product multi-level communicator.
void setup(const Teuchos::RCP< const Epetra_Map > &domain_base_map, const Teuchos::RCP< const Epetra_Map > &range_base_map)
Second stage of setup.
ProductEpetraOperator(const Teuchos::RCP< const Epetra_BlockMap > &block_map, const Teuchos::RCP< const Epetra_Map > &domain_base_map, const Teuchos::RCP< const Epetra_Map > &range_base_map, const Teuchos::RCP< const EpetraExt::MultiComm > &product_comm)
Create a container with container map block_map where each coefficient is generated from the supplied...
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
ProductEpetraOperator & operator=(const ProductEpetraOperator &v)
Assignment.
virtual int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
Teuchos::RCP< const Epetra_Map > domain_base_map
Domain map of each coefficient.
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator.
Teuchos::RCP< const Epetra_Map > product_range_map
Product range map.
virtual const char * Label() const
Returns a character string describing the operator.
virtual int ApplyInverse(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Returns the result of the inverse of the operator applied to a Epetra_MultiVector Input in Result as ...
Teuchos::RCP< const EpetraExt::MultiComm > productComm() const
Get product comm.
Teuchos::RCP< const Epetra_Map > range_base_map
Range map of each coefficient.
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.