Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_BlockDiagonalOperator.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_BLOCK_DIAGONAL_OPERATOR_HPP
43#define STOKHOS_BLOCK_DIAGONAL_OPERATOR_HPP
44
45#include "Teuchos_RCP.hpp"
46#include "Epetra_Operator.h"
47#include "EpetraExt_MultiComm.h"
49
50namespace Stokhos {
51
57
58 public:
59
62 const Teuchos::RCP<const EpetraExt::MultiComm>& mp_comm,
63 int num_mp_blocks,
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>& domain_mp_map,
67 const Teuchos::RCP<const Epetra_Map>& range_mp_map);
68
70 virtual ~BlockDiagonalOperator();
71
74
76 virtual void setupOperator(
77 const Teuchos::RCP<Stokhos::ProductEpetraOperator >& ops);
78
80 virtual Teuchos::RCP< Stokhos::ProductEpetraOperator >
81 getMPOps();
82
84 virtual Teuchos::RCP<const Stokhos::ProductEpetraOperator >
85 getMPOps() const;
86
88
91
93 virtual int SetUseTranspose(bool UseTranspose);
94
99 virtual int Apply(const Epetra_MultiVector& Input,
100 Epetra_MultiVector& Result) const;
101
106 virtual int ApplyInverse(const Epetra_MultiVector& X,
107 Epetra_MultiVector& Y) const;
108
110 virtual double NormInf() const;
111
113 virtual const char* Label () const;
114
116 virtual bool UseTranspose() const;
117
122 virtual bool HasNormInf() const;
123
128 virtual const Epetra_Comm & Comm() const;
129
134 virtual const Epetra_Map& OperatorDomainMap () const;
135
140 virtual const Epetra_Map& OperatorRangeMap () const;
141
143
144 private:
145
148
151
152 protected:
153
155 std::string label;
156
158 Teuchos::RCP<const EpetraExt::MultiComm> mp_comm;
159
162
164 Teuchos::RCP<const Epetra_Map> domain_base_map;
165
167 Teuchos::RCP<const Epetra_Map> range_base_map;
168
170 Teuchos::RCP<const Epetra_Map> domain_mp_map;
171
173 Teuchos::RCP<const Epetra_Map> range_mp_map;
174
176 Teuchos::RCP<Stokhos::ProductEpetraOperator > block_ops;
177
180
181 }; // class BlockDiagonalOperator
182
183} // namespace Stokhos
184
185#endif // STOKHOS_BLOCK_DIAGIONAL_OPERATOR_HPP
An Epetra operator representing the block stochastic Galerkin operator.
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
Teuchos::RCP< const EpetraExt::MultiComm > mp_comm
Stores MP parallel communicator.
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.
BlockDiagonalOperator(const Teuchos::RCP< const EpetraExt::MultiComm > &mp_comm, int num_mp_blocks, const Teuchos::RCP< const Epetra_Map > &domain_base_map, const Teuchos::RCP< const Epetra_Map > &range_base_map, const Teuchos::RCP< const Epetra_Map > &domain_mp_map, const Teuchos::RCP< const Epetra_Map > &range_mp_map)
Constructor.
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 Epetra_Map > range_base_map
Stores range base map.
virtual Teuchos::RCP< Stokhos::ProductEpetraOperator > getMPOps()
Get multi-point ops.
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
Teuchos::RCP< const Epetra_Map > domain_mp_map
Stores domain MP map.
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator.
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 ...
Teuchos::RCP< Stokhos::ProductEpetraOperator > block_ops
Stores operators.
BlockDiagonalOperator & operator=(const BlockDiagonalOperator &)
Private to prohibit copying.
virtual void setupOperator(const Teuchos::RCP< Stokhos::ProductEpetraOperator > &ops)
Setup operator.
Teuchos::RCP< const Epetra_Map > range_mp_map
Stores range MP map.
virtual const char * Label() const
Returns a character string describing the operator.
BlockDiagonalOperator(const BlockDiagonalOperator &)
Private to prohibit copying.
virtual int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.
Teuchos::RCP< const Epetra_Map > domain_base_map
Stores domain base map.
Top-level namespace for Stokhos classes and functions.