Simple example subclass for Spmd tridiagonal matrices. More...

#include <ExampleTridiagSpmdLinearOp.hpp>

Inheritance diagram for ExampleTridiagSpmdLinearOp< Scalar >:

Public Member Functions
	ExampleTridiagSpmdLinearOp ()
	ExampleTridiagSpmdLinearOp (const Teuchos::RCP< const Teuchos::Comm< Thyra::Ordinal > > &comm, const Thyra::Ordinal localDim, const Teuchos::ArrayView< const Scalar > &lower, const Teuchos::ArrayView< const Scalar > &diag, const Teuchos::ArrayView< const Scalar > &upper)
void	initialize (const Teuchos::RCP< const Teuchos::Comm< Thyra::Ordinal > > &comm, const Thyra::Ordinal localDim, const Teuchos::ArrayView< const Scalar > &lower, const Teuchos::ArrayView< const Scalar > &diag, const Teuchos::ArrayView< const Scalar > &upper)
Protected Member Functions
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	range () const

Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	domain () const

bool	opSupportedImpl (Thyra::EOpTransp M_trans) const

void	applyImpl (const Thyra::EOpTransp M_trans, const Thyra::MultiVectorBase< Scalar > &X_in, const Teuchos::Ptr< Thyra::MultiVectorBase< Scalar > > &Y_inout, const Scalar alpha, const Scalar beta) const

Private Member Functions
void	communicate (const bool first, const bool last, const Teuchos::ArrayView< const Scalar > &x, const Teuchos::Ptr< Scalar > &x_km1, const Teuchos::Ptr< Scalar > &x_kp1) const
Private Attributes
Teuchos::RCP< const Teuchos::Comm< Thyra::Ordinal > >	comm_
Teuchos::RCP< const Thyra::SpmdVectorSpaceBase < Scalar > >	space_
Teuchos::Array< Scalar >	lower_
Teuchos::Array< Scalar >	diag_
Teuchos::Array< Scalar >	upper_

Detailed Description

template<class Scalar>
class ExampleTridiagSpmdLinearOp< Scalar >

Simple example subclass for Spmd tridiagonal matrices.

This subclass represents a linear operator for tridiagonal matrices of the global form:

$M= \left[\begin{array}{ccccc} d_{(1)} & u_{(1)} \\ l_{(1)} & d_{(2)} & u_{(2)} \\ & \ddots & \ddots & \ddots \\ & & l_{(n-2)} & d_{(n-1)} & u_{(n-1)} \\ & & & l_{(n-1)} & d_{(n)} \end{array}\right].$

If there is only $N = 1$ processes then the arrays lower[], diag[], and upper[] of dimension localDim-1, localDim and localDim-1 respectively are stored (see initialize()).

If there $N > 1$ processes then locally this class stores slightly different arrays of data depending on which process this is and process-to-process communication is required.

On process 0 with local vector elements the following sub-matrix is stored:

$\left[\begin{array}{cccccc} d_{(1)} & u_{(1)} \\ l_{(1)} & d_{(2)} & u_{(2)} \\ & \ddots & \ddots & \ddots \\ & & l_{(n_0-2)} & d_{(n_0-1)} & u_{(n_0-1)} \\ & & & l_{(n_0-1)} & d_{(n_0)} & u_{(n_0)} \end{array}\right].$

In this case, arrays lower[], diag[], and upper[] of dimension localDim-1, localDim and localDim respectively are stored (see initialize()).
On process , where , with local offset and local vector elements the following sub-matrix is stored:

$\left[\begin{array}{cccccc} l_{(g_i)} & d_{(g_i+1)} & u_{(g_i+1)} \\ & \ddots & \ddots & \ddots \\ & & & l_{(g_i+n_i-1)} & d_{(g_i+n_i)} & u_{(g_i+n_i)} \end{array}\right].$

In this case, arrays lower[], diag[], and upper[] of dimension localDim, localDim and localDim respectively are stored (see initialize()).
On process with local offset $g_{N-1}$ and $n_{N-1}$ local vector elements the following sub-matrix is stored:

$\left[\begin{array}{cccccc} l_{(g_{N-1})} & d_{(g_{N-1}+1)} & u_{(g_{N-1}+1)} \\ & \ddots & \ddots & \ddots \\ & & & l_{(g_{N-1}+n_{N-1}-1)} & d_{(g_{N-1}+n_{N-1})} \end{array}\right].$

In this case, arrays lower[], diag[], and upper[] of dimension localDim, localDim and localDim-1 respectively are stored (see initialize()).

See the source code for this simple example by clicking on the link to the definition below.

Definition at line 130 of file ExampleTridiagSpmdLinearOp.hpp.

Constructor & Destructor Documentation

template<class Scalar >

ExampleTridiagSpmdLinearOp< Scalar >::ExampleTridiagSpmdLinearOp ( ) [inline]

Construct to uninitialized.

Definition at line 134 of file ExampleTridiagSpmdLinearOp.hpp.

template<class Scalar >

ExampleTridiagSpmdLinearOp< Scalar >::ExampleTridiagSpmdLinearOp	(	const Teuchos::RCP< const Teuchos::Comm< Thyra::Ordinal > > &	comm,
		const Thyra::Ordinal	localDim,
		const Teuchos::ArrayView< const Scalar > &	lower,
		const Teuchos::ArrayView< const Scalar > &	diag,
		const Teuchos::ArrayView< const Scalar > &	upper
	)		`[inline]`

Calls initialize().

Definition at line 137 of file ExampleTridiagSpmdLinearOp.hpp.

References ExampleTridiagSpmdLinearOp< Scalar >::initialize().

Member Function Documentation

template<class Scalar >

void ExampleTridiagSpmdLinearOp< Scalar >::initialize	(	const Teuchos::RCP< const Teuchos::Comm< Thyra::Ordinal > > &	comm,
		const Thyra::Ordinal	localDim,
		const Teuchos::ArrayView< const Scalar > &	lower,
		const Teuchos::ArrayView< const Scalar > &	diag,
		const Teuchos::ArrayView< const Scalar > &	upper
	)

Initialize given lower, diagonal and upper arrays of data.

Parameters:

comm	[in] Communicator (allowed to be Teuchos::null)
localDim	[in] Dimension of this matrix (must be >= 2).
lower	[in] Array (length `( procRank == 0 ? localDim - 1 : localDim )`) of the lower diagonal elements
diag	[in] Array (length `localDim`) of the central diagonal elements
upper	[in] Array (length `( procRank == numProc-1 ? localDim - 1 : localDim )`) of the upper diagonal elements

Preconditions:

localDim >= 2

Postconditions:

Should be obvious!

Definition at line 219 of file ExampleTridiagSpmdLinearOp.hpp.

Referenced by ExampleTridiagSpmdLinearOp< Scalar >::ExampleTridiagSpmdLinearOp().

template<class Scalar >

Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > ExampleTridiagSpmdLinearOp< Scalar >::range ( ) const [inline, protected, virtual]

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 180 of file ExampleTridiagSpmdLinearOp.hpp.

References ExampleTridiagSpmdLinearOp< Scalar >::space_.

template<class Scalar >

Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > ExampleTridiagSpmdLinearOp< Scalar >::domain ( ) const [inline, protected, virtual]

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 184 of file ExampleTridiagSpmdLinearOp.hpp.

References ExampleTridiagSpmdLinearOp< Scalar >::space_.

template<class Scalar >

bool ExampleTridiagSpmdLinearOp< Scalar >::opSupportedImpl ( Thyra::EOpTransp M_trans ) const [inline, protected, virtual]

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 188 of file ExampleTridiagSpmdLinearOp.hpp.

References Thyra::NOTRANS.

template<class Scalar >

void ExampleTridiagSpmdLinearOp< Scalar >::applyImpl	(	const Thyra::EOpTransp	M_trans,
		const Thyra::MultiVectorBase< Scalar > &	X_in,
		const Teuchos::Ptr< Thyra::MultiVectorBase< Scalar > > &	Y_inout,
		const Scalar	alpha,
		const Scalar	beta
	)		const `[protected]`

Definition at line 237 of file ExampleTridiagSpmdLinearOp.hpp.

References Thyra::MultiVectorBase< Scalar >::col(), Thyra::LinearOpBase< Scalar >::domain(), Thyra::LinearOpBase< Scalar >::opSupported(), Thyra::DetachedSpmdVectorView< Scalar >::sv(), and Thyra::DefaultZeroLinearOp< Scalar >::zero().

template<class Scalar >

void ExampleTridiagSpmdLinearOp< Scalar >::communicate	(	const bool	first,
		const bool	last,
		const Teuchos::ArrayView< const Scalar > &	x,
		const Teuchos::Ptr< Scalar > &	x_km1,
		const Teuchos::Ptr< Scalar > &	x_kp1
	)		const `[private]`