Teko Version of the Day
Loading...
Searching...
No Matches
Teko::BlockReorderLeaf Class Reference

#include <Teko_BlockedReordering.hpp>

Inheritance diagram for Teko::BlockReorderLeaf:

Constructors

int value_
 The value of the index for this leaf.
 BlockReorderLeaf (int ind)
 Simple constructor that sets the index.
 BlockReorderLeaf (const BlockReorderLeaf &brl)
 Copy constructor.
virtual Teuchos::RCP< BlockReorderManagerCopy () const
 Make a copy of this object.
virtual int GetNumBlocks () const
 Get the number of subblocks (this one returns 0 b/c its a leaf).
virtual void SetNumBlocks (int)
 Set the number of subblocks (this one does nothing b/c its a leaf).
virtual void SetBlock (int, int)
 Set the sub block, this does nothing b/c its a leaf.
virtual const Teuchos::RCP< BlockReorderManagerGetBlock (int)
 Get a particular subblock...this returns null.
virtual const Teuchos::RCP< const BlockReorderManagerGetBlock (int) const
 Get a particular subblock...this returns null.
int GetIndex () const
 Get the the index that is stored in this block.
virtual std::string toString () const
 Return a string description of this leaf class.
virtual int LargestIndex () const
 Largest index in this manager.
virtual void SetBlock (int blockIndex, const Teuchos::RCP< BlockReorderManager > &reorder)
 Set the subblock to a use a particular reorder manager.

Additional Inherited Members

 BlockReorderManager ()
 Basic empty constructor.
 BlockReorderManager (int sz)
 Set this level to have size sz.
 BlockReorderManager (const BlockReorderManager &bmm)
 Copy constructor.
virtual ~BlockReorderManager ()
 Do nothing destructor.
std::vector< Teuchos::RCP< BlockReorderManager > > children_
 Definitions of the subblocks.

Detailed Description

A class that corresponds to the leaf, or stopping critera for BlockReorderManager. This class should not be used directly.

Definition at line 179 of file Teko_BlockedReordering.hpp.

Constructor & Destructor Documentation

◆ BlockReorderLeaf() [1/2]

Teko::BlockReorderLeaf::BlockReorderLeaf ( int ind)
inline

Simple constructor that sets the index.

Definition at line 185 of file Teko_BlockedReordering.hpp.

◆ BlockReorderLeaf() [2/2]

Teko::BlockReorderLeaf::BlockReorderLeaf ( const BlockReorderLeaf & brl)
inline

Copy constructor.

Definition at line 188 of file Teko_BlockedReordering.hpp.

Member Function Documentation

◆ Copy()

virtual Teuchos::RCP< BlockReorderManager > Teko::BlockReorderLeaf::Copy ( ) const
inlinevirtual

Make a copy of this object.

Reimplemented from Teko::BlockReorderManager.

Definition at line 192 of file Teko_BlockedReordering.hpp.

◆ GetNumBlocks()

virtual int Teko::BlockReorderLeaf::GetNumBlocks ( ) const
inlinevirtual

Get the number of subblocks (this one returns 0 b/c its a leaf).

Reimplemented from Teko::BlockReorderManager.

Definition at line 197 of file Teko_BlockedReordering.hpp.

◆ SetNumBlocks()

virtual void Teko::BlockReorderLeaf::SetNumBlocks ( int )
inlinevirtual

Set the number of subblocks (this one does nothing b/c its a leaf).

Reimplemented from Teko::BlockReorderManager.

Definition at line 200 of file Teko_BlockedReordering.hpp.

◆ SetBlock() [1/2]

virtual void Teko::BlockReorderLeaf::SetBlock ( int ,
int  )
inlinevirtual

Set the sub block, this does nothing b/c its a leaf.

Reimplemented from Teko::BlockReorderManager.

Definition at line 203 of file Teko_BlockedReordering.hpp.

◆ GetBlock() [1/2]

virtual const Teuchos::RCP< BlockReorderManager > Teko::BlockReorderLeaf::GetBlock ( int )
inlinevirtual

Get a particular subblock...this returns null.

Reimplemented from Teko::BlockReorderManager.

Definition at line 206 of file Teko_BlockedReordering.hpp.

◆ GetBlock() [2/2]

virtual const Teuchos::RCP< const BlockReorderManager > Teko::BlockReorderLeaf::GetBlock ( int ) const
inlinevirtual

Get a particular subblock...this returns null.

Reimplemented from Teko::BlockReorderManager.

Definition at line 211 of file Teko_BlockedReordering.hpp.

◆ GetIndex()

int Teko::BlockReorderLeaf::GetIndex ( ) const
inline

Get the the index that is stored in this block.

Definition at line 216 of file Teko_BlockedReordering.hpp.

◆ toString()

virtual std::string Teko::BlockReorderLeaf::toString ( ) const
inlinevirtual

Return a string description of this leaf class.

Reimplemented from Teko::BlockReorderManager.

Definition at line 219 of file Teko_BlockedReordering.hpp.

◆ LargestIndex()

virtual int Teko::BlockReorderLeaf::LargestIndex ( ) const
inlinevirtual

Largest index in this manager.

Reimplemented from Teko::BlockReorderManager.

Definition at line 226 of file Teko_BlockedReordering.hpp.

◆ SetBlock() [2/2]

virtual void Teko::BlockReorderManager::SetBlock ( int blockIndex,
const Teuchos::RCP< BlockReorderManager > & reorder )
protectedvirtual

Set the subblock to a use a particular reorder manager.

Set the subblock to a use a particular reorder manager. This facilitates recursive construction algorithms where the base case is not differentiated.

Parameters
[in]blockIndexSubblock to be set
[in]reorderReorder manager to be used in this block
Precondition
blockIndex<this->GetNumBlocks()

Reimplemented from Teko::BlockReorderManager.

Member Data Documentation

◆ value_

int Teko::BlockReorderLeaf::value_
protected

The value of the index for this leaf.

Definition at line 232 of file Teko_BlockedReordering.hpp.


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