Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_ProductEpetraOperator.hpp
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
42#ifndef STOKHOS_PRODUCT_EPETRA_OPERATOR_HPP
43#define STOKHOS_PRODUCT_EPETRA_OPERATOR_HPP
44
47#include "Epetra_Map.h"
48#include "EpetraExt_MultiComm.h"
49
50namespace Stokhos {
51
56 public virtual ProductContainer<Epetra_Operator>,
57 public virtual Epetra_Operator {
58 public:
59
61 typedef double value_type;
62
64 typedef int ordinal_type;
65
71 const Teuchos::RCP<const Epetra_BlockMap>& block_map,
72 const Teuchos::RCP<const Epetra_Map>& domain_base_map,
73 const Teuchos::RCP<const Epetra_Map>& range_base_map,
74 const Teuchos::RCP<const EpetraExt::MultiComm>& product_comm);
75
80 /*
81 * This version supplies the generated product map \c product_map
82 */
84 const Teuchos::RCP<const Epetra_BlockMap>& block_map,
85 const Teuchos::RCP<const Epetra_Map>& domain_base_map,
86 const Teuchos::RCP<const Epetra_Map>& range_base_map,
87 const Teuchos::RCP<const Epetra_Map>& range_product_map,
88 const Teuchos::RCP<const EpetraExt::MultiComm>& product_comm);
89
91
95
97 virtual ~ProductEpetraOperator();
98
100
104
106 Teuchos::RCP<const EpetraExt::MultiComm> productComm() const;
107
110
112 virtual int SetUseTranspose(bool UseTranspose);
113
118 virtual int Apply(const Epetra_MultiVector& Input,
119 Epetra_MultiVector& Result) const;
120
125 virtual int ApplyInverse(const Epetra_MultiVector& X,
126 Epetra_MultiVector& Y) const;
127
129 virtual double NormInf() const;
130
132 virtual const char* Label () const;
133
135 virtual bool UseTranspose() const;
136
141 virtual bool HasNormInf() const;
142
147 virtual const Epetra_Comm & Comm() const;
148
153 virtual const Epetra_Map& OperatorDomainMap () const;
154
159 virtual const Epetra_Map& OperatorRangeMap () const;
160
162
163 protected:
164
167 const Teuchos::RCP<const Epetra_BlockMap>& block_map,
168 const Teuchos::RCP<const EpetraExt::MultiComm>& product_comm);
169
171 void setup(const Teuchos::RCP<const Epetra_Map>& domain_base_map,
172 const Teuchos::RCP<const Epetra_Map>& range_base_map);
173
174 protected:
175
177 Teuchos::RCP<const Epetra_Map> domain_base_map;
178
180 Teuchos::RCP<const Epetra_Map> range_base_map;
181
183 Teuchos::RCP<const Epetra_Map> product_range_map;
184
186 Teuchos::RCP<const EpetraExt::MultiComm> product_comm;
187
190
191 }; // class ProductEpetraOperator
192
193} // end namespace Stokhos
194
195#endif // STOKHOS_PRODUCT_EPETRA_OPERATOR_HPP
UnitTestSetup< Kokkos::Cuda > setup
A product (in the mathematical sense) container class whose coefficients are vectors,...
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.
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.
Top-level namespace for Stokhos classes and functions.