#include <Panzer_BlockedDOFManager.hpp>

Inheritance diagram for panzer::BlockedDOFManager:

Classes
struct	LessThan

Public Types
using	GlobalOrdinal = panzer::GlobalOrdinal

using	LocalOrdinal = panzer::LocalOrdinal

using	const_field_iterator = std::map< int, std::string >::const_iterator

Public Member Functions
virtual	~BlockedDOFManager ()

	BlockedDOFManager ()

	BlockedDOFManager (const Teuchos::RCP< ConnManager > &connMngr, MPI_Comm mpiComm)

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

int	getFieldNum (const std::string &str) const
	Get the number used for access to this field.

const std::string &	getFieldString (int num) const
	Get the string name associated with a field number.

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

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

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

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

void	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.

void	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.

virtual void	getElementOrientation (panzer::LocalOrdinal localElmtId, std::vector< double > &gidsOrientation) const
	Get a vector containg the orientation of the GIDs relative to the neighbors.

virtual const std::vector< int > &	getGIDFieldOffsets (const std::string &blockId, int fieldNum) const
	Use the field pattern so that you can find a particular field in the GIDs array.

virtual const std::pair< std::vector< int >, std::vector< int > > &	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.

virtual void	getOwnedIndices (std::vector< GlobalOrdinal > &indices) const
	Get the set of indices owned by this processor.

virtual void	getGhostedIndices (std::vector< GlobalOrdinal > &indices) const
	Get the set of indices ghosted for this processor.

virtual void	getOwnedAndGhostedIndices (std::vector< GlobalOrdinal > &indices) const
	Get the set of owned and ghosted indices for this processor.

void	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.

virtual void	getOwnedIndicesAsInt (std::vector< int > &indices) const
	Get the set of indices owned by this processor.

virtual void	getGhostedIndicesAsInt (std::vector< int > &indices) const
	Get the set of indices ghosted for this processor.

virtual void	getOwnedAndGhostedIndicesAsInt (std::vector< int > &indices) const
	Get the set of owned and ghosted indices for this processor.

virtual int	getNumOwned () const
	Get the number of indices owned by this processor.

virtual int	getNumGhosted () const
	Get the number of indices ghosted for this processor.

virtual int	getNumOwnedAndGhosted () const
	Get the number of owned and ghosted indices for this processor.

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

void	setUseDOFManagerFEI (bool useFEI)
	Use the FEI DOF manager internally, or the standard version.

bool	getUseDOFManagerFEI () const
	which DOF Manager is used internally?

void	setConnManager (const Teuchos::RCP< ConnManager > &connMngr, MPI_Comm mpiComm)
	Set the connection manager and MPI_Comm objects.

Teuchos::RCP< const FieldPattern >	getGeometricFieldPattern () const

Teuchos::RCP< ConnManager >	resetIndices ()
	Reset the indicies for this DOF manager.

void	addField (const std::string &str, const Teuchos::RCP< const FieldPattern > &pattern)
	Add a field to the DOF manager.

void	addField (const std::string &blockId, const std::string &str, const Teuchos::RCP< const FieldPattern > &pattern)

void	setFieldOrder (const std::vector< std::vector< std::string > > &fieldOrder)

int	getNumFieldBlocks () const

void	getFieldOrder (std::vector< std::vector< std::string > > &fieldOrder) const

void	getFieldOrder (std::vector< std::string > &) const

Teuchos::RCP< const FieldPattern >	getFieldPattern (const std::string &blockId, const std::string &fieldName) const
	Find a field pattern stored for a particular block and field number. This will retrive the pattern added with `addField(blockId,fieldNum)`.

int	getNumFields () const
	How many fields are handled by this manager.

Teuchos::RCP< const ConnManager >	getConnManager () const

Teuchos::RCP< ConnManager >	getConnManager ()

virtual void	buildGlobalUnknowns ()

virtual void	buildGlobalUnknowns (const Teuchos::RCP< const FieldPattern > &geomPattern)

virtual void	buildGlobalUnknowns (const std::vector< Teuchos::RCP< GlobalIndexer > > &fieldBlockManagers)

void	printFieldInformation (std::ostream &os) const

bool	validFieldOrder (const std::vector< std::vector< std::string > > &fieldOrder_ut, const std::set< std::string > &fields) const

void	registerFields (bool buildSubUGIs)

bool	fieldsRegistered () const

const std::vector< Teuchos::RCP< GlobalIndexer > > &	getFieldDOFManagers () const

int	getMaxSubFieldNumber () const

int	getFieldBlock (int fieldNum) const

int	getBlockGIDOffset (const std::string &elementBlock, int fieldBlock) const

bool	getOrientationsRequired () const

void	setOrientationsRequired (bool ro)

void	enableTieBreak (bool useTieBreak)

virtual int	getElementBlockGIDCount (const std::string &blockId) const
	How any GIDs are associate with a particular element block.

virtual int	getElementBlockGIDCount (const std::size_t &blockIndex) const
	How any GIDs are associate with a particular element block.

Public Member Functions inherited from panzer::GlobalIndexer
virtual	~GlobalIndexer ()
	Pure virtual destructor: prevents warnings with inline empty implementation.

const Kokkos::View< const panzer::LocalOrdinal *, Kokkos::LayoutRight, PHX::Device >	getElementLIDs (panzer::LocalOrdinal localElmtId) const

const Kokkos::View< const panzer::LocalOrdinal **, Kokkos::LayoutRight, PHX::Device >	getLIDs () const

template<typename ArrayT >
void	getElementLIDs (PHX::View< const int * > cellIds, ArrayT lids, const int num_dofs=0) const

Protected Types
typedef std::map< Teuchos::Tuple< int, 3 >, std::pair< std::vector< int >, std::vector< int > >, LessThan >	TupleToVectorPairMap

Protected Member Functions
Teuchos::RCP< GlobalIndexer >	buildNewIndexer (const Teuchos::RCP< ConnManager > &connManager, MPI_Comm mpiComm) const

void	setOrientationsRequired (const Teuchos::RCP< GlobalIndexer > &indexer, bool required) const

void	buildGlobalUnknowns (const Teuchos::RCP< GlobalIndexer > &indexer, const Teuchos::RCP< const FieldPattern > &geomPattern) const

int	getElementBlockGIDCount (const Teuchos::RCP< GlobalIndexer > &indexer, const std::string &elementBlock) const

int	getElementBlockGIDCount (const Teuchos::RCP< GlobalIndexer > &indexer, const std::size_t &blockIndex) const

void	printFieldInformation (const Teuchos::RCP< GlobalIndexer > &indexer, std::ostream &os) const

void	addFieldsToFieldBlockManager (const std::vector< std::string > &activeFields, GlobalIndexer &fieldBlockManager) const

void	addFieldsToFieldBlockManager (const std::vector< std::string > &activeFields, DOFManager &fieldBlockManager) const

Protected Member Functions inherited from panzer::GlobalIndexer
void	buildLocalIds ()

void	buildLocalIdsFromOwnedElements (std::vector< std::vector< panzer::LocalOrdinal > > &localIDs) const

void	setLocalIds (const std::vector< std::vector< panzer::LocalOrdinal > > &localIDs)

void	shareLocalIDs (const GlobalIndexer &src)

Protected Attributes
Teuchos::RCP< ConnManager >	connMngr_

std::map< std::string, int >	fieldStrToNum_
	field string ==> field number

std::map< int, std::string >	fieldNumToStr_
	field number ==> field string

std::map< int, int >	fieldNumToFieldBlk_
	field number ==> field block

std::map< std::pair< std::string, std::string >, Teuchos::RCP< const FieldPattern > >	fieldStringToPattern_
	(block ID x field string) ==> pattern

std::map< std::string, std::set< std::string > >	blockIdToFieldStrings_
	block ID ==> field strings

std::map< std::string, std::vector< int > >	blockIdToFieldNumbers_
	block ID ==> field numbers

std::map< std::pair< std::string, int >, int >	blockGIDOffset_
	(element block,field block) ==> gid offset

std::vector< std::vector< std::string > >	fieldOrder_

bool	fieldsRegistered_

Teuchos::RCP< const FieldPattern >	geomPattern_

Teuchos::RCP< Teuchos::MpiComm< int > >	communicator_

std::vector< Teuchos::RCP< GlobalIndexer > >	fieldBlockManagers_

MPI_Comm	mpiComm_

int	maxSubFieldNum_

std::map< std::string, std::map< int, std::vector< int > > >	gidFieldOffsets_

std::map< std::string, TupleToVectorPairMap >	gidFieldOffsets_closure_

bool	requireOrientations_

bool	useDOFManagerFEI_

bool	useTieBreak_

Detailed Description

Definition at line 37 of file Panzer_BlockedDOFManager.hpp.

Member Typedef Documentation

◆ GlobalOrdinal

using panzer::BlockedDOFManager::GlobalOrdinal = panzer::GlobalOrdinal

Definition at line 40 of file Panzer_BlockedDOFManager.hpp.

◆ LocalOrdinal

using panzer::BlockedDOFManager::LocalOrdinal = panzer::LocalOrdinal

Definition at line 41 of file Panzer_BlockedDOFManager.hpp.

◆ const_field_iterator

using panzer::BlockedDOFManager::const_field_iterator = std::map<int,std::string>::const_iterator

Definition at line 42 of file Panzer_BlockedDOFManager.hpp.

◆ TupleToVectorPairMap

typedef std::map<Teuchos::Tuple<int,3>, std::pair<std::vector<int>,std::vector<int> >,LessThan> panzer::BlockedDOFManager::TupleToVectorPairMap

protected

Definition at line 558 of file Panzer_BlockedDOFManager.hpp.

Constructor & Destructor Documentation

◆ ~BlockedDOFManager()

virtual panzer::BlockedDOFManager::~BlockedDOFManager ( )

inlinevirtual

Definition at line 44 of file Panzer_BlockedDOFManager.hpp.

◆ BlockedDOFManager() [1/2]

panzer::BlockedDOFManager::BlockedDOFManager ( )

Definition at line 30 of file Panzer_BlockedDOFManager.cpp.

◆ BlockedDOFManager() [2/2]

panzer::BlockedDOFManager::BlockedDOFManager	(	const Teuchos::RCP< ConnManager > &	connMngr,
		MPI_Comm	mpiComm
	)

Constructor that sets the connection manager and communicator objects. This is equivalent to calling the default constructor and then "setConnManager" routine.

Definition at line 34 of file Panzer_BlockedDOFManager.cpp.

Member Function Documentation

◆ getComm()

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.

◆ getFieldNum()

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] str Human 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.

◆ getFieldString()

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] int A 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.

◆ getElementBlockIds()

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.

◆ fieldInBlock()

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.

◆ getElementBlock()

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] blockId Block ID

Returns: Vector of local element IDs.

Implements panzer::GlobalIndexer.

Definition at line 111 of file Panzer_BlockedDOFManager.hpp.

◆ getBlockFieldNumbers()

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.

◆ getElementGIDs()

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.

◆ getElementGIDsPair()

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.

◆ getElementOrientation()

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.

◆ getGIDFieldOffsets()

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.

◆ getGIDFieldOffsets_closure()

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.

◆ getOwnedIndices()

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

virtual

Get the set of indices owned by this processor.

Parameters

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

Implements panzer::GlobalIndexer.

Definition at line 289 of file Panzer_BlockedDOFManager.cpp.

◆ getGhostedIndices()

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

virtual

Get the set of indices ghosted for this processor.

Parameters

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

Implements panzer::GlobalIndexer.

Definition at line 309 of file Panzer_BlockedDOFManager.cpp.

◆ getOwnedAndGhostedIndices()

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

virtual

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

Parameters

[out] indices A 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.

◆ getElementGIDsAsInt()

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.

◆ getOwnedIndicesAsInt()

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

virtual

Get the set of indices owned by this processor.

Parameters

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

Implements panzer::GlobalIndexer.

Definition at line 371 of file Panzer_BlockedDOFManager.cpp.

◆ getGhostedIndicesAsInt()

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

virtual

Get the set of indices ghosted for this processor.

Parameters

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

Implements panzer::GlobalIndexer.

Definition at line 387 of file Panzer_BlockedDOFManager.cpp.

◆ getOwnedAndGhostedIndicesAsInt()

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

virtual

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

Parameters

[out] A vector 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.

◆ getNumOwned()

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.

◆ getNumGhosted()

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.

◆ getNumOwnedAndGhosted()

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.

◆ ownedIndices()

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.

◆ setUseDOFManagerFEI()

void panzer::BlockedDOFManager::setUseDOFManagerFEI ( bool useFEI )

inline

Use the FEI DOF manager internally, or the standard version.

Definition at line 230 of file Panzer_BlockedDOFManager.hpp.

◆ getUseDOFManagerFEI()

bool panzer::BlockedDOFManager::getUseDOFManagerFEI ( ) const

inline

which DOF Manager is used internally?

Definition at line 235 of file Panzer_BlockedDOFManager.hpp.

◆ setConnManager()

void panzer::BlockedDOFManager::setConnManager	(	const Teuchos::RCP< ConnManager > &	connMngr,
		MPI_Comm	mpiComm
	)

Set the connection manager and MPI_Comm objects.

Set the connection manager and MPI_Comm objects. If this method is called more than once, the behavior is to reset the indices in the DOF manager. However, the fields will be the same (this assumes that the element blocks are consistent with the fields). The indices will need to be rebuilt by calling buildGlobalUnknowns.

Parameters

[in]	connMngr	Connection manager to use.
[in]	mpiComm	Communicator to use.

Definition at line 520 of file Panzer_BlockedDOFManager.cpp.

◆ getGeometricFieldPattern()

Teuchos::RCP< const FieldPattern > panzer::BlockedDOFManager::getGeometricFieldPattern ( ) const

inline

Get the FieldPattern describing the geometry used for this problem. If it has not been constructed then null is returned.

Definition at line 257 of file Panzer_BlockedDOFManager.hpp.

◆ resetIndices()

Teuchos::RCP< ConnManager > panzer::BlockedDOFManager::resetIndices ( )

Reset the indicies for this DOF manager.

This method resets the indices and wipes out internal state. This method does preserve the fields and the patterns added to the object. Also the old connection manager is returned.

Returns: Old connection manager.

Definition at line 540 of file Panzer_BlockedDOFManager.cpp.

◆ addField() [1/2]

void panzer::BlockedDOFManager::addField	(	const std::string &	str,
		const Teuchos::RCP< const FieldPattern > &	pattern
	)

Add a field to the DOF manager.

Add a field to the DOF manager. Immediately after adding the field the field number and field size will be available for a user to access

Parameters

[in]	str	Human readable name of the field
[in]	pattern	Pattern defining the basis function to be used

Note: addField cannot be called after buildGlobalUnknowns or registerFields.

Definition at line 551 of file Panzer_BlockedDOFManager.cpp.

◆ addField() [2/2]

void panzer::BlockedDOFManager::addField	(	const std::string &	blockId,
		const std::string &	str,
		const Teuchos::RCP< const FieldPattern > &	pattern
	)

Definition at line 562 of file Panzer_BlockedDOFManager.cpp.

◆ setFieldOrder()

void panzer::BlockedDOFManager::setFieldOrder ( const std::vector< std::vector< std::string > > & fieldOrder )

Set the ordering of the fields to be used internally. This controls to some extent the local ordering (on a node or edge) of the individual fields.

Parameters

[in] fieldOrder Vector of field IDs order in the correct way

Note: If no ordering is set then the default ordering is alphabetical on the field names (as dictated by std::map<std::string,*>).

Definition at line 874 of file Panzer_BlockedDOFManager.cpp.

◆ getNumFieldBlocks()

int panzer::BlockedDOFManager::getNumFieldBlocks ( ) const

Return the number of field blocks associated with this manager. If the field order has not been set then this method returns 1.

Definition at line 1136 of file Panzer_BlockedDOFManager.cpp.

◆ getFieldOrder() [1/2]

void panzer::BlockedDOFManager::getFieldOrder ( std::vector< std::vector< std::string > > & fieldOrder ) const

Get the field order used. Return the field strings.

Definition at line 881 of file Panzer_BlockedDOFManager.cpp.

◆ getFieldOrder() [2/2]

void panzer::BlockedDOFManager::getFieldOrder ( std::vector< std::string > & fieldOrder ) const

inlinevirtual

Get the field order used by this global indexer.

Implements panzer::GlobalIndexer.

Definition at line 305 of file Panzer_BlockedDOFManager.hpp.

◆ getFieldPattern()

Teuchos::RCP< const FieldPattern > panzer::BlockedDOFManager::getFieldPattern	(	const std::string &	blockId,
		const std::string &	fieldName
	)		const

Find a field pattern stored for a particular block and field number. This will retrive the pattern added with addField(blockId,fieldNum).

Find a field pattern stored for a particular block and field number. This will retrive the pattern added with addField(blockId,fieldNum). If no pattern is found this function returns Teuchos::null.

Parameters

[in]	blockId	Element block id
[in]	fieldName	Field string identifier

Returns: Pointer to FieldPattern requested if the field exists, otherwise Teuchos::null is returned.

Definition at line 1099 of file Panzer_BlockedDOFManager.cpp.

◆ getNumFields()

int panzer::BlockedDOFManager::getNumFields ( ) const

virtual

How many fields are handled by this manager.

Returns: The number of fields used by this manager.

Implements panzer::GlobalIndexer.

Definition at line 886 of file Panzer_BlockedDOFManager.cpp.

◆ getConnManager() [1/2]

Teuchos::RCP< const ConnManager > panzer::BlockedDOFManager::getConnManager ( ) const

inlinevirtual

Returns the connection manager current being used.

Implements panzer::GlobalIndexer.

Definition at line 333 of file Panzer_BlockedDOFManager.hpp.

◆ getConnManager() [2/2]

Teuchos::RCP< ConnManager > panzer::BlockedDOFManager::getConnManager ( )

inline

Returns the connection manager current being used.

Definition at line 338 of file Panzer_BlockedDOFManager.hpp.

◆ buildGlobalUnknowns() [1/4]

void panzer::BlockedDOFManager::buildGlobalUnknowns ( )

virtual

build the global unknown numberings

this builds the pattens
Build a default geometric pattern to pass to the connection manager
initializes the connectivity
calls initComplete

Definition at line 1044 of file Panzer_BlockedDOFManager.cpp.

◆ buildGlobalUnknowns() [2/4]

void panzer::BlockedDOFManager::buildGlobalUnknowns ( const Teuchos::RCP< const FieldPattern > & geomPattern )

virtual

build the global unknown numberings

this builds the pattens
calls initComplete

This method allows a different geometric field pattern to used. It does not call the ConnManger::buildConnectivity, and just uses the provided field pattern as a the geometric pattern. Note this requires that ConnManager::buildConnectivity has already been called.

Note: It might be useful (and fun!) to add a listener on to this function to notify interested parties of possible changes to the unknown structure and CRS matrix graph.

Definition at line 1010 of file Panzer_BlockedDOFManager.cpp.

◆ buildGlobalUnknowns() [3/4]

void panzer::BlockedDOFManager::buildGlobalUnknowns ( const std::vector< Teuchos::RCP< GlobalIndexer > > & fieldBlockManagers )

virtual

This method simply builds the global unknowns by using the passed in global indexers. The internal connection manager must use the underlying connection manager for all the global indexers. Finally only global indexers of type DOFManager can be used at the moment.

Note: The type of global indexer, and agreement with the geometric field pattern are all checked.

Definition at line 905 of file Panzer_BlockedDOFManager.cpp.

◆ printFieldInformation() [1/2]

void panzer::BlockedDOFManager::printFieldInformation ( std::ostream & os ) const

Prints to an output stream the information about the aggregated field.

Definition at line 1070 of file Panzer_BlockedDOFManager.cpp.

◆ validFieldOrder()

bool panzer::BlockedDOFManager::validFieldOrder	(	const std::vector< std::vector< std::string > > &	fieldOrder_ut,
		const std::set< std::string > &	fields
	)		const

Check the validity of a field order. This is used internally as a sanity check. Checks for no repeats, bogus fields, and all fields being included.

Parameters

[in] fieldOrder_ut Field order vector under test (ut).

Returns: true if the vector is valid, false otherwise.

Definition at line 1118 of file Panzer_BlockedDOFManager.cpp.

◆ registerFields()

void panzer::BlockedDOFManager::registerFields ( bool buildSubUGIs )

This builds all numbers for the fields as well as constructing a default field orderand validating the user specified field order.

Definition at line 573 of file Panzer_BlockedDOFManager.cpp.

◆ fieldsRegistered()

bool panzer::BlockedDOFManager::fieldsRegistered ( ) const

inline

Has the method registerFields been called?

Definition at line 398 of file Panzer_BlockedDOFManager.hpp.

◆ getFieldDOFManagers()

const std::vector< Teuchos::RCP< GlobalIndexer > > & panzer::BlockedDOFManager::getFieldDOFManagers ( ) const

inline

Extract the field DOFManagers used underneath to define the global unknowns.

Definition at line 405 of file Panzer_BlockedDOFManager.hpp.

◆ getMaxSubFieldNumber()

int panzer::BlockedDOFManager::getMaxSubFieldNumber ( ) const

inline

Return the maximum field number returned by any sub DOFManager. Mostly exposed for testing purposes.

Definition at line 411 of file Panzer_BlockedDOFManager.hpp.

◆ getFieldBlock()

int panzer::BlockedDOFManager::getFieldBlock ( int fieldNum ) const

inline

Get field block associated with this field number.

Note: No bounds checking is performed in this method

Definition at line 418 of file Panzer_BlockedDOFManager.hpp.

◆ getBlockGIDOffset()

int panzer::BlockedDOFManager::getBlockGIDOffset	(	const std::string &	elementBlock,
		int	fieldBlock
	)		const

inline

Get GID offset for a particular field block.

Note: No bounds checking is performed in this method

Definition at line 425 of file Panzer_BlockedDOFManager.hpp.

◆ getOrientationsRequired()

bool panzer::BlockedDOFManager::getOrientationsRequired ( ) const

inline

Return if the orientations have been set to required.

Definition at line 438 of file Panzer_BlockedDOFManager.hpp.

◆ setOrientationsRequired() [1/2]

void panzer::BlockedDOFManager::setOrientationsRequired ( bool ro )

inline

Enable computation of the orientations.

Definition at line 443 of file Panzer_BlockedDOFManager.hpp.

◆ enableTieBreak()

void panzer::BlockedDOFManager::enableTieBreak ( bool useTieBreak )

inline

Enable TieBreak in sub dofmanger

Definition at line 448 of file Panzer_BlockedDOFManager.hpp.

◆ getElementBlockGIDCount() [1/4]

int panzer::BlockedDOFManager::getElementBlockGIDCount ( const std::string & blockId ) const

virtual

How any GIDs are associate with a particular element block.

This is a per-element count. If you have a quad element with two piecewise bi-linear fields this method returns 8.

Implements panzer::GlobalIndexer.

Definition at line 800 of file Panzer_BlockedDOFManager.cpp.

◆ getElementBlockGIDCount() [2/4]

int panzer::BlockedDOFManager::getElementBlockGIDCount ( const std::size_t & blockIndex ) const

virtual

How any GIDs are associate with a particular element block.

This is a per-element count. If you have a quad element with two piecewise bi-linear fields this method returns 8.

Implements panzer::GlobalIndexer.

Definition at line 809 of file Panzer_BlockedDOFManager.cpp.

◆ buildNewIndexer()

Teuchos::RCP< GlobalIndexer > panzer::BlockedDOFManager::buildNewIndexer	(	const Teuchos::RCP< ConnManager > &	connManager,
		MPI_Comm	mpiComm
	)		const

protected

Build a new indexer. The concrete type is specified internally by this object (FEI version standard)

Definition at line 711 of file Panzer_BlockedDOFManager.cpp.

◆ setOrientationsRequired() [2/2]

void panzer::BlockedDOFManager::setOrientationsRequired	(	const Teuchos::RCP< GlobalIndexer > &	indexer,
		bool	required
	)		const

protected

Do appropriate casting below and set orientations for a particular indexer. (handles FEI versus standard DOFManager)

Definition at line 719 of file Panzer_BlockedDOFManager.cpp.

◆ buildGlobalUnknowns() [4/4]

void panzer::BlockedDOFManager::buildGlobalUnknowns	(	const Teuchos::RCP< GlobalIndexer > &	indexer,
		const Teuchos::RCP< const FieldPattern > &	geomPattern
	)		const

protected

Do appropriate casting below and call buildGlobalUnknowns for a particular indexer. (handles FEI versus standard DOFManager)

Definition at line 738 of file Panzer_BlockedDOFManager.cpp.

◆ getElementBlockGIDCount() [3/4]

int panzer::BlockedDOFManager::getElementBlockGIDCount	(	const Teuchos::RCP< GlobalIndexer > &	indexer,
		const std::string &	elementBlock
	)		const

protected

Do appropriate casting below and call getElementBlockGIDCount for a particular indexer. (handles FEI versus standard DOFManager)

Definition at line 778 of file Panzer_BlockedDOFManager.cpp.

◆ getElementBlockGIDCount() [4/4]

int panzer::BlockedDOFManager::getElementBlockGIDCount	(	const Teuchos::RCP< GlobalIndexer > &	indexer,
		const std::size_t &	blockIndex
	)		const

protected

Do appropriate casting below and call getElementBlockGIDCount for a particular indexer. (handles FEI versus standard DOFManager)

Definition at line 789 of file Panzer_BlockedDOFManager.cpp.

◆ printFieldInformation() [2/2]

void panzer::BlockedDOFManager::printFieldInformation	(	const Teuchos::RCP< GlobalIndexer > &	indexer,
		std::ostream &	os
	)		const

protected

Do appropriate casting below and call printFieldInformation for a particular indexer. (handles FEI versus standard DOFManager)

Definition at line 758 of file Panzer_BlockedDOFManager.cpp.

◆ addFieldsToFieldBlockManager() [1/2]

void panzer::BlockedDOFManager::addFieldsToFieldBlockManager	(	const std::vector< std::string > &	activeFields,
		GlobalIndexer &	fieldBlockManager
	)		const

protected

This routine calls the addField method on the fieldBlockManager adding all the fields it is supposed to control, and then calls registerFields.

This method assumes that the activeFields are a legitimate ordering for the local field block.

Definition at line 818 of file Panzer_BlockedDOFManager.cpp.

◆ addFieldsToFieldBlockManager() [2/2]

void panzer::BlockedDOFManager::addFieldsToFieldBlockManager	(	const std::vector< std::string > &	activeFields,
		DOFManager &	fieldBlockManager
	)		const

protected

This routine calls the addField method on the fieldBlockManager adding all the fields it is supposed to control, and then calls registerFields.

This method assumes that the activeFields are a legitimate ordering for the local field block.

Definition at line 841 of file Panzer_BlockedDOFManager.cpp.

Member Data Documentation

◆ connMngr_

Teuchos::RCP<ConnManager> panzer::BlockedDOFManager::connMngr_

protected

Definition at line 509 of file Panzer_BlockedDOFManager.hpp.

◆ fieldStrToNum_

std::map<std::string,int> panzer::BlockedDOFManager::fieldStrToNum_

protected

field string ==> field number

Definition at line 514 of file Panzer_BlockedDOFManager.hpp.

◆ fieldNumToStr_

std::map<int,std::string> panzer::BlockedDOFManager::fieldNumToStr_

protected

field number ==> field string

Definition at line 517 of file Panzer_BlockedDOFManager.hpp.

◆ fieldNumToFieldBlk_

std::map<int,int> panzer::BlockedDOFManager::fieldNumToFieldBlk_

protected

field number ==> field block

Definition at line 520 of file Panzer_BlockedDOFManager.hpp.

◆ fieldStringToPattern_

std::map<std::pair<std::string,std::string>,Teuchos::RCP<const FieldPattern> > panzer::BlockedDOFManager::fieldStringToPattern_

protected

(block ID x field string) ==> pattern

Definition at line 523 of file Panzer_BlockedDOFManager.hpp.

◆ blockIdToFieldStrings_

std::map<std::string,std::set<std::string> > panzer::BlockedDOFManager::blockIdToFieldStrings_

protected

block ID ==> field strings

Definition at line 526 of file Panzer_BlockedDOFManager.hpp.

◆ blockIdToFieldNumbers_

std::map<std::string,std::vector<int> > panzer::BlockedDOFManager::blockIdToFieldNumbers_

protected

block ID ==> field numbers

Definition at line 529 of file Panzer_BlockedDOFManager.hpp.

◆ blockGIDOffset_

std::map<std::pair<std::string,int>,int> panzer::BlockedDOFManager::blockGIDOffset_

protected

(element block,field block) ==> gid offset

Definition at line 532 of file Panzer_BlockedDOFManager.hpp.

◆ fieldOrder_

std::vector<std::vector<std::string> > panzer::BlockedDOFManager::fieldOrder_

protected

Definition at line 539 of file Panzer_BlockedDOFManager.hpp.

◆ fieldsRegistered_

bool panzer::BlockedDOFManager::fieldsRegistered_

protected

Definition at line 541 of file Panzer_BlockedDOFManager.hpp.

◆ geomPattern_

Teuchos::RCP<const FieldPattern> panzer::BlockedDOFManager::geomPattern_

protected

Definition at line 543 of file Panzer_BlockedDOFManager.hpp.

◆ communicator_

Teuchos::RCP<Teuchos::MpiComm<int> > panzer::BlockedDOFManager::communicator_

protected

Definition at line 544 of file Panzer_BlockedDOFManager.hpp.

◆ fieldBlockManagers_

std::vector<Teuchos::RCP<GlobalIndexer> > panzer::BlockedDOFManager::fieldBlockManagers_

protected

Definition at line 546 of file Panzer_BlockedDOFManager.hpp.

◆ mpiComm_

MPI_Comm panzer::BlockedDOFManager::mpiComm_

protected

Definition at line 548 of file Panzer_BlockedDOFManager.hpp.

◆ maxSubFieldNum_

int panzer::BlockedDOFManager::maxSubFieldNum_

protected

Definition at line 549 of file Panzer_BlockedDOFManager.hpp.

◆ gidFieldOffsets_

std::map<std::string,std::map<int,std::vector<int> > > panzer::BlockedDOFManager::gidFieldOffsets_

mutableprotected

Maps: elem block ids ==> (fieldNum ==> gidFieldOffsets vector) This uses lazy evaluation for construction.

Definition at line 554 of file Panzer_BlockedDOFManager.hpp.

◆ gidFieldOffsets_closure_

std::map<std::string,TupleToVectorPairMap> panzer::BlockedDOFManager::gidFieldOffsets_closure_

mutableprotected

Maps: elem block ids ==> ( (fieldNum,subcellDim,subcellId) ==> closure vector pair) This uses lazy evaluation for construction.

Definition at line 563 of file Panzer_BlockedDOFManager.hpp.

◆ requireOrientations_

bool panzer::BlockedDOFManager::requireOrientations_

protected

Definition at line 565 of file Panzer_BlockedDOFManager.hpp.

◆ useDOFManagerFEI_

bool panzer::BlockedDOFManager::useDOFManagerFEI_

protected

Definition at line 567 of file Panzer_BlockedDOFManager.hpp.

◆ useTieBreak_

bool panzer::BlockedDOFManager::useTieBreak_

protected

Definition at line 568 of file Panzer_BlockedDOFManager.hpp.

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

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ GlobalOrdinal

◆ LocalOrdinal

◆ const_field_iterator

◆ TupleToVectorPairMap

Constructor & Destructor Documentation

◆ ~BlockedDOFManager()

◆ BlockedDOFManager() [1/2]

◆ BlockedDOFManager() [2/2]

Member Function Documentation

◆ getComm()

◆ getFieldNum()

◆ getFieldString()

◆ getElementBlockIds()

◆ fieldInBlock()

◆ getElementBlock()

◆ getBlockFieldNumbers()

◆ getElementGIDs()

◆ getElementGIDsPair()

◆ getElementOrientation()

◆ getGIDFieldOffsets()

◆ getGIDFieldOffsets_closure()

◆ getOwnedIndices()

◆ getGhostedIndices()

◆ getOwnedAndGhostedIndices()

◆ getElementGIDsAsInt()

◆ getOwnedIndicesAsInt()

◆ getGhostedIndicesAsInt()

◆ getOwnedAndGhostedIndicesAsInt()

◆ getNumOwned()

◆ getNumGhosted()

◆ getNumOwnedAndGhosted()

◆ ownedIndices()

◆ setUseDOFManagerFEI()

◆ getUseDOFManagerFEI()

◆ setConnManager()

◆ getGeometricFieldPattern()

◆ resetIndices()

◆ addField() [1/2]

◆ addField() [2/2]

◆ setFieldOrder()

◆ getNumFieldBlocks()

◆ getFieldOrder() [1/2]

◆ getFieldOrder() [2/2]

◆ getFieldPattern()

◆ getNumFields()

◆ getConnManager() [1/2]

◆ getConnManager() [2/2]

◆ buildGlobalUnknowns() [1/4]

◆ buildGlobalUnknowns() [2/4]

◆ buildGlobalUnknowns() [3/4]

◆ printFieldInformation() [1/2]

◆ validFieldOrder()

◆ registerFields()

◆ fieldsRegistered()

◆ getFieldDOFManagers()

◆ getMaxSubFieldNumber()

◆ getFieldBlock()

◆ getBlockGIDOffset()

◆ getOrientationsRequired()

◆ setOrientationsRequired() [1/2]

◆ enableTieBreak()

◆ getElementBlockGIDCount() [1/4]

◆ getElementBlockGIDCount() [2/4]

◆ buildNewIndexer()

◆ setOrientationsRequired() [2/2]

◆ buildGlobalUnknowns() [4/4]

◆ getElementBlockGIDCount() [3/4]

◆ getElementBlockGIDCount() [4/4]

◆ printFieldInformation() [2/2]

◆ addFieldsToFieldBlockManager() [1/2]

◆ addFieldsToFieldBlockManager() [2/2]

Member Data Documentation