Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Stokhos_BlockDiagonalOperator.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Stokhos Package
4 //
5 // Copyright 2009 NTESS and the Stokhos contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
10 #ifndef STOKHOS_BLOCK_DIAGONAL_OPERATOR_HPP
11 #define STOKHOS_BLOCK_DIAGONAL_OPERATOR_HPP
12 
13 #include "Teuchos_RCP.hpp"
14 #include "Epetra_Operator.h"
15 #include "EpetraExt_MultiComm.h"
17 
18 namespace Stokhos {
19 
25 
26  public:
27 
31  int num_mp_blocks,
36 
38  virtual ~BlockDiagonalOperator();
39 
42 
44  virtual void setupOperator(
46 
49  getMPOps();
50 
53  getMPOps() const;
54 
56 
59 
61  virtual int SetUseTranspose(bool UseTranspose);
62 
67  virtual int Apply(const Epetra_MultiVector& Input,
68  Epetra_MultiVector& Result) const;
69 
74  virtual int ApplyInverse(const Epetra_MultiVector& X,
75  Epetra_MultiVector& Y) const;
76 
78  virtual double NormInf() const;
79 
81  virtual const char* Label () const;
82 
84  virtual bool UseTranspose() const;
85 
90  virtual bool HasNormInf() const;
91 
96  virtual const Epetra_Comm & Comm() const;
97 
102  virtual const Epetra_Map& OperatorDomainMap () const;
103 
108  virtual const Epetra_Map& OperatorRangeMap () const;
109 
111 
112  private:
113 
116 
119 
120  protected:
121 
123  std::string label;
124 
127 
130 
133 
136 
139 
142 
145 
148 
149  }; // class BlockDiagonalOperator
150 
151 } // namespace Stokhos
152 
153 #endif // STOKHOS_BLOCK_DIAGIONAL_OPERATOR_HPP
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix 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 ...
virtual int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
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 bool UseTranspose() const
Returns the current UseTranspose setting.
Teuchos::RCP< Stokhos::ProductEpetraOperator > block_ops
Stores operators.
bool useTranspose
Whether to use transpose.
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 ...
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
virtual void setupOperator(const Teuchos::RCP< Stokhos::ProductEpetraOperator > &ops)
Setup operator.
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.
Teuchos::RCP< const Epetra_Map > range_mp_map
Stores range MP map.
Teuchos::RCP< const Epetra_Map > range_base_map
Stores range base map.
BlockDiagonalOperator & operator=(const BlockDiagonalOperator &)
Private to prohibit copying.
virtual Teuchos::RCP< Stokhos::ProductEpetraOperator > getMPOps()
Get multi-point ops.
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator. ...
virtual const char * Label() const
Returns a character string describing the operator.
Teuchos::RCP< const Epetra_Map > domain_mp_map
Stores domain MP map.
Teuchos::RCP< const Epetra_Map > domain_base_map
Stores domain base map.
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.