Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Stokhos::BlockDiagonalOperator Class Reference

An Epetra operator representing the block stochastic Galerkin operator. More...

#include <Stokhos_BlockDiagonalOperator.hpp>

Inheritance diagram for Stokhos::BlockDiagonalOperator:
Inheritance graph
[legend]

Public Member Functions

 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 ~BlockDiagonalOperator ()
 Destructor.
 
- Public Member Functions inherited from Epetra_Operator
virtual ~Epetra_Operator ()
 

Epetra_Operator methods

std::string label
 Label for operator.
 
Teuchos::RCP< const EpetraExt::MultiComm > mp_comm
 Stores MP parallel communicator.
 
int num_mp_blocks
 Stores number of blocks.
 
Teuchos::RCP< const Epetra_Mapdomain_base_map
 Stores domain base map.
 
Teuchos::RCP< const Epetra_Maprange_base_map
 Stores range base map.
 
Teuchos::RCP< const Epetra_Mapdomain_mp_map
 Stores domain MP map.
 
Teuchos::RCP< const Epetra_Maprange_mp_map
 Stores range MP map.
 
Teuchos::RCP< Stokhos::ProductEpetraOperatorblock_ops
 Stores operators.
 
bool useTranspose
 Whether to use transpose.
 
virtual int SetUseTranspose (bool UseTranspose)
 Set to true if the transpose of the operator is requested.
 
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 above.
 
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 described above.
 
virtual double NormInf () const
 Returns an approximate infinity norm of the operator matrix.
 
virtual const char * Label () const
 Returns a character string describing the operator.
 
virtual bool UseTranspose () const
 Returns the current UseTranspose setting.
 
virtual bool HasNormInf () const
 Returns true if the this object can provide an approximate Inf-norm, false otherwise.
 
virtual const Epetra_CommComm () const
 Returns a reference to the Epetra_Comm communicator associated with this operator.
 
virtual const Epetra_MapOperatorDomainMap () const
 Returns the Epetra_Map object associated with the domain of this matrix operator.
 
virtual const Epetra_MapOperatorRangeMap () const
 Returns the Epetra_Map object associated with the range of this matrix operator.
 
 BlockDiagonalOperator (const BlockDiagonalOperator &)
 Private to prohibit copying.
 
BlockDiagonalOperatoroperator= (const BlockDiagonalOperator &)
 Private to prohibit copying.
 
virtual void setupOperator (const Teuchos::RCP< Stokhos::ProductEpetraOperator > &ops)
 Setup operator.
 
virtual Teuchos::RCP< Stokhos::ProductEpetraOperatorgetMPOps ()
 Get multi-point ops.
 
virtual Teuchos::RCP< const Stokhos::ProductEpetraOperatorgetMPOps () const
 Get multi-point ops.
 

Detailed Description

An Epetra operator representing the block stochastic Galerkin operator.

Definition at line 56 of file Stokhos_BlockDiagonalOperator.hpp.

Constructor & Destructor Documentation

◆ BlockDiagonalOperator() [1/2]

Stokhos::BlockDiagonalOperator::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.

Definition at line 46 of file Stokhos_BlockDiagonalOperator.cpp.

◆ ~BlockDiagonalOperator()

Stokhos::BlockDiagonalOperator::~BlockDiagonalOperator ( )
virtual

Destructor.

Definition at line 66 of file Stokhos_BlockDiagonalOperator.cpp.

◆ BlockDiagonalOperator() [2/2]

Stokhos::BlockDiagonalOperator::BlockDiagonalOperator ( const BlockDiagonalOperator & )
private

Private to prohibit copying.

Member Function Documentation

◆ setupOperator()

void Stokhos::BlockDiagonalOperator::setupOperator ( const Teuchos::RCP< Stokhos::ProductEpetraOperator > & ops)
virtual

Setup operator.

Definition at line 72 of file Stokhos_BlockDiagonalOperator.cpp.

◆ getMPOps() [1/2]

Teuchos::RCP< Stokhos::ProductEpetraOperator > Stokhos::BlockDiagonalOperator::getMPOps ( )
virtual

Get multi-point ops.

Definition at line 80 of file Stokhos_BlockDiagonalOperator.cpp.

◆ getMPOps() [2/2]

Teuchos::RCP< const Stokhos::ProductEpetraOperator > Stokhos::BlockDiagonalOperator::getMPOps ( ) const
virtual

Get multi-point ops.

Definition at line 87 of file Stokhos_BlockDiagonalOperator.cpp.

◆ SetUseTranspose()

int Stokhos::BlockDiagonalOperator::SetUseTranspose ( bool UseTranspose)
virtual

Set to true if the transpose of the operator is requested.

Implements Epetra_Operator.

Definition at line 94 of file Stokhos_BlockDiagonalOperator.cpp.

◆ Apply()

int Stokhos::BlockDiagonalOperator::Apply ( const Epetra_MultiVector & Input,
Epetra_MultiVector & Result ) const
virtual

Returns the result of a Epetra_Operator applied to a Epetra_MultiVector Input in Result as described above.

Implements Epetra_Operator.

Definition at line 105 of file Stokhos_BlockDiagonalOperator.cpp.

◆ ApplyInverse()

int Stokhos::BlockDiagonalOperator::ApplyInverse ( const Epetra_MultiVector & X,
Epetra_MultiVector & Y ) const
virtual

Returns the result of the inverse of the operator applied to a Epetra_MultiVector Input in Result as described above.

Implements Epetra_Operator.

Definition at line 127 of file Stokhos_BlockDiagonalOperator.cpp.

◆ NormInf()

double Stokhos::BlockDiagonalOperator::NormInf ( ) const
virtual

Returns an approximate infinity norm of the operator matrix.

Implements Epetra_Operator.

Definition at line 150 of file Stokhos_BlockDiagonalOperator.cpp.

◆ Label()

const char * Stokhos::BlockDiagonalOperator::Label ( ) const
virtual

Returns a character string describing the operator.

Implements Epetra_Operator.

Definition at line 164 of file Stokhos_BlockDiagonalOperator.cpp.

◆ UseTranspose()

bool Stokhos::BlockDiagonalOperator::UseTranspose ( ) const
virtual

Returns the current UseTranspose setting.

Implements Epetra_Operator.

Definition at line 170 of file Stokhos_BlockDiagonalOperator.cpp.

◆ HasNormInf()

bool Stokhos::BlockDiagonalOperator::HasNormInf ( ) const
virtual

Returns true if the this object can provide an approximate Inf-norm, false otherwise.

Implements Epetra_Operator.

Definition at line 176 of file Stokhos_BlockDiagonalOperator.cpp.

◆ Comm()

const Epetra_Comm & Stokhos::BlockDiagonalOperator::Comm ( ) const
virtual

Returns a reference to the Epetra_Comm communicator associated with this operator.

Implements Epetra_Operator.

Definition at line 184 of file Stokhos_BlockDiagonalOperator.cpp.

◆ OperatorDomainMap()

const Epetra_Map & Stokhos::BlockDiagonalOperator::OperatorDomainMap ( ) const
virtual

Returns the Epetra_Map object associated with the domain of this matrix operator.

Implements Epetra_Operator.

Definition at line 189 of file Stokhos_BlockDiagonalOperator.cpp.

◆ OperatorRangeMap()

const Epetra_Map & Stokhos::BlockDiagonalOperator::OperatorRangeMap ( ) const
virtual

Returns the Epetra_Map object associated with the range of this matrix operator.

Implements Epetra_Operator.

Definition at line 197 of file Stokhos_BlockDiagonalOperator.cpp.

◆ operator=()

BlockDiagonalOperator & Stokhos::BlockDiagonalOperator::operator= ( const BlockDiagonalOperator & )
private

Private to prohibit copying.

Member Data Documentation

◆ label

std::string Stokhos::BlockDiagonalOperator::label
protected

Label for operator.

Definition at line 155 of file Stokhos_BlockDiagonalOperator.hpp.

◆ mp_comm

Teuchos::RCP<const EpetraExt::MultiComm> Stokhos::BlockDiagonalOperator::mp_comm
protected

Stores MP parallel communicator.

Definition at line 158 of file Stokhos_BlockDiagonalOperator.hpp.

◆ num_mp_blocks

int Stokhos::BlockDiagonalOperator::num_mp_blocks
protected

Stores number of blocks.

Definition at line 161 of file Stokhos_BlockDiagonalOperator.hpp.

◆ domain_base_map

Teuchos::RCP<const Epetra_Map> Stokhos::BlockDiagonalOperator::domain_base_map
protected

Stores domain base map.

Definition at line 164 of file Stokhos_BlockDiagonalOperator.hpp.

◆ range_base_map

Teuchos::RCP<const Epetra_Map> Stokhos::BlockDiagonalOperator::range_base_map
protected

Stores range base map.

Definition at line 167 of file Stokhos_BlockDiagonalOperator.hpp.

◆ domain_mp_map

Teuchos::RCP<const Epetra_Map> Stokhos::BlockDiagonalOperator::domain_mp_map
protected

Stores domain MP map.

Definition at line 170 of file Stokhos_BlockDiagonalOperator.hpp.

◆ range_mp_map

Teuchos::RCP<const Epetra_Map> Stokhos::BlockDiagonalOperator::range_mp_map
protected

Stores range MP map.

Definition at line 173 of file Stokhos_BlockDiagonalOperator.hpp.

◆ block_ops

Teuchos::RCP<Stokhos::ProductEpetraOperator > Stokhos::BlockDiagonalOperator::block_ops
protected

Stores operators.

Definition at line 176 of file Stokhos_BlockDiagonalOperator.hpp.

◆ useTranspose

bool Stokhos::BlockDiagonalOperator::useTranspose
protected

Whether to use transpose.

Definition at line 179 of file Stokhos_BlockDiagonalOperator.hpp.


The documentation for this class was generated from the following files: