Class which wrap an operator to apply it only on a restriction. More...

#include <ConfinedOperator.hpp>

Inheritance diagram for ConfinedOperator:

Collaboration diagram for ConfinedOperator:

Protected Attributes
operatorPtr_Type	M_oper

blockStructure_Type	M_blockStructure

UInt	M_blockIndex

std::shared_ptr< Epetra_Comm >	M_comm

std::shared_ptr< map_Type >	M_map

Public Typedefs and Enumerators
typedef Epetra_Operator	operator_Type

typedef std::shared_ptr< operator_Type >	operatorPtr_Type

typedef VectorBlockStructure	blockStructure_Type

typedef Epetra_MultiVector	vector_Type

typedef std::shared_ptr< vector_Type >	vectorPtr_Type

typedef Epetra_Comm	comm_Type

typedef Epetra_Map	map_Type

	ConfinedOperator (std::shared_ptr< Epetra_Comm > comm=std::shared_ptr< Epetra_Comm >(new Epetra_MpiComm(MPI_COMM_WORLD)))
	null constructor and destructor More...

	~ConfinedOperator ()

Attribute set methods
virtual int	SetUseTranspose (bool useTranspose)
	If set true, transpose of this operator will be applied. More...

void	setOperator (operatorPtr_Type oper)

void	setFullMap (const MapEpetra &map)

void	setBlockStructure (const blockStructure_Type &blockStructure)

void	setBlockIndex (UInt index)

Mathematical methods
virtual int	Apply (const vector_Type &X, vector_Type &Y) const
	Returns the result of a Epetra_Operator applied to a vector_Type X in Y. More...

virtual int	ApplyInverse (const vector_Type &X, vector_Type &Y) const
	Returns the result of a Epetra_Operator inverse applied to an vector_Type X in Y. More...

double	NormInf () const
	Returns the infinity norm of the global matrix. More...

Attribute access methods
virtual const char *	Label () const
	Returns a character string describing the operator. More...

virtual bool	UseTranspose () const
	Returns the current UseTranspose setting. More...

virtual bool	HasNormInf () const
	Returns true if the this object can provide an approximate Inf-norm, false otherwise. More...

virtual const comm_Type &	Comm () const
	Returns a pointer to the Epetra_Comm communicator associated with this operator. More...

virtual const map_Type &	OperatorDomainMap () const
	Returns the Epetra_Map object associated with the domain of this operator. More...

virtual const map_Type &	OperatorRangeMap () const
	Returns the Epetra_Map object associated with the range of this operator. More...

Additional Inherited Members
Public Types inherited from LinearOperator
typedef Epetra_Comm	comm_Type

typedef std::shared_ptr< comm_Type >	commPtr_Type

typedef Epetra_Map	map_Type

typedef std::shared_ptr< map_Type >	mapPtr_Type

typedef std::shared_ptr< const map_Type >	constMapPtr_Type

typedef Epetra_Operator	operator_Type

typedef std::shared_ptr< operator_Type >	operatorPtr_Type

typedef Epetra_MultiVector	vector_Type

typedef std::shared_ptr< vector_Type >	vectorPtr_Type

Public Member Functions inherited from LinearOperator
virtual	~LinearOperator ()
	Destructor. More...

int	apply (const VectorEpetra &X, VectorEpetra &Y) const
	Returns the result of a LinearOperator applied to a VectorEpetra X in Y. More...

int	applyInverse (const VectorEpetra &X, VectorEpetra &Y)
	Returns the result of a LinearOperator inverse applied to an VectorEpetra X in Y. More...

Detailed Description

Class which wrap an operator to apply it only on a restriction.

Definition at line 58 of file ConfinedOperator.hpp.

Member Typedef Documentation

◆ operator_Type

typedef Epetra_Operator operator_Type

Definition at line 64 of file ConfinedOperator.hpp.

◆ operatorPtr_Type

typedef std::shared_ptr<operator_Type> operatorPtr_Type

Definition at line 65 of file ConfinedOperator.hpp.

◆ blockStructure_Type

typedef VectorBlockStructure blockStructure_Type

Definition at line 66 of file ConfinedOperator.hpp.

◆ vector_Type

typedef Epetra_MultiVector vector_Type

Definition at line 67 of file ConfinedOperator.hpp.

◆ vectorPtr_Type

typedef std::shared_ptr<vector_Type> vectorPtr_Type

Definition at line 68 of file ConfinedOperator.hpp.

◆ comm_Type

typedef Epetra_Comm comm_Type

Definition at line 69 of file ConfinedOperator.hpp.

◆ map_Type

typedef Epetra_Map map_Type

Definition at line 70 of file ConfinedOperator.hpp.

Constructor & Destructor Documentation

◆ ConfinedOperator()

ConfinedOperator ( std::shared_ptr< Epetra_Comm > comm = std::shared_ptr<Epetra_Comm> ( new Epetra_MpiComm ( MPI_COMM_WORLD ) ) )

null constructor and destructor

Definition at line 43 of file ConfinedOperator.cpp.

◆ ~ConfinedOperator()

~ConfinedOperator ( )

Definition at line 53 of file ConfinedOperator.cpp.

Member Function Documentation

◆ SetUseTranspose()

int SetUseTranspose ( bool useTranspose )

virtual

If set true, transpose of this operator will be applied.

Implements LinearOperator.

Definition at line 60 of file ConfinedOperator.cpp.

◆ setOperator()

void setOperator ( operatorPtr_Type oper )

Definition at line 67 of file ConfinedOperator.cpp.

◆ setFullMap()

void setFullMap ( const MapEpetra & map )

Definition at line 73 of file ConfinedOperator.cpp.

◆ setBlockStructure()

void setBlockStructure ( const blockStructure_Type & blockStructure )

Definition at line 79 of file ConfinedOperator.cpp.

◆ setBlockIndex()

void setBlockIndex ( UInt index )

Definition at line 85 of file ConfinedOperator.cpp.

◆ Apply()

int Apply	(	const vector_Type &	X,
		vector_Type &	Y
	)		const

virtual

Returns the result of a Epetra_Operator applied to a vector_Type X in Y.

Implements LinearOperator.

Definition at line 93 of file ConfinedOperator.cpp.

◆ ApplyInverse()

int ApplyInverse	(	const vector_Type &	X,
		vector_Type &	Y
	)		const

virtual

Returns the result of a Epetra_Operator inverse applied to an vector_Type X in Y.

Implements LinearOperator.

Definition at line 135 of file ConfinedOperator.cpp.

◆ NormInf()

double NormInf ( ) const

virtual

Returns the infinity norm of the global matrix.

Implements LinearOperator.

Definition at line 177 of file ConfinedOperator.cpp.

◆ Label()

const char * Label ( ) const

virtual

Returns a character string describing the operator.

Implements LinearOperator.

Definition at line 184 of file ConfinedOperator.cpp.

◆ UseTranspose()

bool UseTranspose ( ) const

virtual

Returns the current UseTranspose setting.

Implements LinearOperator.

Definition at line 191 of file ConfinedOperator.cpp.

◆ HasNormInf()

bool HasNormInf ( ) const

virtual

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

Implements LinearOperator.

Definition at line 198 of file ConfinedOperator.cpp.

◆ Comm()

const ConfinedOperator::comm_Type & Comm ( ) const

virtual

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

Implements LinearOperator.

Definition at line 205 of file ConfinedOperator.cpp.

◆ OperatorDomainMap()

const ConfinedOperator::map_Type & OperatorDomainMap ( ) const

virtual

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

Implements LinearOperator.

Definition at line 212 of file ConfinedOperator.cpp.

◆ OperatorRangeMap()

const ConfinedOperator::map_Type & OperatorRangeMap ( ) const

virtual

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

Implements LinearOperator.

Definition at line 219 of file ConfinedOperator.cpp.

Field Documentation

◆ M_oper

operatorPtr_Type M_oper

protected

Definition at line 138 of file ConfinedOperator.hpp.

◆ M_blockStructure

blockStructure_Type M_blockStructure

protected

Definition at line 139 of file ConfinedOperator.hpp.

◆ M_blockIndex

UInt M_blockIndex

protected

Definition at line 140 of file ConfinedOperator.hpp.

◆ M_comm

std::shared_ptr<Epetra_Comm> M_comm

protected

Definition at line 141 of file ConfinedOperator.hpp.

◆ M_map

std::shared_ptr<map_Type> M_map

protected

Definition at line 142 of file ConfinedOperator.hpp.

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

Protected Attributes

Public Typedefs and Enumerators

Attribute set methods

Mathematical methods

Attribute access methods

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ operator_Type

◆ operatorPtr_Type

◆ blockStructure_Type

◆ vector_Type

◆ vectorPtr_Type

◆ comm_Type

◆ map_Type

Constructor & Destructor Documentation

◆ ConfinedOperator()

◆ ~ConfinedOperator()

Member Function Documentation

◆ SetUseTranspose()

◆ setOperator()

◆ setFullMap()

◆ setBlockStructure()

◆ setBlockIndex()

◆ Apply()

◆ ApplyInverse()

◆ NormInf()

◆ Label()

◆ UseTranspose()

◆ HasNormInf()

◆ Comm()

◆ OperatorDomainMap()

◆ OperatorRangeMap()

Field Documentation

◆ M_oper

◆ M_blockStructure

◆ M_blockIndex

◆ M_comm

◆ M_map