ExampleTridiagSpmdLinearOp< Scalar > Class Template Reference

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

#include <ExampleTridiagSpmdLinearOp.hpp>

Inheritance diagram for ExampleTridiagSpmdLinearOp< Scalar >:

Inheritance graph
[legend]
List of all members.

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
 

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.

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.


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:

Postconditions:

Definition at line 219 of file ExampleTridiagSpmdLinearOp.hpp.

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.

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.

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.

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, virtual]

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 237 of file ExampleTridiagSpmdLinearOp.hpp.


The documentation for this class was generated from the following file:
Generated on Tue Jul 13 09:26:25 2010 for Thyra by  doxygen 1.4.7