Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Functions
Methods required by the <code>GlobalIndexer</code> interface

Functions

virtual Teuchos::RCP
< Teuchos::Comm< int > > 
panzer::BlockedDOFManager::getComm () const
 
int panzer::BlockedDOFManager::getFieldNum (const std::string &str) const
 Get the number used for access to this field. More...
 
const std::string & panzer::BlockedDOFManager::getFieldString (int num) const
 Get the string name associated with a field number. More...
 
virtual void panzer::BlockedDOFManager::getElementBlockIds (std::vector< std::string > &elementBlockIds) const
 
virtual bool panzer::BlockedDOFManager::fieldInBlock (const std::string &field, const std::string &block) const
 
virtual const std::vector
< LocalOrdinal > & 
panzer::BlockedDOFManager::getElementBlock (const std::string &blockId) const
 
virtual const std::vector< int > & panzer::BlockedDOFManager::getBlockFieldNumbers (const std::string &block) const
 
void panzer::BlockedDOFManager::getElementGIDs (panzer::LocalOrdinal localElmtId, std::vector< GlobalOrdinal > &gids, const std::string &blockIdHint="") const
 Get the global IDs for a particular element. This function overwrites the gids variable. More...
 
void panzer::BlockedDOFManager::getElementGIDsPair (panzer::LocalOrdinal localElmtId, std::vector< std::pair< int, GlobalOrdinal >> &gids, const std::string &blockIdHint="") const
 Get the global IDs for a particular element. This function overwrites the gids variable. More...
 
virtual void panzer::BlockedDOFManager::getElementOrientation (panzer::LocalOrdinal localElmtId, std::vector< double > &gidsOrientation) const
 Get a vector containg the orientation of the GIDs relative to the neighbors. More...
 
virtual const std::vector< int > & panzer::BlockedDOFManager::getGIDFieldOffsets (const std::string &blockId, int fieldNum) const
 Use the field pattern so that you can find a particular field in the GIDs array. More...
 
virtual const std::pair
< std::vector< int >
, std::vector< int > > & 
panzer::BlockedDOFManager::getGIDFieldOffsets_closure (const std::string &blockId, int fieldNum, int subcellDim, int subcellId) const
 Use the field pattern so that you can find a particular field in the GIDs array. This version lets you specify the sub cell you are interested in and gets the closure. Meaning all the IDs of equal or lesser sub cell dimension that are contained within the specified sub cell. For instance for an edge, this function would return offsets for the edge and the nodes on that edge. The first vector returned contains the index into the GIDs array. The second vector specifies the basis function IDs. More...
 
virtual void panzer::BlockedDOFManager::getOwnedIndices (std::vector< GlobalOrdinal > &indices) const
 Get the set of indices owned by this processor. More...
 
virtual void panzer::BlockedDOFManager::getGhostedIndices (std::vector< GlobalOrdinal > &indices) const
 Get the set of indices ghosted for this processor. More...
 
virtual void panzer::BlockedDOFManager::getOwnedAndGhostedIndices (std::vector< GlobalOrdinal > &indices) const
 Get the set of owned and ghosted indices for this processor. More...
 
void panzer::BlockedDOFManager::getElementGIDsAsInt (panzer::LocalOrdinal localElmtId, std::vector< int > &gids, const std::string &blockIdHint="") const
 Get the global IDs for a particular element. This function overwrites the gids variable. More...
 
virtual void panzer::BlockedDOFManager::getOwnedIndicesAsInt (std::vector< int > &indices) const
 Get the set of indices owned by this processor. More...
 
virtual void panzer::BlockedDOFManager::getGhostedIndicesAsInt (std::vector< int > &indices) const
 Get the set of indices ghosted for this processor. More...
 
virtual void panzer::BlockedDOFManager::getOwnedAndGhostedIndicesAsInt (std::vector< int > &indices) const
 Get the set of owned and ghosted indices for this processor. More...
 
virtual int panzer::BlockedDOFManager::getNumOwned () const
 Get the number of indices owned by this processor. More...
 
virtual int panzer::BlockedDOFManager::getNumGhosted () const
 Get the number of indices ghosted for this processor. More...
 
virtual int panzer::BlockedDOFManager::getNumOwnedAndGhosted () const
 Get the number of owned and ghosted indices for this processor. More...
 
virtual void panzer::BlockedDOFManager::ownedIndices (const std::vector< GlobalOrdinal > &indices, std::vector< bool > &isOwned) const
 

Detailed Description

Function Documentation

virtual Teuchos::RCP<Teuchos::Comm<int> > panzer::BlockedDOFManager::getComm ( ) const
inlinevirtual

Get communicator associated with this manager.

Implements panzer::GlobalIndexer.

Definition at line 61 of file Panzer_BlockedDOFManager.hpp.

int panzer::BlockedDOFManager::getFieldNum ( const std::string &  str) const
virtual

Get the number used for access to this field.

Get the number used for access to this field. This is used as the input parameter to the other functions that provide access to the global unknowns.

Parameters
[in]strHuman readable name of the field
Returns
A unique integer associated with the field if the field exisits. Otherwise a -1 is returned.

Implements panzer::GlobalIndexer.

Definition at line 43 of file Panzer_BlockedDOFManager.cpp.

const std::string & panzer::BlockedDOFManager::getFieldString ( int  num) const
virtual

Get the string name associated with a field number.

Get the string used for access to this field.

Parameters
[in]intA unique integer associated with the field.
Returns
Human readable name of the field
Note
This method will throw if invalid field number is passed in as an argument.

Implements panzer::GlobalIndexer.

Definition at line 58 of file Panzer_BlockedDOFManager.cpp.

virtual void panzer::BlockedDOFManager::getElementBlockIds ( std::vector< std::string > &  elementBlockIds) const
inlinevirtual

What are the blockIds included in this connection manager?

Implements panzer::GlobalIndexer.

Definition at line 97 of file Panzer_BlockedDOFManager.hpp.

bool panzer::BlockedDOFManager::fieldInBlock ( const std::string &  field,
const std::string &  block 
) const
virtual

Is the specified field in the element block?

Implements panzer::GlobalIndexer.

Definition at line 74 of file Panzer_BlockedDOFManager.cpp.

virtual const std::vector<LocalOrdinal>& panzer::BlockedDOFManager::getElementBlock ( const std::string &  blockId) const
inlinevirtual

Get the local element IDs for a paricular element block.

Parameters
[in]blockIdBlock ID
Returns
Vector of local element IDs.

Implements panzer::GlobalIndexer.

Definition at line 111 of file Panzer_BlockedDOFManager.hpp.

const std::vector< int > & panzer::BlockedDOFManager::getBlockFieldNumbers ( const std::string &  block) const
virtual

Get field numbers associated with a particular element block.

Implements panzer::GlobalIndexer.

Definition at line 89 of file Panzer_BlockedDOFManager.cpp.

void panzer::BlockedDOFManager::getElementGIDs ( panzer::LocalOrdinal  localElmtId,
std::vector< GlobalOrdinal > &  gids,
const std::string &  blockIdHint = "" 
) const
virtual

Get the global IDs for a particular element. This function overwrites the gids variable.

Implements panzer::GlobalIndexer.

Definition at line 101 of file Panzer_BlockedDOFManager.cpp.

void panzer::BlockedDOFManager::getElementGIDsPair ( panzer::LocalOrdinal  localElmtId,
std::vector< std::pair< int, GlobalOrdinal >> &  gids,
const std::string &  blockIdHint = "" 
) const

Get the global IDs for a particular element. This function overwrites the gids variable.

The pair consists of the field block index (pair.first) and the corresponding gid (pair.second) within that field block. The field block is used to access the sub-DOFManager that the field is assigned to.

NOTE: This function is temporary and is only used by the Epetra Blocked Gather/Scatters. It is an inefficient path to access data and has been deprecated. When Epetra support is dropped, this function will be removed.

Definition at line 125 of file Panzer_BlockedDOFManager.cpp.

void panzer::BlockedDOFManager::getElementOrientation ( panzer::LocalOrdinal  localElmtId,
std::vector< double > &  gidsOrientation 
) const
virtual

Get a vector containg the orientation of the GIDs relative to the neighbors.

Implements panzer::GlobalIndexer.

Definition at line 148 of file Panzer_BlockedDOFManager.cpp.

const std::vector< int > & panzer::BlockedDOFManager::getGIDFieldOffsets ( const std::string &  blockId,
int  fieldNum 
) const
virtual

Use the field pattern so that you can find a particular field in the GIDs array.

Implements panzer::GlobalIndexer.

Definition at line 171 of file Panzer_BlockedDOFManager.cpp.

const std::pair< std::vector< int >, std::vector< int > > & panzer::BlockedDOFManager::getGIDFieldOffsets_closure ( const std::string &  blockId,
int  fieldNum,
int  subcellDim,
int  subcellId 
) const
virtual

Use the field pattern so that you can find a particular field in the GIDs array. This version lets you specify the sub cell you are interested in and gets the closure. Meaning all the IDs of equal or lesser sub cell dimension that are contained within the specified sub cell. For instance for an edge, this function would return offsets for the edge and the nodes on that edge. The first vector returned contains the index into the GIDs array. The second vector specifies the basis function IDs.

Parameters
[in]blockId
[in]fieldNum
[in]subcellDim
[in]subcellId

Implements panzer::GlobalIndexer.

Definition at line 237 of file Panzer_BlockedDOFManager.cpp.

void panzer::BlockedDOFManager::getOwnedIndices ( std::vector< GlobalOrdinal > &  indices) const
virtual

Get the set of indices owned by this processor.

Parameters
[out]indicesA vector that will be filled with the indices owned by this processor.

Implements panzer::GlobalIndexer.

Definition at line 289 of file Panzer_BlockedDOFManager.cpp.

void panzer::BlockedDOFManager::getGhostedIndices ( std::vector< GlobalOrdinal > &  indices) const
virtual

Get the set of indices ghosted for this processor.

Parameters
[out]indicesA vector that will be filled with the indices ghosted for this processor.

Implements panzer::GlobalIndexer.

Definition at line 309 of file Panzer_BlockedDOFManager.cpp.

void panzer::BlockedDOFManager::getOwnedAndGhostedIndices ( std::vector< GlobalOrdinal > &  indices) const
virtual

Get the set of owned and ghosted indices for this processor.

Parameters
[out]indicesA vector that will be filled with the owned and ghosted indices for this processor.

Implements panzer::GlobalIndexer.

Definition at line 329 of file Panzer_BlockedDOFManager.cpp.

void panzer::BlockedDOFManager::getElementGIDsAsInt ( panzer::LocalOrdinal  localElmtId,
std::vector< int > &  gids,
const std::string &  blockIdHint = "" 
) const
virtual

Get the global IDs for a particular element. This function overwrites the gids variable.

Implements panzer::GlobalIndexer.

Definition at line 346 of file Panzer_BlockedDOFManager.cpp.

void panzer::BlockedDOFManager::getOwnedIndicesAsInt ( std::vector< int > &  indices) const
virtual

Get the set of indices owned by this processor.

Parameters
[out]Avector that will be filled with the indices owned by this processor.

Implements panzer::GlobalIndexer.

Definition at line 371 of file Panzer_BlockedDOFManager.cpp.

void panzer::BlockedDOFManager::getGhostedIndicesAsInt ( std::vector< int > &  indices) const
virtual

Get the set of indices ghosted for this processor.

Parameters
[out]Avector that will be filled with the indices ghosted for this processor.

Implements panzer::GlobalIndexer.

Definition at line 387 of file Panzer_BlockedDOFManager.cpp.

void panzer::BlockedDOFManager::getOwnedAndGhostedIndicesAsInt ( std::vector< int > &  indices) const
virtual

Get the set of owned and ghosted indices for this processor.

Parameters
[out]Avector that will be filled with the owned and ghosted indices for this processor.

Implements panzer::GlobalIndexer.

Definition at line 403 of file Panzer_BlockedDOFManager.cpp.

int panzer::BlockedDOFManager::getNumOwned ( ) const
virtual

Get the number of indices owned by this processor.

Returns
The number of indices owned by this processor.

Implements panzer::GlobalIndexer.

Definition at line 424 of file Panzer_BlockedDOFManager.cpp.

int panzer::BlockedDOFManager::getNumGhosted ( ) const
virtual

Get the number of indices ghosted for this processor.

Returns
The number of indices ghosted for this processor.

Implements panzer::GlobalIndexer.

Definition at line 438 of file Panzer_BlockedDOFManager.cpp.

int panzer::BlockedDOFManager::getNumOwnedAndGhosted ( ) const
virtual

Get the number of owned and ghosted indices for this processor.

Returns
The number of owned and ghosted indices for this processor.

Implements panzer::GlobalIndexer.

Definition at line 452 of file Panzer_BlockedDOFManager.cpp.

void panzer::BlockedDOFManager::ownedIndices ( const std::vector< GlobalOrdinal > &  indices,
std::vector< bool > &  isOwned 
) const
virtual

Get a yes/no on ownership for each index in a vector

Implements panzer::GlobalIndexer.

Definition at line 461 of file Panzer_BlockedDOFManager.cpp.