Abstract view of a block operator. More...

#include <BlockOperatorView.hpp>

Inheritance diagram for geos::BlockOperatorView< VECTOR, OPERATOR >:

Public Types
using	Base = LinearOperator< BlockVectorView< VECTOR > >
	Alias for base type.

using	Vector = typename Base::Vector
	Alias for vector type.

Public Types inherited from geos::LinearOperator< BlockVectorView< VECTOR > >
using	Vector = BlockVectorView< VECTOR >
	Alias for template parameter.

Public Member Functions
Constructors/destructors
virtual	~BlockOperatorView () override=default
	Destructor.

BlockOperatorView &	operator= (BlockOperatorView const &)=delete
	Deleted copy assignment. More...

BlockOperatorView &	operator= (BlockOperatorView &&)=delete
	Deleted move assignment. More...

LinearOperator interface
virtual void	apply (Vector const &src, Vector &dst) const override
	Apply operator to a vector. More...

template<typename OP = OPERATOR>
std::enable_if_t< traits::VectorBasedTraits< Vector >::template HasMemberFunction_applyTranspose< OP > >	applyTranspose (BlockVectorView< VECTOR > const &src, BlockVectorView< VECTOR > &dst) const
	Apply the transpose of block operator to a block vector. More...

virtual globalIndex	numGlobalRows () const override
	Get the number of global rows. More...

virtual globalIndex	numGlobalCols () const override
	Get the number of global columns. More...

virtual localIndex	numLocalRows () const override
	Get the number of local rows. More...

virtual localIndex	numLocalCols () const override
	Get the number of local columns. More...

virtual MPI_Comm	comm () const override
	Get the MPI communicator the matrix was created with. More...

Getters
localIndex	numBlockRows () const
	Get number of block rows. More...

localIndex	numBlockCols () const
	Get number of block columns. More...

OPERATOR const &	block (localIndex const blockRowIndex, localIndex const blockColIndex) const
	Get the operator corresponding to a sub-block. More...

OPERATOR &	block (localIndex const blockRowIndex, localIndex const blockColIndex)
	Get the operator corresponding to a sub-block. More...

OPERATOR const &	operator() (localIndex const blockRowIndex, localIndex const blockColIndex=0) const
	Get the operator corresponding to a sub-block. More...

OPERATOR &	operator() (localIndex const blockRowIndex, localIndex const blockColIndex=0)
	Get the operator corresponding to a sub-block. More...

Public Member Functions inherited from geos::LinearOperator< BlockVectorView< VECTOR > >
	LinearOperator ()=default
	Constructor.

virtual	~LinearOperator ()=default
	Destructor.

virtual void	residual (Vector const &x, Vector const &b, Vector &r) const
	Compute residual `r = b - this(x)`. More...

Protected Member Functions
	BlockOperatorView (localIndex const nRows, localIndex const nCols)
	Create an operator with given number of block rows and columns. More...

	BlockOperatorView (BlockOperatorView< VECTOR, OPERATOR > const &x)=default
	Copy constructor. More...

	BlockOperatorView (BlockOperatorView< VECTOR, OPERATOR > &&x)=default
	Move constructor. More...

void	setPointer (localIndex const blockRowIndex, localIndex const blockColIndex, OPERATOR *op)
	Set/replace a pointer to a block. More...

Detailed Description

template<typename VECTOR, typename OPERATOR = LinearOperator< VECTOR >>
class geos::BlockOperatorView< VECTOR, OPERATOR >

Abstract view of a block operator.

Template Parameters

VECTOR	type of vector that sub-blocks of this view can operate on
OPERATOR	type of operator that can operate on `VECTOR` (can be base class or a more specialized derived class)

This class does not deal with constructing or storing sub-blocks, only provides high-level access functions. See derived classes BlockOperator and BlockOperatorWrapper for ways to construct a block operator.

Definition at line 42 of file BlockOperatorView.hpp.

Constructor & Destructor Documentation

◆ BlockOperatorView() [1/3]

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

geos::BlockOperatorView< VECTOR, OPERATOR >::BlockOperatorView	(	localIndex const	nRows,
		localIndex const	nCols
	)

inlineprotected

Create an operator with given number of block rows and columns.

Parameters

nRows	number of block rows
nCols	number of block columns

Definition at line 257 of file BlockOperatorView.hpp.

◆ BlockOperatorView() [2/3]

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

geos::BlockOperatorView< VECTOR, OPERATOR >::BlockOperatorView ( BlockOperatorView< VECTOR, OPERATOR > const & x )

protecteddefault

Copy constructor.

Parameters

x	the block vector to copy

◆ BlockOperatorView() [3/3]

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

geos::BlockOperatorView< VECTOR, OPERATOR >::BlockOperatorView ( BlockOperatorView< VECTOR, OPERATOR > && x )

protecteddefault

Move constructor.

Parameters

x	the block vector to move from

Member Function Documentation

◆ apply()

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

virtual void geos::BlockOperatorView< VECTOR, OPERATOR >::apply	(	Vector const &	src,
		Vector &	dst
	)		const

inlineoverridevirtual

Apply operator to a vector.

Parameters

src	Input vector (x).
dst	Output vector (b).

Warning: src and dst cannot alias the same vector (some implementations may allow this).

Implements geos::LinearOperator< BlockVectorView< VECTOR > >.

Definition at line 89 of file BlockOperatorView.hpp.

◆ applyTranspose()

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

template<typename OP = OPERATOR>

std::enable_if_t< traits::VectorBasedTraits< Vector >::template HasMemberFunction_applyTranspose< OP > > geos::BlockOperatorView< VECTOR, OPERATOR >::applyTranspose	(	BlockVectorView< VECTOR > const &	src,
		BlockVectorView< VECTOR > &	dst
	)		const

inline

Apply the transpose of block operator to a block vector.

Template Parameters

OP	dummy template parameter to enable SFINAE, do not provide

Parameters

src	source vector (rhs)
dst	target vector (lhs)

Returns: nothing

Note: This method only exists if the underlying operator type has it.

Definition at line 118 of file BlockOperatorView.hpp.

◆ block() [1/2]

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

OPERATOR& geos::BlockOperatorView< VECTOR, OPERATOR >::block	(	localIndex const	blockRowIndex,
		localIndex const	blockColIndex
	)

inline

Get the operator corresponding to a sub-block.

Parameters

blockRowIndex	block row index
blockColIndex	block column index

Returns: a reference to the sub-block

Definition at line 226 of file BlockOperatorView.hpp.

◆ block() [2/2]

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

OPERATOR const& geos::BlockOperatorView< VECTOR, OPERATOR >::block	(	localIndex const	blockRowIndex,
		localIndex const	blockColIndex
	)		const

inline

Get the operator corresponding to a sub-block.

Parameters

blockRowIndex	block row index
blockColIndex	block column index

Returns: a reference to the sub-block

Definition at line 217 of file BlockOperatorView.hpp.

◆ comm()

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

virtual MPI_Comm geos::BlockOperatorView< VECTOR, OPERATOR >::comm ( ) const

inlineoverridevirtual

Get the MPI communicator the matrix was created with.

Returns: MPI communicator passed in create...()

Note: when build without MPI, may return anything (MPI_Comm will be a mock type defined in MpiWrapper)

Implements geos::LinearOperator< BlockVectorView< VECTOR > >.

Definition at line 181 of file BlockOperatorView.hpp.

◆ numBlockCols()

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

localIndex geos::BlockOperatorView< VECTOR, OPERATOR >::numBlockCols ( ) const

inline

Get number of block columns.

Returns: number of block columns

Definition at line 206 of file BlockOperatorView.hpp.

◆ numBlockRows()

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

localIndex geos::BlockOperatorView< VECTOR, OPERATOR >::numBlockRows ( ) const

inline

Get number of block rows.

Returns: number of block rows

Definition at line 197 of file BlockOperatorView.hpp.

◆ numGlobalCols()

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

virtual globalIndex geos::BlockOperatorView< VECTOR, OPERATOR >::numGlobalCols ( ) const

inlineoverridevirtual

Get the number of global columns.

Returns: Number of global columns in the operator.

Implements geos::LinearOperator< BlockVectorView< VECTOR > >.

Definition at line 149 of file BlockOperatorView.hpp.

◆ numGlobalRows()

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

virtual globalIndex geos::BlockOperatorView< VECTOR, OPERATOR >::numGlobalRows ( ) const

inlineoverridevirtual

Get the number of global rows.

Returns: Number of global rows in the operator.

Implements geos::LinearOperator< BlockVectorView< VECTOR > >.

Definition at line 140 of file BlockOperatorView.hpp.

◆ numLocalCols()

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

virtual localIndex geos::BlockOperatorView< VECTOR, OPERATOR >::numLocalCols ( ) const

inlineoverridevirtual

Get the number of local columns.

Returns: Number of local columns in the operator.

Note: Method only exists if the underlying operator type has it.

Implements geos::LinearOperator< BlockVectorView< VECTOR > >.

Definition at line 169 of file BlockOperatorView.hpp.

◆ numLocalRows()

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

virtual localIndex geos::BlockOperatorView< VECTOR, OPERATOR >::numLocalRows ( ) const

inlineoverridevirtual

Get the number of local rows.

Returns: Number of local rows in the operator.

Note: Method only exists if the underlying operator type has it.

Implements geos::LinearOperator< BlockVectorView< VECTOR > >.

Definition at line 159 of file BlockOperatorView.hpp.

◆ operator()() [1/2]

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

OPERATOR& geos::BlockOperatorView< VECTOR, OPERATOR >::operator()	(	localIndex const	blockRowIndex,
		localIndex const	blockColIndex = `0`
	)

inline

Get the operator corresponding to a sub-block.

Parameters

blockRowIndex	block row index
blockColIndex	block column index

Returns: a reference to the sub-block

Definition at line 243 of file BlockOperatorView.hpp.

◆ operator()() [2/2]

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

OPERATOR const& geos::BlockOperatorView< VECTOR, OPERATOR >::operator()	(	localIndex const	blockRowIndex,
		localIndex const	blockColIndex = `0`
	)		const

inline

Get the operator corresponding to a sub-block.

Parameters

blockRowIndex	block row index
blockColIndex	block column index

Returns: a reference to the sub-block

Definition at line 235 of file BlockOperatorView.hpp.

◆ operator=() [1/2]

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

BlockOperatorView& geos::BlockOperatorView< VECTOR, OPERATOR >::operator= ( BlockOperatorView< VECTOR, OPERATOR > && )

delete

Deleted move assignment.

Returns: not callable

◆ operator=() [2/2]

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

BlockOperatorView& geos::BlockOperatorView< VECTOR, OPERATOR >::operator= ( BlockOperatorView< VECTOR, OPERATOR > const & )

delete

Deleted copy assignment.

Returns: not callable

◆ setPointer()

template<typename VECTOR , typename OPERATOR = LinearOperator< VECTOR >>

void geos::BlockOperatorView< VECTOR, OPERATOR >::setPointer	(	localIndex const	blockRowIndex,
		localIndex const	blockColIndex,
		OPERATOR *	op
	)

inlineprotected

Set/replace a pointer to a block.

Parameters

blockRowIndex	row index of the block
blockColIndex	column index of the block
op	the new pointer

Definition at line 282 of file BlockOperatorView.hpp.

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

coreComponents/linearAlgebra/utilities/BlockOperatorView.hpp

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

template<typename VECTOR, typename OPERATOR = LinearOperator< VECTOR >> class geos::BlockOperatorView< VECTOR, OPERATOR >

Constructor & Destructor Documentation

◆ BlockOperatorView() [1/3]

◆ BlockOperatorView() [2/3]

◆ BlockOperatorView() [3/3]

Member Function Documentation

◆ apply()

◆ applyTranspose()

◆ block() [1/2]

◆ block() [2/2]

◆ comm()

◆ numBlockCols()

◆ numBlockRows()

◆ numGlobalCols()

◆ numGlobalRows()

◆ numLocalCols()

◆ numLocalRows()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setPointer()

template<typename VECTOR, typename OPERATOR = LinearOperator< VECTOR >>
class geos::BlockOperatorView< VECTOR, OPERATOR >