Partition of the decomposed physical domain. It also manages the connexion information to its neighbors. More...

#include <DomainPartition.hpp>

Inheritance diagram for geosx::DomainPartition:

Classes
struct	groupKeysStruct
	struct to serve as a container for group strings and keys More...

Public Member Functions
	DomainPartition (std::string const &name, Group *const parent)
	Constructor. More...

	~DomainPartition () override
	Destructor.

virtual void	RegisterDataOnMeshRecursive (Group *const meshBodies) override final
	Calls RegisterDataOnMesh() recursively. More...

void	InitializationOrder (string_array &order) override final
	Sets the initialization order for sub-Groups. More...

void	GenerateSets ()
	Build all the sets of the DomainPartition. More...

constitutive::ConstitutiveManager const *	getConstitutiveManager () const
	Get the constitutive manager, const version. More...

constitutive::ConstitutiveManager *	getConstitutiveManager ()
	Get the constitutive manager. More...

NumericalMethodsManager const &	getNumericalMethodManager () const

NumericalMethodsManager &	getNumericalMethodManager ()

Group const *	getMeshBodies () const
	Get the mesh bodies, const version. More...

Group *	getMeshBodies ()
	Get the mesh bodies. More...

MeshBody const *	getMeshBody (string const &meshName) const
	Get a MeshBody by name, const version. More...

MeshBody *	getMeshBody (string const &meshName)
	Get a MeshBody by name. More...

MeshBody const *	getMeshBody (localIndex const index) const
	Get a MeshBody by index, const version. More...

MeshBody *	getMeshBody (localIndex const index)
	Get MeshBody by index. More...

std::set< int > &	getMetisNeighborList ()
	Get the metis neighbors indices. More...

std::set< int > const &	getMetisNeighborList () const
	Get the metis neighbors indices, const version. More...

std::vector< NeighborCommunicator > &	getNeighbors ()
	Get the neighbor communicators. More...

std::vector< NeighborCommunicator > const &	getNeighbors () const
	Get the neighbor communicators, const version. More...

MPI functionality
void	SetupCommunications (bool use_nonblocking)
	Constructs the communications between this DomainPartition and its neighbors. More...

void	AddNeighbors (const unsigned int idim, MPI_Comm &cartcomm, int *ncoords)
	Recursively builds neighbors if an MPI cartesian topology is used (i.e. not metis). More...

Public Member Functions inherited from geosx::dataRepository::Group
	Group (std::string const &name, Group *const parent)
	Constructor. More...

	Group (Group &&source)
	Move constructor. More...

virtual	~Group ()
	Destructor, deletes all Groups and Wrappers owned by this Group.

	Group ()=delete
	Deleted default constructor.

	Group (Group const &)=delete
	Deleted copy constructor.

	Group (Group const &&)=delete
	Deleted move constructor.

Group &	operator= (Group const &)=delete
	Deleted copy assignment operator. More...

Group &	operator= (Group &&)=delete
	Deleted move assignment operator. More...

virtual const std::type_info &	get_typeid () const
	Get typeid for current group. More...

bool	CheckTypeID (std::type_info const &typeToCheck) const
	Check a type_info against the type_info of this Group. More...

void	PrintDataHierarchy (integer indent=0)
	Prints the data hierarchy recursively. More...

string	dumpInputOptions () const

template<typename T = Group>
T *	RegisterGroup (std::string const &name, std::unique_ptr< T > newObject)
	Register a new Group as a sub-group of current Group. More...

template<typename T = Group>
T *	RegisterGroup (std::string const &name, T *newObject)
	Register a new Group as a sub-group of current Group. More...

template<typename T = Group>
T *	RegisterGroup (std::string const &name)
	Register a new Group as a sub-group of current Group. More...

template<typename T = Group>
T *	RegisterGroup (subGroupMap::KeyIndex const &keyIndex)
	Register a new Group as a sub-group of current Group. More...

template<typename T = Group, typename TBASE = Group>
T *	RegisterGroup (std::string const &name, std::string const &catalogName)
	Register a new Group as a sub-group of current Group. More...

void	deregisterGroup (std::string const &name)
	Removes a child group from this group. More...

virtual Group *	CreateChild (string const &childKey, string const &childName)
	Creates a new sub-Group using the ObjectCatalog functionality. More...

template<typename T = Group>
T *	GetGroup (localIndex index)
	Retrieve a sub-group from the current Group using an index. More...

template<typename T = Group>
T const *	GetGroup (localIndex index) const
	Retrieve a sub-group from the current Group using an index. More...

template<typename T = Group>
T *	GetGroup (string const &name)
	Retrieve a sub-group from the current Group using a string. More...

template<typename T = Group>
T const *	GetGroup (string const &name) const
	Retrieve a sub-group from the current Group using a string. More...

template<typename T = Group>
T &	getGroupReference (string const &key)

template<typename T = Group>
T const &	getGroupReference (string const &key) const

template<typename T = Group>
T &	GetGroupReference (subGroupMap::KeyIndex const &key)

template<typename T = Group>
T const &	GetGroupReference (subGroupMap::KeyIndex const &key) const

template<typename T = Group>
T *	GetGroup (subGroupMap::KeyIndex const &key)
	Retrieve a sub-group from the current Group using a KeyIndexT. More...

template<typename T = Group>
T const *	GetGroup (subGroupMap::KeyIndex const &key) const
	Retrieve a sub-group from the current Group using a KeyIndexT. More...

template<typename T = Group>
T *	GetGroupByPath (string const &path)
	Retrieve a group from the hierarchy using a path. More...

template<typename T = Group>
T const *	GetGroupByPath (string const &path) const
	Retrieve a group from the hierarchy using a path. More...

subGroupMap &	GetSubGroups ()
	Get the subgroups object. More...

subGroupMap const &	GetSubGroups () const
	Get the subgroups object. More...

localIndex	numSubGroups () const
	return the number of sub groups in this Group More...

bool	hasGroup (std::string const &name) const
	Check whether a sub-group exists. More...

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void	forSubGroups (LAMBDA lambda)
	Apply the given functor to subgroups that can be casted to one of specified types. More...

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void	forSubGroups (LAMBDA lambda) const
	Apply the given functor to subgroups that can be casted to one of specified types. More...

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void	forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA lambda)

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void	forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA lambda) const

template<typename LAMBDA >
void	forWrappers (LAMBDA lambda)
	Apply the given functor to wrappers. More...

template<typename LAMBDA >
void	forWrappers (LAMBDA lambda) const
	Apply the given functor to wrappers. More...

template<typename TYPE , typename ... TYPES, typename LAMBDA >
void	forWrappers (LAMBDA lambda)
	Apply the given functor to wrappers that can be cast to one of specified types. More...

template<typename TYPE , typename ... TYPES, typename LAMBDA >
void	forWrappers (LAMBDA lambda) const
	Apply the given functor to wrappers that can be cast to one of specified types. More...

void	Initialize (Group *const group)
	Run initialization functions on this and all subgroups. More...

void	InitializePostInitialConditions (Group *const group)
	Initialization routine to be called after calling ApplyInitialConditions(). More...

void	postRestartInitializationRecursive (Group *const domain)
	Initialization routine to be called after calling reading a restart file. More...

void	ProcessInputFileRecursive (xmlWrapper::xmlNode &targetNode)
	Recursively read values using ProcessInputFile() from the input file and put them into the wrapped values for this group. More...

void	PostProcessInputRecursive ()
	Recursively call PostProcessInput() to apply post processing after reading input values.

template<typename T , typename TBASE = T>
Wrapper< TBASE > *	registerWrapper (std::string const &name, wrapperMap::KeyIndex::index_type *const rkey=nullptr)
	Create and register a Wrapper around a new object. More...

template<typename T , typename TBASE = T>
Wrapper< TBASE > *	registerWrapper (Group::wrapperMap::KeyIndex const &viewKey)

template<typename T >
Wrapper< T > *	registerWrapper (std::string const &name, std::unique_ptr< T > newObject)
	Register a Wrapper around a given object and take ownership. More...

template<typename T >
Wrapper< T > *	registerWrapper (std::string const &name, T *newObject)
	Register a Wrapper around an existing object, does not take ownership of the object. More...

WrapperBase *	registerWrapper (string const &name, std::unique_ptr< WrapperBase > wrapper)
	Register and take ownership of an existing Wrapper. More...

void	deregisterWrapper (string const &name)
	Removes a Wrapper from this group. More...

void	GenerateDataStructureSkeleton (integer const level)
	Build a complete datastructure for schema generation. More...

virtual void	ExpandObjectCatalogs ()
	Expand any catalogs in the data structure.

virtual void	SetSchemaDeviations (xmlWrapper::xmlNode schemaRoot, xmlWrapper::xmlNode schemaParent, integer documentationType)
	Inform the schema generator of any deviations between the xml and GEOS data structures. More...

virtual void	RegisterDataOnMesh (Group *const meshBodies)
	Register data on mesh entities. More...

virtual localIndex	PackSize (string_array const &wrapperNames, integer const recursive, bool on_device=false) const
	Get the size required to pack a list of wrappers. More...

virtual localIndex	PackSize (string_array const &wrapperNames, arrayView1d< localIndex const > const &packList, integer const recursive, bool on_device=false) const
	Get the size required to pack a list of indices within a list of wrappers. More...

virtual localIndex	Pack (buffer_unit_type *&buffer, string_array const &wrapperNames, integer const recursive, bool on_device=false) const
	Pack a list of wrappers to a buffer. More...

virtual localIndex	Pack (buffer_unit_type *&buffer, string_array const &wrapperNames, arrayView1d< localIndex const > const &packList, integer const recursive, bool on_device=false) const
	Pack a list of indices within a list of wrappers. More...

virtual localIndex	Unpack (buffer_unit_type const *&buffer, arrayView1d< localIndex > &packList, integer const recursive, bool on_device=false)
	Unpack a buffer. More...

WrapperBase const *	getWrapperBase (indexType const index) const
	Retrieve a WrapperBase stored in this group. More...

WrapperBase *	getWrapperBase (indexType const index)
	Retrieve a WrapperBase stored in this group. More...

WrapperBase const *	getWrapperBase (std::string const &name) const
	Retrieve a WrapperBase stored in this group. More...

WrapperBase *	getWrapperBase (std::string const &name)
	Retrieve a WrapperBase stored in this group. More...

WrapperBase const *	getWrapperBase (wrapperMap::KeyIndex const &keyIndex) const
	Retrieve a WrapperBase stored in this group. More...

WrapperBase *	getWrapperBase (wrapperMap::KeyIndex const &keyIndex)
	Retrieve a WrapperBase stored in this group. More...

indexType	getWrapperIndex (std::string const &name) const

wrapperMap const &	wrappers () const
	Get access to the internal wrapper storage. More...

wrapperMap &	wrappers ()
	Get access to the internal wrapper storage. More...

template<typename LOOKUP_TYPE >
bool	hasWrapper (LOOKUP_TYPE const &lookup) const
	Check if a wrapper exists. More...

template<typename T , typename LOOKUP_TYPE >
Wrapper< T > const *	getWrapper (LOOKUP_TYPE const &index) const
	Retrieve a Wrapper stored in this group. More...

template<typename T , typename LOOKUP_TYPE >
Wrapper< T > *	getWrapper (LOOKUP_TYPE const &index)
	Retrieve a Wrapper stored in this group. More...

template<typename T >
Wrapper< T > const *	getWrapper (char const *const key) const
	Retrieve a Wrapper stored in this group. More...

template<typename T >
Wrapper< T > *	getWrapper (char const *const key)
	Retrieve a Wrapper stored in this group. More...

template<typename T , typename LOOKUP_TYPE >
GEOSX_DECLTYPE_AUTO_RETURN	getReference (LOOKUP_TYPE const &lookup) const
	Look up a wrapper and get reference to wrapped object. More...

template<typename T , typename LOOKUP_TYPE >
T &	getReference (LOOKUP_TYPE const &lookup)
	Look up a wrapper and get reference to wrapped object. More...

template<typename T >
GEOSX_DECLTYPE_AUTO_RETURN	getReference (char const *const name) const

template<typename T >
T &	getReference (char const *const name)

virtual void	resize (localIndex const newSize)
	Resize the group and all contained wrappers that resize with parent. More...

virtual void	reserve (indexType const newsize)
	Set the new capacity and reserve it in all wrappers that resize with parent. More...

localIndex	capacity () const
	Get the "capacity" of the group, which determines the capacity of resizable wrappers. More...

localIndex	size () const
	Get the "size" of the group, which determines the number of elements in resizable wrappers. More...

const string	getName () const
	Get group name. More...

Group *	getParent ()
	Access the group's parent. More...

Group const *	getParent () const
	Access the group's parent. More...

localIndex	getIndexInParent () const
	Get the group's index withing its parent group. More...

integer	sizedFromParent () const
	Check whether this Group is resized when its parent is resized. More...

Group *	setSizedFromParent (int val)
	Set whether this wrapper is resized when its parent is resized. More...

RestartFlags	getRestartFlags () const
	Get flags that control restart output of this group. More...

void	setRestartFlags (RestartFlags flags)
	Set flags that control restart output of this group. More...

InputFlags	getInputFlags () const
	Get input flags for schema generation. More...

void	setInputFlags (InputFlags flags)
	Set input flags for schema generation. More...

conduit::Node &	getConduitNode ()
	Get the Conduit node object associated with this group. More...

void	prepareToWrite ()
	Register the group and its wrappers with Conduit.

void	finishWriting ()
	Write the group and its wrappers into Conduit.

void	loadFromConduit ()
	Read the group and its wrappers from Conduit.

void	enableLogLevelInput ()
	Enable verbosity input for object.

integer	getLogLevel () const

template<typename T >
T	group_cast ()
	Downcast this Group. More...

template<typename T >
T	group_cast () const
	Downcast this Group. More...

Public Attributes
struct geosx::DomainPartition::groupKeysStruct	groupKeys
	groupKey struct for the DomainPartition class

Additional Inherited Members
Public Types inherited from geosx::dataRepository::Group
using	subGroupMap = MappedVector< Group, Group *, keyType, indexType >
	The template specialization of MappedVector to use for the collection of sub-Group objects.

using	wrapperMap = MappedVector< WrapperBase, WrapperBase *, keyType, indexType >
	The template specialization of MappedVector to use for the collection wrappers objects.

using	CatalogInterface = dataRepository::CatalogInterface< Group, std::string const &, Group *const >
	Type alias for catalog interface used by this class. See CatalogInterface.

Static Public Member Functions inherited from geosx::dataRepository::Group
template<typename T0 , typename T1 , typename ... CASTTYPES, typename CONTAINERTYPE , typename LAMBDA >
static bool	applyLambdaToContainer (CONTAINERTYPE &container, LAMBDA &&lambda)
	Apply a given functor to a container if the container can be cast to one of the specified types. More...

static CatalogInterface::CatalogType &	GetCatalog ()
	Get the singleton catalog for this class. More...

template<typename T >
static T	group_cast (Group *group)
	Downcast a Group *. More...

template<typename T >
static T	group_cast (Group const *group)
	Downcast a Group const *. More...

Protected Member Functions inherited from geosx::dataRepository::Group
virtual void	PostProcessInput ()

virtual void	InitializePreSubGroups (Group *const group)
	Called by Initialize() prior to initializing sub-Groups. More...

virtual void	InitializePostSubGroups (Group *const group)
	Called by Initialize() after to initializing sub-Groups. More...

virtual void	InitializePostInitialConditions_PreSubGroups (Group *const group)
	Called by InitializePostInitialConditions() prior to initializing sub-Groups. More...

virtual void	InitializePostInitialConditions_PostSubGroups (Group *const group)
	Called by InitializePostInitialConditions() after to initializing sub-Groups. More...

virtual void	postRestartInitialization (Group *const domain)
	Performs initialization required after reading from a restart file. More...

Detailed Description

Partition of the decomposed physical domain. It also manages the connexion information to its neighbors.

Two types of neighors are being managed. One MPI cartesian communicator that DomainPartition shall build. Or through metis, but it is not the responsibility of DomainParition to build the decomposition in that case.

Definition at line 51 of file DomainPartition.hpp.

Constructor & Destructor Documentation

◆ DomainPartition()

geosx::DomainPartition::DomainPartition	(	std::string const &	name,
		Group *const	parent
	)

Constructor.

Parameters

[in]	name	Name of this object manager
[in]	parent	Parent Group

Member Function Documentation

◆ AddNeighbors()

void geosx::DomainPartition::AddNeighbors	(	const unsigned int	idim,
		MPI_Comm &	cartcomm,
		int *	ncoords
	)

Recursively builds neighbors if an MPI cartesian topology is used (i.e. not metis).

Parameters

idim	Dimension index in the cartesian.
cartcomm	Communicator with cartesian structure.
ncoords	Cartesian coordinates of a process (assumed to be of length 3).

This recursive function builds the neighbors recursively by increasing the dimension index of the current DomainPartition until all the dimensions (3) are done. The relevant values for initiating this functions are therefore ibim = 0 and a non-initialized vector ncoords of length 3.

This functions should have been implemented private and an additional functions to initiate the recursion could have been implemented.

◆ GenerateSets()

void geosx::DomainPartition::GenerateSets ( )

Build all the sets of the DomainPartition.

A domain contain sets of nodes or elements (that can be used to defined boundary conditions, etc.). This member functions build those sets.

◆ getConstitutiveManager() [1/2]

constitutive::ConstitutiveManager const* geosx::DomainPartition::getConstitutiveManager ( ) const

inline

Get the constitutive manager, const version.

Returns: Pointer to a const instance of a ConstitutiveManager.

Definition at line 154 of file DomainPartition.hpp.

◆ getConstitutiveManager() [2/2]

constitutive::ConstitutiveManager* geosx::DomainPartition::getConstitutiveManager ( )

inline

Get the constitutive manager.

Returns: Pointer to an instance of a ConstitutiveManager.

Definition at line 161 of file DomainPartition.hpp.

◆ getMeshBodies() [1/2]

Group const* geosx::DomainPartition::getMeshBodies ( ) const

inline

Get the mesh bodies, const version.

Returns: Pointer to a const instance of a Group that contains MeshBody instances.

Definition at line 180 of file DomainPartition.hpp.

◆ getMeshBodies() [2/2]

Group* geosx::DomainPartition::getMeshBodies ( )

inline

Get the mesh bodies.

Returns: Pointer to a instance of a Group that contains MeshBody instances.

Definition at line 187 of file DomainPartition.hpp.

◆ getMeshBody() [1/4]

MeshBody const* geosx::DomainPartition::getMeshBody ( string const & meshName ) const

inline

Get a MeshBody by name, const version.

Parameters

meshName The name of the MeshBody.

Returns: Pointer to a const MeshBody instance matching meshName.

Definition at line 195 of file DomainPartition.hpp.

◆ getMeshBody() [2/4]

MeshBody* geosx::DomainPartition::getMeshBody ( string const & meshName )

inline

Get a MeshBody by name.

Parameters

meshName The name of the MeshBody.

Returns: Pointer to a const MeshBody instance matching meshName.

Definition at line 203 of file DomainPartition.hpp.

◆ getMeshBody() [3/4]

MeshBody const* geosx::DomainPartition::getMeshBody ( localIndex const index ) const

inline

Get a MeshBody by index, const version.

Parameters

index The index of the MeshBody.

Returns: Pointer to a const MeshBody instance at index position.

Definition at line 211 of file DomainPartition.hpp.

◆ getMeshBody() [4/4]

MeshBody* geosx::DomainPartition::getMeshBody ( localIndex const index )

inline

Get MeshBody by index.

Parameters

index The index of the MeshBody.

Returns: Pointer to a MeshBody instance at index position.

Definition at line 219 of file DomainPartition.hpp.

◆ getMetisNeighborList() [1/2]

std::set< int >& geosx::DomainPartition::getMetisNeighborList ( )

inline

Get the metis neighbors indices.

See also: DomainPartition::m_metisNeighborList

Returns: Container of global indices.

Definition at line 226 of file DomainPartition.hpp.

◆ getMetisNeighborList() [2/2]

std::set< int > const& geosx::DomainPartition::getMetisNeighborList ( ) const

inline

Get the metis neighbors indices, const version.

See also: DomainPartition::m_metisNeighborList

Returns: Container of global indices.

Definition at line 233 of file DomainPartition.hpp.

◆ getNeighbors() [1/2]

std::vector< NeighborCommunicator >& geosx::DomainPartition::getNeighbors ( )

inline

Get the neighbor communicators.

See also: DomainPartition::m_neighbors.

Returns: Container of communicators.

Definition at line 240 of file DomainPartition.hpp.

◆ getNeighbors() [2/2]

std::vector< NeighborCommunicator > const& geosx::DomainPartition::getNeighbors ( ) const

inline

Get the neighbor communicators, const version.

See also: DomainPartition::m_neighbors.

Returns: Container of communicators.

Definition at line 247 of file DomainPartition.hpp.

◆ getNumericalMethodManager() [1/2]

NumericalMethodsManager const& geosx::DomainPartition::getNumericalMethodManager ( ) const

inline

Returns: Return a reference to const NumericalMethodsManager from ProblemManager

Definition at line 167 of file DomainPartition.hpp.

◆ getNumericalMethodManager() [2/2]

NumericalMethodsManager& geosx::DomainPartition::getNumericalMethodManager ( )

inline

Returns: Return a reference to NumericalMethodsManager from ProblemManager

Definition at line 173 of file DomainPartition.hpp.

◆ InitializationOrder()

void geosx::DomainPartition::InitializationOrder ( string_array & order )

finaloverridevirtual

Sets the initialization order for sub-Groups.

Parameters

[out] order An array of strings that define the iteration order.

This function will fill the order array that is used to specify the order in which the Initialize() function loops over sub-Groups. If a custom order is required by a derived type, this function should be overridden with a implementation that specifies the desired order.

Reimplemented from geosx::dataRepository::Group.

◆ RegisterDataOnMeshRecursive()

virtual void geosx::DomainPartition::RegisterDataOnMeshRecursive ( Group *const meshBodies )

finaloverridevirtual

Calls RegisterDataOnMesh() recursively.

Parameters

[in,out] meshBodies the group of MeshBody objects to register data on.

Reimplemented from geosx::dataRepository::Group.

◆ SetupCommunications()

void geosx::DomainPartition::SetupCommunications ( bool use_nonblocking )

Constructs the communications between this DomainPartition and its neighbors.

Parameters

use_nonblocking If true complete the communications of each phase in the order they are received.

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

coreComponents/managers/DomainPartition.hpp

Classes

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DomainPartition()

Member Function Documentation

◆ AddNeighbors()

◆ GenerateSets()

◆ getConstitutiveManager() [1/2]

◆ getConstitutiveManager() [2/2]

◆ getMeshBodies() [1/2]

◆ getMeshBodies() [2/2]

◆ getMeshBody() [1/4]

◆ getMeshBody() [2/4]

◆ getMeshBody() [3/4]

◆ getMeshBody() [4/4]

◆ getMetisNeighborList() [1/2]

◆ getMetisNeighborList() [2/2]

◆ getNeighbors() [1/2]

◆ getNeighbors() [2/2]

◆ getNumericalMethodManager() [1/2]

◆ getNumericalMethodManager() [2/2]

◆ InitializationOrder()

◆ RegisterDataOnMeshRecursive()

◆ SetupCommunications()