The ParticleManager class provides an interface to ObjectManagerBase in order to manage ParticleRegion data. More...

#include <ParticleManager.hpp>

Inheritance diagram for geos::ParticleManager:

Classes
struct	groupKeyStruct
	Group key associated with particleRegionsGroup. More...

Public Types
template<typename VIEWTYPE >
using	ParticleViewAccessor = array1d< array1d< VIEWTYPE > >
	The ParticleViewAccessor at the ParticleManager level is an array of array of VIEWTYPE. More...

template<typename VIEWTYPE >
using	ParticleView = typename ParticleViewAccessor< VIEWTYPE >::NestedViewType
	The ParticleViewAccessor at the ParticleManager level is the type resulting from ParticleViewAccessor< VIEWTYPE >::toNestedView(). More...

template<typename VIEWTYPE >
using	ParticleViewConst = typename ParticleViewAccessor< VIEWTYPE >::NestedViewTypeConst
	The ParticleViewAccessor at the ParticleManager level is the type resulting from ParticleViewAccessor< VIEWTYPE >::toNestedViewConst(). More...

template<typename VIEWTYPE >
using	ParticleReferenceAccessor = array1d< array1d< ReferenceWrapper< VIEWTYPE > > >
	The ParticleViewAccessor at the ParticleManager level is a 2D array of ReferenceWrapper around VIEWTYPE. More...

template<typename VIEWTYPE >
using	MaterialViewAccessor = array1d< array1d< array1d< VIEWTYPE > > >
	The MaterialViewAccessor at the ParticleManager level is a 3D array of VIEWTYPE. More...

template<typename CONSTITUTIVE_TYPE >
using	ConstitutiveRelationAccessor = array1d< array1d< array1d< CONSTITUTIVE_TYPE * > > >
	The ConstitutiveRelationAccessor at the ParticleManager level is a 3D array of CONSTITUTIVE_TYPE. More...

Public Types inherited from geos::ObjectManagerBase
using	CatalogInterface = dataRepository::CatalogInterface< ObjectManagerBase, string const &, dataRepository::Group *const >
	Nested type for the `factory` pattern, defining the base class (ObjectManagerBase) and the builder arguments (string const &, dataRepository::Group * const) of the derived products.

Public Types inherited from geos::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, string const &, Group *const >
	Type alias for catalog interface used by this class. See CatalogInterface.

Public Member Functions
virtual string	getCatalogName () const override final
	Virtual access to catalogName() More...

	ParticleManager (string const &name, Group *const parent)
	Constructor. More...

virtual	~ParticleManager () override
	Destructor.

template<typename T = ParticleSubRegionBase>
localIndex	getNumberOfParticles () const
	Get the number of particles in all ParticleSubRegions of type T. More...

void	generateMesh (ParticleBlockManagerABC &particleBlockManager)
	Generate the mesh. More...

virtual Group *	createChild (string const &childKey, string const &childName) override
	Create a new ParticleRegion object as a child of this group. More...

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

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

void	resize (integer_array const &numParticles, string_array const &regionNames, string_array const &particleTypes)
	Set the number of particles for a set of particle regions. More...

virtual void	setMaxGlobalIndex () override final
	Set the maximum local and global index.

const subGroupMap &	getRegions () const
	Get a collection of particle regions. More...

subGroupMap &	getRegions ()
	Get a collection of particle regions. More...

template<typename T = ParticleRegionBase, typename KEY_TYPE = void>
const T &	getRegion (KEY_TYPE const &key) const
	Get a particle region. More...

template<typename T = ParticleRegionBase, typename KEY_TYPE = void>
T &	getRegion (KEY_TYPE const &key)
	Get a particle region. More...

template<typename T = ParticleRegionBase>
bool	hasRegion (string const &name) const
	Determines if a ParticleRegion with the input name exists. More...

localIndex	numRegions () const
	Get the number of regions. More...

localIndex	numParticleBlocks () const
	Get the number of particle blocks. More...

template<typename REGIONTYPE = ParticleRegionBase, typename ... REGIONTYPES, typename LAMBDA >
void	forParticleRegions (LAMBDA &&lambda)
	This function is used to launch kernel function over all the particle regions with region type = ParticleRegionBase. More...

template<typename REGIONTYPE = ParticleRegionBase, typename ... REGIONTYPES, typename LAMBDA >
void	forParticleRegions (LAMBDA &&lambda) const
	This const function is used to launch kernel function over all the particle regions with region type = ParticleRegionBase. More...

template<typename REGIONTYPE = ParticleRegionBase, typename ... REGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void	forParticleRegions (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda)
	This function is used to launch kernel function over the target particle regions with region type = ParticleRegionBase. More...

template<typename REGIONTYPE = ParticleRegionBase, typename ... REGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void	forParticleRegions (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda) const
	This const function is used to launch kernel function over the target particle regions with region type = ParticleRegionBase. More...

template<typename LAMBDA >
void	forParticleRegionsComplete (LAMBDA lambda) const
	This const function is used to launch kernel function over all the types of particle regions. More...

template<typename LAMBDA >
void	forParticleRegionsComplete (LAMBDA lambda)
	This function is used to launch kernel function over all the types of particle regions. More...

template<typename REGIONTYPE , typename ... REGIONTYPES, typename LAMBDA >
void	forParticleRegionsComplete (LAMBDA lambda)
	This function is used to launch kernel function over all the particle regions that can be casted to one of the specified region types. More...

template<typename REGIONTYPE , typename ... REGIONTYPES, typename LAMBDA >
void	forParticleRegionsComplete (LAMBDA lambda) const
	This const function is used to launch kernel function over all the particle regions that can be casted to one of the specified region types. More...

template<typename LOOKUP_CONTAINER , typename LAMBDA >
void	forParticleRegionsComplete (LOOKUP_CONTAINER const &targetRegions, LAMBDA lambda) const
	This const function is used to launch kernel function over the specified target particle regions. More...

template<typename LOOKUP_CONTAINER , typename LAMBDA >
void	forParticleRegionsComplete (LOOKUP_CONTAINER const &targetRegions, LAMBDA lambda)
	This function is used to launch kernel function over the specified target particle regions. More...

template<typename REGIONTYPE , typename ... REGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void	forParticleRegionsComplete (LOOKUP_CONTAINER const &targetRegions, LAMBDA lambda)
	This function is used to launch kernel function over the specified target particle regions with region type = specified particle region types. More...

template<typename REGIONTYPE , typename ... REGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void	forParticleRegionsComplete (LOOKUP_CONTAINER const &targetRegions, LAMBDA lambda) const
	This const function is used to launch kernel function over the specified target particle regions with region type = specified particle region types. More...

template<typename LAMBDA >
void	forParticleSubRegions (LAMBDA &&lambda)
	This function is used to launch kernel function over the particle subregions of all the subregion types. More...

template<typename LAMBDA >
void	forParticleSubRegions (LAMBDA &&lambda) const
	This const function is used to launch kernel function over the particle subregions of all the subregion types. More...

template<typename LOOKUP_CONTAINER , typename LAMBDA >
void	forParticleSubRegions (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda)
	This function is used to launch kernel function over the specified target particle subregions. More...

template<typename LOOKUP_CONTAINER , typename LAMBDA >
void	forParticleSubRegions (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda) const
	This const function is used to launch kernel function over the specified target particle subregions. More...

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LAMBDA >
void	forParticleSubRegions (LAMBDA &&lambda)
	This function is used to launch kernel function over the particle subregions of the specified subregion types. More...

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LAMBDA >
void	forParticleSubRegions (LAMBDA &&lambda) const
	This const function is used to launch kernel function over the particle subregions of the specified subregion types. More...

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void	forParticleSubRegions (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda)
	This function is used to launch kernel function over the specified target particle subregions with the specified subregion types. More...

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void	forParticleSubRegions (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda) const
	This const function is used to launch kernel function over the specified target particle subregions with the specified subregion types. More...

template<typename LAMBDA >
void	forParticleSubRegionsComplete (LAMBDA &&lambda) const
	This const function is used to launch kernel function over the particle subregions of all subregion types. More...

template<typename LAMBDA >
void	forParticleSubRegionsComplete (LAMBDA &&lambda)
	This function is used to launch kernel function over the particle subregions of all subregion types. More...

template<typename LOOKUP_CONTAINER , typename LAMBDA >
void	forParticleSubRegionsComplete (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda)
	This function is used to launch kernel function over the specified target particle subregions. More...

template<typename LOOKUP_CONTAINER , typename LAMBDA >
void	forParticleSubRegionsComplete (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda) const
	This const function is used to launch kernel function over the specified target particle subregions. More...

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LAMBDA >
void	forParticleSubRegionsComplete (LAMBDA &&lambda)
	This function is used to launch kernel function over all the particle subregions that can be casted to one of the specified subregion types. More...

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LAMBDA >
void	forParticleSubRegionsComplete (LAMBDA &&lambda) const
	This const function is used to launch kernel function over all the particle subregions that can be casted to one of the specified subregion types. More...

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void	forParticleSubRegionsComplete (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda)
	This function is used to launch kernel function over the specified target particle subregions that can be casted to one of the specified subregion types. More...

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void	forParticleSubRegionsComplete (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda) const
	This const function is used to launch kernel function over the specified target particle subregions that can be casted to one of the specified subregion types. More...

template<typename FIELD_TRAIT >
ParticleViewAccessor< traits::ViewTypeConst< typename FIELD_TRAIT::type > >	constructFieldAccessor (string const &neighborName=string()) const
	This is a const function to construct a ParticleViewAccessor to access the data registered on the mesh. More...

template<typename VIEWTYPE , typename LHS = VIEWTYPE>
ParticleViewAccessor< LHS >	constructViewAccessor (string const &name, string const &neighborName=string()) const
	This is a const function to construct a ParticleViewAccessor to access the data registered on the mesh. More...

template<typename VIEWTYPE , typename LHS = VIEWTYPE>
ParticleViewAccessor< LHS >	constructViewAccessor (string const &name, string const &neighborName=string())
	This is a function to construct a ParticleViewAccessor to access the data registered on the mesh. More...

template<typename T , int NDIM, typename PERM = defaultLayout< NDIM >>
ParticleViewAccessor< ArrayView< T const, NDIM, getUSD< PERM > > >	constructArrayViewAccessor (string const &name, string const &neighborName=string()) const
	This is a function to construct a ParticleViewAccessor to access array data registered on the mesh. More...

template<typename VIEWTYPE >
ParticleViewAccessor< ReferenceWrapper< VIEWTYPE > >	constructReferenceAccessor (string const &viewName, string const &neighborName=string()) const
	This is a const function to construct a ParticleViewAccessor to access the data registered on the mesh. More...

template<typename VIEWTYPE >
ParticleViewAccessor< ReferenceWrapper< VIEWTYPE > >	constructReferenceAccessor (string const &viewName, string const &neighborName=string())
	This is a function to construct a ParticleViewAccessor to access the data registered on the mesh. More...

template<typename VIEWTYPE , typename LHS = VIEWTYPE>
MaterialViewAccessor< LHS >	constructFullMaterialViewAccessor (string const &viewName, constitutive::ConstitutiveManager const &cm) const
	This is a const function to construct a MaterialViewAccessor to access the material data. More...

template<typename VIEWTYPE , typename LHS = VIEWTYPE>
MaterialViewAccessor< LHS >	constructFullMaterialViewAccessor (string const &viewName, constitutive::ConstitutiveManager const &cm)
	This is a function to construct a MaterialViewAccessor to access the material data. More...

template<typename FIELD_TRAIT >
ParticleViewAccessor< traits::ViewTypeConst< typename FIELD_TRAIT::type > >	constructMaterialFieldAccessor (arrayView1d< string const > const &regionNames, arrayView1d< string const > const &materialNames, bool const allowMissingViews=false) const
	This is a const function to construct a MaterialViewAccessor to access the material data for specified regions/materials. More...

template<typename MATERIAL_TYPE , typename FIELD_TRAIT >
ParticleViewAccessor< traits::ViewTypeConst< typename FIELD_TRAIT::type > >	constructMaterialFieldAccessor (bool const allowMissingViews=false) const
	This is a const function to construct a MaterialViewAccessor to access the material data for specified material type. More...

template<typename VIEWTYPE , typename LHS = VIEWTYPE>
ParticleViewAccessor< LHS >	constructMaterialViewAccessor (string const &viewName, arrayView1d< string const > const &regionNames, string const &materialKeyName, bool const allowMissingViews=false) const
	This is a const function to construct a MaterialViewAccessor to access the material data for specified regions/materials. More...

template<typename VIEWTYPE , typename LHS = VIEWTYPE>
ParticleViewAccessor< LHS >	constructMaterialViewAccessor (string const &viewName, arrayView1d< string const > const &regionNames, string const &materialKeyName, bool const allowMissingViews=false)
	This is a function to construct a MaterialViewAccessor to access the material data for specified regions/materials. More...

template<typename T , int NDIM, typename PERM = defaultLayout< NDIM >>
ParticleViewAccessor< ArrayView< T const, NDIM, getUSD< PERM > > >	constructMaterialArrayViewAccessor (string const &viewName, arrayView1d< string const > const &regionNames, string const &materialKeyName, bool const allowMissingViews=false) const
	Construct a view accessor for material data, assuming array as storage type. More...

template<typename MATERIALTYPE , typename VIEWTYPE , typename LHS = VIEWTYPE>
ParticleViewAccessor< LHS >	constructMaterialViewAccessor (string const &viewName) const
	Construct a const view accessor to material data for specified material type. More...

template<typename MATERIALTYPE , typename T , int NDIM, typename PERM = defaultLayout< NDIM >>
ParticleViewAccessor< ArrayView< T const, NDIM, getUSD< PERM > > >	constructMaterialArrayViewAccessor (string const &viewName) const
	Construct a const view accessor for material data, assuming array as storage type. More...

template<typename CONSTITUTIVE_TYPE >
ConstitutiveRelationAccessor< CONSTITUTIVE_TYPE >	constructFullConstitutiveAccessor (constitutive::ConstitutiveManager const &cm) const
	Construct a ConstitutiveRelationAccessor. More...

template<typename CONSTITUTIVE_TYPE >
ConstitutiveRelationAccessor< CONSTITUTIVE_TYPE >	constructFullConstitutiveAccessor (constitutive::ConstitutiveManager const &cm)
	Construct a ConstitutiveRelationAccessor. More...

int	PackSize (string_array const &wrapperNames, ParticleViewAccessor< arrayView1d< localIndex > > const &packList) const
	Get the buffer size needed to pack a list of wrappers. More...

int	Pack (buffer_unit_type *&buffer, string_array const &wrapperNames, ParticleViewAccessor< arrayView1d< localIndex > > const &packList) const
	Pack a list of wrappers to a buffer. More...

int	Unpack (buffer_unit_type const *&buffer, ParticleViewAccessor< arrayView1d< localIndex > > &packList)
	Unpack a buffer. More...

int	Unpack (buffer_unit_type const *&buffer, ParticleReferenceAccessor< array1d< localIndex > > &packList)
	Unpack a buffer. More...

int	PackGlobalMapsSize (ParticleViewAccessor< arrayView1d< localIndex > > const &packList) const
	Get the size of the buffer to be packed. More...

int	PackGlobalMaps (buffer_unit_type *&buffer, ParticleViewAccessor< arrayView1d< localIndex > > const &packList) const
	Pack a buffer. More...

int	UnpackGlobalMaps (buffer_unit_type const *&buffer, ParticleViewAccessor< ReferenceWrapper< localIndex_array > > &packList)
	Unpack a buffer. More...

void	updateMaps ()
	Updates the globalToLocal and localToGlobal maps.

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

virtual localIndex	packSize (string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) 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 onDevice, parallelDeviceEvents &events) const
	Get the size required to pack a list of indices within a list of wrappers. More...

localIndex	packSize (arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Get the size required to pack a list of indices for all registered wrappers. More...

virtual localIndex	pack (buffer_unit_type *&buffer, string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) 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 onDevice, parallelDeviceEvents &events) const
	Pack a list of indices within a list of wrappers. More...

localIndex	pack (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Pack a list of indices for all registered wrappers. More...

virtual localIndex	packGlobalMapsSize (arrayView1d< localIndex const > const &packList, integer const recursive) const
	Computes the pack size of the global maps elements in the @ packList. More...

virtual localIndex	packGlobalMaps (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList, integer const recursive) const
	Packs the global maps elements in the @ packList. More...

virtual localIndex	unpackGlobalMaps (buffer_unit_type const *&buffer, localIndex_array &packList, integer const recursive)
	Unpacks the global maps from `buffer`. More...

virtual localIndex	unpack (buffer_unit_type const *&buffer, arrayView1d< localIndex > &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events, MPI_Op op=MPI_REPLACE) override
	Unpack a buffer. More...

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

	~ObjectManagerBase () override
	Destructor.

virtual localIndex	packSize (string_array const &wrapperNames, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const override
	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, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const override
	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 onDevice, parallelDeviceEvents &events, MPI_Op op=MPI_REPLACE) override
	Unpack a buffer. More...

template<bool DO_PACKING>
localIndex	packSets (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList) const
	Packs the elements of each set that actually are in `packList`. More...

localIndex	unpackSets (buffer_unit_type const *&buffer)
	Unpack the content of `buffer` into the sets of the instance. More...

void	excludeWrappersFromPacking (std::set< string > const &wrapperNames)
	Registers wrappers that will be excluded from packing. More...

virtual localIndex	packGlobalMapsSize (arrayView1d< localIndex const > const &packList, integer const recursive) const
	Computes the pack size of the global maps elements in the @ packList. More...

virtual localIndex	packGlobalMaps (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList, integer const recursive) const
	Packs the global maps elements in the @ packList. More...

void	setReceiveLists ()
	Clear and redefines the ghosts to receive.

virtual localIndex	packUpDownMapsSize (arrayView1d< localIndex const > const &packList) const
	Computes the pack size of the specific elements in the @ packList. More...

virtual localIndex	packUpDownMaps (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList) const
	Packs the specific elements in the @ packList. More...

virtual localIndex	unpackUpDownMaps (buffer_unit_type const *&buffer, array1d< localIndex > &packList, bool const overwriteUpMaps, bool const overwriteDownMaps)
	Unpacks the specific elements in the @ packList. More...

virtual localIndex	unpackGlobalMaps (buffer_unit_type const *&buffer, localIndex_array &packList, integer const recursive)
	Unpacks the global maps from `buffer`. More...

localIndex	packParentChildMapsSize (arrayView1d< localIndex const > const &packList) const
	Computes the pack size of the parent/child relations in `packList`. More...

localIndex	packParentChildMaps (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList) const
	Packs the parent/child relations in `packList`. More...

localIndex	unpackParentChildMaps (buffer_unit_type const *&buffer, localIndex_array &packList)
	Unacks the parent/child relations in `packList`. More...

void	moveSets (LvArray::MemorySpace const targetSpace)
	Manually move all sets to a memory space. More...

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

SortedArray< localIndex > &	createSet (const string &newSetName)
	Creates a new set. More...

void	constructSetFromSetAndMap (SortedArrayView< localIndex const > const &inputSet, const array2d< localIndex > &map, const string &setName)
	Builds a new set on this instance given another objects set and the map between them. More...

void	constructSetFromSetAndMap (SortedArrayView< localIndex const > const &inputSet, const array1d< localIndex_array > &map, const string &setName)
	Builds a new set on this instance given another objects set and the map between them. More...

void	constructSetFromSetAndMap (SortedArrayView< localIndex const > const &inputSet, ArrayOfArraysView< localIndex const > const &map, const string &setName)
	Builds a new set on this instance given another objects set and the map between them. More...

void	constructGlobalToLocalMap ()
	Constructs the global to local map.

array1d< globalIndex >	constructGlobalListOfBoundaryObjects () const
	Computes the (global) index list that are domain boundaries. More...

virtual ArrayOfSets< globalIndex >	extractMapFromObjectForAssignGlobalIndexNumbers (ObjectManagerBase const &nodeManager)
	Extract map from object and assign global indices. More...

void	setGhostRankForSenders (int const neighborRank)
	Defines `neighborRank` ownership for ghost objects. More...

localIndex	getNumberOfGhosts () const
	Get the number of ghost objects. More...

localIndex	getNumberOfLocalIndices () const
	Get the number of locally owned objects. More...

integer	splitObject (localIndex const indexToSplit, int const rank, localIndex &newIndex)
	Split object to deal with topology changes. More...

void	inheritGhostRankFromParent (std::set< localIndex > const &indices)
	sets the value of m_ghostRank to the value of the objects parent. More...

void	copyObject (localIndex const source, localIndex const destination)
	Copy object from `source` to @ destination. More...

void	eraseObject (std::set< localIndex > const &indicesToErase)
	Erase object from this object manager. More...

virtual void	enforceStateFieldConsistencyPostTopologyChange (std::set< localIndex > const &targetIndices)
	Updates the child and target indices after a topology change. More...

template<typename FIELD_TRAIT >
dataRepository::Wrapper< typename FIELD_TRAIT::type > &	registerField (string const &nameOfRegisteringObject)
	Register field with this ObjectManagerBase using a `dataRepository::Wrapper`. More...

template<typename FIELD_TRAIT >
dataRepository::Wrapper< typename FIELD_TRAIT::type > &	registerField (FIELD_TRAIT const &fieldTrait, typename FIELD_TRAIT::type *newObject)
	Helper function to register fields. More...

template<typename FIELD_TRAIT0 , typename FIELD_TRAIT1 , typename ... FIELD_TRAITS>
void	registerField (string const &nameOfRegisteringObject)
	Register a collection of fields with this ObjectManagerBase using a dataRepository::Wrapper. More...

template<typename FIELD_TRAIT >
GEOS_DECLTYPE_AUTO_RETURN	getField () const
	Get a view to the field associated with a trait from this `ObjectManagerBase`. More...

template<typename FIELD_TRAIT >
GEOS_DECLTYPE_AUTO_RETURN	getField ()
	Get the field associated with a trait from this `ObjectManagerBase`. More...

template<typename FIELD_TRAIT >
bool	hasField () const
	Checks if a field has been registered. More...

virtual viewKeyStruct &	viewKeys ()
	Get the view keys for Group access. More...

virtual const viewKeyStruct &	viewKeys () const
	Get the view keys for Group access, const version. More...

virtual groupKeyStruct &	groupKeys ()
	Get the group keys for Group access. More...

virtual const groupKeyStruct &	groupKeys () const
	Get the group keys for Group access, const version. More...

Group &	sets ()
	Get the group holding the object sets. More...

const Group &	sets () const
	Get the group holding the object sets, const version. More...

SortedArray< localIndex > &	getSet (string const &setName)
	Get a set by name. More...

SortedArrayView< localIndex const >	getSet (string const &setName) const
	Get a set by name, const version. More...

SortedArray< localIndex > &	externalSet ()
	Get the external set. More...

SortedArrayView< localIndex const >	externalSet () const
	Get the external set, const version. More...

void	updateGlobalToLocalMap (localIndex const lid)
	Updates (if needed) the global index for local index `lid`. More...

arrayView1d< globalIndex >	localToGlobalMap ()
	Get local to global map. More...

arrayView1d< globalIndex const >	localToGlobalMap () const
	Get local to global map, const version. More...

const unordered_map< globalIndex, localIndex > &	globalToLocalMap () const
	Get global to local map. More...

localIndex	globalToLocalMap (globalIndex const gid) const
	Retrieves the local index for given global index. More...

const array1d< integer > &	isExternal ()
	Get the locality information of the objects. More...

arrayView1d< integer const >	isExternal () const
	Get the locality information of the objects. More...

const array1d< integer > &	ghostRank ()
	Get the ghost information of each object. More...

arrayView1d< integer const >	ghostRank () const
	Get the ghost information of each object, const version. More...

NeighborData &	getNeighborData (int const rank)
	Get neighbor data for given `rank`. More...

const NeighborData &	getNeighborData (int const rank) const
	Get neighbor data for given `rank`, const version. More...

void	addNeighbor (int const rank)
	Add a neighbor for `rank`. More...

void	removeNeighbor (int const rank)
	Remove neighbor for `rank`. More...

globalIndex	localMaxGlobalIndex () const
	Get the local maximum global index on this rank. More...

globalIndex	maxGlobalIndex () const
	Get the maximum global index of all objects across all rank. See. More...

array1d< integer > &	getDomainBoundaryIndicator ()
	Get the domain boundary indicator. More...

arrayView1d< integer const >	getDomainBoundaryIndicator () const
	Get the domain boundary indicator. More...

Public Member Functions inherited from geos::dataRepository::Group
virtual bool	registerCallback (void *func, const std::type_info &funcType)
	Register a callback function on the group. More...

virtual void	reinit ()
	Performs re-initialization of certain variable depending on the solver being used.

	Group (string const &name, Group *const parent)
	Constructor. More...

	Group (string const &name, conduit::Node &rootNode)
	Constructor. More...

	Group (Group &&source)=default
	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 &	operator= (Group const &)=delete
	Deleted copy assignment operator. More...

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

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

string	dumpInputOptions () const

string	dumpSubGroupsNames () const

string	dumpWrappersNames () const

template<typename T = Group>
T &	registerGroup (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 (string const &name, T *newObject)
	Register a new Group as a sub-group of current Group. More...

template<typename T = Group>
T &	registerGroup (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 (string const &name, string const &catalogName)
	Register a new Group as a sub-group of current Group. More...

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

template<typename T = Group, typename KEY = void>
T *	getGroupPointer (KEY const &key)
	Return a pointer to a sub-group of the current Group. More...

template<typename T = Group, typename KEY = void>
const T *	getGroupPointer (KEY const &key) const
	Return a pointer to a sub-group of the current Group. More...

template<typename T = Group, typename KEY = void>
T &	getGroup (KEY const &key)
	Return a reference to a sub-group of the current Group. More...

template<typename T = Group, typename KEY = void>
const T &	getGroup (KEY const &key) const
	Return a reference to a sub-group of the current Group. More...

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

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

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

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

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

std::vector< string >	getSubGroupsNames () const

template<typename T = Group>
bool	hasGroup (string const &name) const
	Check whether a sub-group exists. More...

template<typename T >
bool	hasSubGroupOfType () const
	Check whether a sub-group exists by type. 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 LAMBDA >
void	forSubGroupsIndex (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	forSubGroupsIndex (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)
	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) const
	Apply the given functor to subgroups that can be casted to one of specified types. More...

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

virtual void	initialize_postMeshGeneration ()
	initialization post generation of the mesh.

void	initialize ()
	Run initialization functions on this and all subgroups. More...

virtual void	initializationOrder (string_array &order)
	Sets the initialization order for sub-Groups. More...

void	initializePostInitialConditions ()
	Initialization routine to be called after calling ApplyInitialConditions(). More...

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

void	processInputFileRecursive (xmlWrapper::xmlDocument &xmlDocument, xmlWrapper::xmlNode &targetNode)
	Recursively read values using ProcessInputFile() from the input file and put them into the wrapped values for this group. Also add the includes content to the xmlDocument when `Include` nodes are encountered. More...

void	processInputFileRecursive (xmlWrapper::xmlDocument &xmlDocument, xmlWrapper::xmlNode &targetNode, xmlWrapper::xmlNodePos const &nodePos)
	Same as processInputFileRecursive(xmlWrapper::xmlDocument &, xmlWrapper::xmlNode &) but allow to reuse an existing xmlNodePos. More...

void	postProcessInputRecursive ()
	Recursively call postProcessInput() to apply post processing after reading input values.

template<typename T , typename TBASE = T>
Wrapper< TBASE > &	registerWrapper (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)
	Create and register a Wrapper around a new object. More...

template<typename T >
Wrapper< T > &	registerWrapper (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 (string const &name, T *newObject)
	Register a Wrapper around an existing object, does not take ownership of the object. More...

WrapperBase &	registerWrapper (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	registerDataOnMeshRecursive (Group &meshBodies)
	Calls RegisterDataOnMesh() recursively. More...

virtual void	registerDataOnMesh (Group &meshBodies)
	Register data on mesh entities. More...

virtual localIndex	packSize (string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Get the size required to pack a list of wrappers. More...

localIndex	packSize (arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Get the size required to pack a list of indices for all registered wrappers. More...

virtual localIndex	pack (buffer_unit_type *&buffer, string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Pack a list of wrappers to a buffer. More...

localIndex	pack (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Pack a list of indices for all registered wrappers. More...

template<typename KEY >
const WrapperBase &	getWrapperBase (KEY const &key) const
	Return a reference to a WrapperBase stored in this group. More...

template<typename KEY >
WrapperBase &	getWrapperBase (KEY const &key)
	Return a reference to a WrapperBase stored in this group. More...

indexType	getWrapperIndex (string const &name) const

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

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

indexType	numWrappers () const
	Return the number of wrappers. More...

std::vector< string >	getWrappersNames () const

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

template<typename T , typename LOOKUP_TYPE >
const Wrapper< T > &	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 , typename LOOKUP_TYPE >
const Wrapper< T > *	getWrapperPointer (LOOKUP_TYPE const &index) const
	Retrieve a Wrapper stored in this group. More...

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

template<typename T , typename LOOKUP_TYPE >
GEOS_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...

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

string	getPath () const
	Return the path of this Group in the data repository. Starts with '/' followed by the hierarchy of the children of the "Problem" in which the Group is. More...

const DataContext &	getDataContext () const

template<typename KEY >
const DataContext &	getWrapperDataContext (KEY key) const

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

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

bool	hasParent () const

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

localIndex	getSubGroupIndex (keyType const &key) const
	Get the index of a sub-Group within this group. More...

int	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 ()
	Return the Conduit node object associated with this group. More...

const conduit::Node &	getConduitNode () const
	Return 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.

void	setLogLevel (integer const logLevel)
	Set verbosity level. More...

integer	getLogLevel () const

Static Public Member Functions
static string	catalogName ()
	The function is to return the name of the ParticleManager in the object catalog. More...

Static Public Member Functions inherited from geos::ObjectManagerBase
template<typename TYPE_RELATION >
static void	fixUpDownMaps (TYPE_RELATION &relation, map< localIndex, array1d< globalIndex > > &unmappedIndices, bool const clearIfUnmapped)
	Fixing the up/down maps by mapping the unmapped indices. More...

template<typename TYPE_RELATION >
static void	fixUpDownMaps (TYPE_RELATION &relation, map< localIndex, SortedArray< globalIndex > > &unmappedIndices, bool const clearIfUnmapped)
	Fixing the up/down maps by mapping the unmapped indices. More...

static void	fixUpDownMaps (ArrayOfSets< localIndex > &relation, unordered_map< globalIndex, localIndex > const &globalToLocal, map< localIndex, SortedArray< globalIndex > > &unmappedIndices, bool const clearIfUnmapped)
	Fixing the up/down maps by mapping the unmapped indices. More...

static void	cleanUpMap (std::set< localIndex > const &targetIndices, array1d< SortedArray< localIndex > > &upmap, arrayView2d< localIndex const > const &downmap)
	Removes from the list of arrays of `upmap` all the elements for which the "mirror target array" of `downmap` does not contain the proper target index. More...

static void	cleanUpMap (std::set< localIndex > const &targetIndices, ArrayOfSetsView< localIndex > const &upmap, arrayView2d< localIndex const > const &downmap)
	Removes from the list of sets of `upmap` all the elements for which the "mirror target array" of `downmap` does not contain the proper target index. More...

static void	cleanUpMap (std::set< localIndex > const &targetIndices, array1d< SortedArray< localIndex > > &upmap, arrayView1d< arrayView1d< localIndex const > const > const &downmap)
	Removes from the list of arrays of `upmap` all the elements for which the "mirror target array" of `downmap` does not contain the proper target index. More...

static void	cleanUpMap (std::set< localIndex > const &targetIndices, ArrayOfSetsView< localIndex > const &upmap, arrayView1d< arrayView1d< localIndex const > const > const &downmap)
	Removes from the list of sets of `upmap` all the elements for which the "mirror target array" of `downmap` does not contain the proper target index. More...

static void	cleanUpMap (std::set< localIndex > const &targetIndices, ArrayOfSetsView< localIndex > const &upmap, ArrayOfArraysView< localIndex const > const &downmap)
	Removes from the list of sets of `upmap` all the elements for which the "mirror target array" of `downmap` does not contain the proper target index. More...

static localIndex	getParentRecursive (arraySlice1d< localIndex const > const &parentIndices, localIndex const lookup)
	Get the upmost parent. More...

static CatalogInterface::CatalogType &	getCatalog ()
	Acessing the unique instance of this catalog. More...

Static Public Member Functions inherited from geos::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...

Additional Inherited Members
Public Attributes inherited from geos::ObjectManagerBase
struct geos::ObjectManagerBase::viewKeyStruct	m_ObjectManagerBaseViewKeys
	viewKey struct for the ObjectManagerBase class

struct geos::ObjectManagerBase::groupKeyStruct	m_ObjectManagerBaseGroupKeys
	groupKey struct for the ObjectManagerBase class

Protected Member Functions inherited from geos::dataRepository::Group
virtual void	postProcessInput ()

virtual void	initializePreSubGroups ()
	Called by Initialize() prior to initializing sub-Groups.

virtual void	initializePostSubGroups ()
	Called by Initialize() after to initializing sub-Groups.

virtual void	initializePostInitialConditionsPreSubGroups ()
	Called by InitializePostInitialConditions() prior to initializing sub-Groups.

virtual void	initializePostInitialConditionsPostSubGroups ()
	Called by InitializePostInitialConditions() after to initializing sub-Groups.

virtual void	postRestartInitialization ()
	Performs initialization required after reading from a restart file.

Protected Attributes inherited from geos::ObjectManagerBase
Group	m_sets
	Group that holds object sets.

std::set< string >	m_packingExclusionList
	Names of the wrappers that should not be packed.

Group	m_neighborGroup
	Group that holds all the NeighborData objects.

array1d< globalIndex >	m_localToGlobalMap
	Contains the global index of each object.

unordered_map< globalIndex, localIndex >	m_globalToLocalMap
	Map from object global index to the local index.

array1d< integer >	m_isExternal
	Array that holds if an object is external.

array1d< integer >	m_domainBoundaryIndicator
	Domain boundary indicator: 1 means the "index" is on the boundary.

array1d< integer >	m_ghostRank
	Array that holds the ghost information about each object. More...

unordered_map< int, NeighborData >	m_neighborData
	A map from rank to the associated NeighborData object.

real64	m_overAllocationFactor = 1.1
	Factor by which to overallocate when adding objects.

globalIndex	m_maxGlobalIndex = -1
	The maximum global index of all objects across all rank.

globalIndex	m_localMaxGlobalIndex = -1
	The maximum global index of any object of all objects on this rank.

Detailed Description

The ParticleManager class provides an interface to ObjectManagerBase in order to manage ParticleRegion data.

Definition at line 41 of file ParticleManager.hpp.

Member Typedef Documentation

◆ ConstitutiveRelationAccessor

template<typename CONSTITUTIVE_TYPE >

using geos::ParticleManager::ConstitutiveRelationAccessor = array1d< array1d< array1d< CONSTITUTIVE_TYPE * > > >

The ConstitutiveRelationAccessor at the ParticleManager level is a 3D array of CONSTITUTIVE_TYPE.

Template Parameters

CONSTITUTIVE_TYPE constitutive type

Definition at line 97 of file ParticleManager.hpp.

◆ MaterialViewAccessor

template<typename VIEWTYPE >

using geos::ParticleManager::MaterialViewAccessor = array1d< array1d< array1d< VIEWTYPE > > >

The MaterialViewAccessor at the ParticleManager level is a 3D array of VIEWTYPE.

Template Parameters

VIEWTYPE data type var[particleRegionIndex][particleSubRegionIndex][materialIndexInRegion]

Definition at line 90 of file ParticleManager.hpp.

◆ ParticleReferenceAccessor

template<typename VIEWTYPE >

using geos::ParticleManager::ParticleReferenceAccessor = array1d< array1d< ReferenceWrapper< VIEWTYPE > > >

The ParticleViewAccessor at the ParticleManager level is a 2D array of ReferenceWrapper around VIEWTYPE.

Template Parameters

VIEWTYPE data type

Definition at line 82 of file ParticleManager.hpp.

◆ ParticleView

template<typename VIEWTYPE >

using geos::ParticleManager::ParticleView = typename ParticleViewAccessor< VIEWTYPE >::NestedViewType

The ParticleViewAccessor at the ParticleManager level is the type resulting from ParticleViewAccessor< VIEWTYPE >::toNestedView().

Template Parameters

VIEWTYPE data type

Definition at line 67 of file ParticleManager.hpp.

◆ ParticleViewAccessor

template<typename VIEWTYPE >

using geos::ParticleManager::ParticleViewAccessor = array1d< array1d< VIEWTYPE > >

The ParticleViewAccessor at the ParticleManager level is an array of array of VIEWTYPE.

Template Parameters

VIEWTYPE data type

Definition at line 59 of file ParticleManager.hpp.

◆ ParticleViewConst

template<typename VIEWTYPE >

using geos::ParticleManager::ParticleViewConst = typename ParticleViewAccessor< VIEWTYPE >::NestedViewTypeConst

The ParticleViewAccessor at the ParticleManager level is the type resulting from ParticleViewAccessor< VIEWTYPE >::toNestedViewConst().

Template Parameters

VIEWTYPE data type

Definition at line 75 of file ParticleManager.hpp.

Constructor & Destructor Documentation

◆ ParticleManager()

geos::ParticleManager::ParticleManager	(	string const &	name,
		Group *const	parent
	)

Constructor.

Parameters

[in]	name	the name of this ObjectManager
[in]	parent	the parent Group

Member Function Documentation

◆ catalogName()

static string geos::ParticleManager::catalogName ( )

inlinestatic

The function is to return the name of the ParticleManager in the object catalog.

Returns: string that contains the catalog name used to register/lookup this class in the object catalog

Definition at line 103 of file ParticleManager.hpp.

◆ constructArrayViewAccessor()

template<typename T , int NDIM, typename PERM >

ParticleManager::ParticleViewAccessor< ArrayView< T const, NDIM, getUSD< PERM > > > geos::ParticleManager::constructArrayViewAccessor	(	string const &	name,
		string const &	neighborName = `string()`
	)		const

This is a function to construct a ParticleViewAccessor to access array data registered on the mesh.

Template Parameters

T	data type
NDIM	number of array dimensions
PERM	layout permutation sequence type

Parameters

name	view name of the data
neighborName	neighbor data name

Returns: ParticleViewAccessor that contains ArrayView<T const, NDIM> of data

Definition at line 1141 of file ParticleManager.hpp.

◆ constructFieldAccessor()

template<typename FIELD_TRAIT >

ParticleManager::ParticleViewAccessor< traits::ViewTypeConst< typename FIELD_TRAIT::type > > geos::ParticleManager::constructFieldAccessor ( string const & neighborName = string() ) const

This is a const function to construct a ParticleViewAccessor to access the data registered on the mesh.

Template Parameters

FIELD_TRAIT field type

Parameters

neighborName neighbor data name

Returns: ParticleViewAccessor that contains traits::ViewTypeConst< typename TRAIT::type > data

Definition at line 1133 of file ParticleManager.hpp.

◆ constructFullConstitutiveAccessor() [1/2]

template<typename CONSTITUTIVE_TYPE >

ParticleManager::ConstitutiveRelationAccessor< CONSTITUTIVE_TYPE > geos::ParticleManager::constructFullConstitutiveAccessor ( constitutive::ConstitutiveManager const & cm )

Construct a ConstitutiveRelationAccessor.

Template Parameters

CONSTITUTIVE_TYPE constitutive type

Parameters

cm	pointer to ConstitutiveManager

Returns: ConstitutiveRelationAccessor

Definition at line 1489 of file ParticleManager.hpp.

◆ constructFullConstitutiveAccessor() [2/2]

template<typename CONSTITUTIVE_TYPE >

ParticleManager::ConstitutiveRelationAccessor< CONSTITUTIVE_TYPE > geos::ParticleManager::constructFullConstitutiveAccessor ( constitutive::ConstitutiveManager const & cm ) const

Construct a ConstitutiveRelationAccessor.

Template Parameters

CONSTITUTIVE_TYPE constitutive type

Parameters

cm	pointer to ConstitutiveManager

Returns: ConstitutiveRelationAccessor

Definition at line 1456 of file ParticleManager.hpp.

◆ constructFullMaterialViewAccessor() [1/2]

template<typename VIEWTYPE , typename LHS >

ParticleManager::MaterialViewAccessor< LHS > geos::ParticleManager::constructFullMaterialViewAccessor	(	string const &	viewName,
		constitutive::ConstitutiveManager const &	cm
	)

This is a function to construct a MaterialViewAccessor to access the material data.

Template Parameters

VIEWTYPE data type

Parameters

viewName	view name of the data
cm	pointer to ConstitutiveManager

Returns: MaterialViewAccessor that contains VIEWTYPE data

Definition at line 1245 of file ParticleManager.hpp.

◆ constructFullMaterialViewAccessor() [2/2]

template<typename VIEWTYPE , typename LHS >

ParticleManager::MaterialViewAccessor< LHS > geos::ParticleManager::constructFullMaterialViewAccessor	(	string const &	viewName,
		constitutive::ConstitutiveManager const &	cm
	)		const

This is a const function to construct a MaterialViewAccessor to access the material data.

Template Parameters

VIEWTYPE data type

Parameters

viewName	view name of the data
cm	pointer to ConstitutiveManager

Returns: MaterialViewAccessor that contains VIEWTYPE data

Definition at line 1208 of file ParticleManager.hpp.

◆ constructMaterialArrayViewAccessor() [1/2]

template<typename MATERIALTYPE , typename T , int NDIM, typename PERM >

ParticleManager::ParticleViewAccessor< ArrayView< T const, NDIM, getUSD< PERM > > > geos::ParticleManager::constructMaterialArrayViewAccessor ( string const & viewName ) const

Construct a const view accessor for material data, assuming array as storage type.

Template Parameters

MATERIALTYPE
T	underlying data type
NDIM	number of array dimensions
PERM	layout permutation sequence type

Parameters

viewName view name of the data

Returns: MaterialViewAccessor that contains the data views. Empty views are returned for subregions that don't contain a model derived from MODELTYPE.

Definition at line 1449 of file ParticleManager.hpp.

◆ constructMaterialArrayViewAccessor() [2/2]

template<typename T , int NDIM, typename PERM >

ParticleManager::ParticleViewAccessor< ArrayView< T const, NDIM, getUSD< PERM > > > geos::ParticleManager::constructMaterialArrayViewAccessor	(	string const &	viewName,
		arrayView1d< string const > const &	regionNames,
		string const &	materialKeyName,
		bool const	allowMissingViews = `false`
	)		const

Construct a view accessor for material data, assuming array as storage type.

Template Parameters

T	underlying data type
NDIM	number of array dimensions
PERM	layout permutation sequence type

Parameters

viewName	view name of the data
regionNames	list of region names
materialKeyName	key of the wrapper that holds the material name on the subRegion.
allowMissingViews	flag to indicate whether it is allowed to miss the specified material data in material list

Returns: MaterialViewAccessor that contains the data views

Definition at line 1399 of file ParticleManager.hpp.

◆ constructMaterialFieldAccessor() [1/2]

template<typename FIELD_TRAIT >

ParticleManager::ParticleViewAccessor< traits::ViewTypeConst< typename FIELD_TRAIT::type > > geos::ParticleManager::constructMaterialFieldAccessor	(	arrayView1d< string const > const &	regionNames,
		arrayView1d< string const > const &	materialNames,
		bool const	allowMissingViews = `false`
	)		const

This is a const function to construct a MaterialViewAccessor to access the material data for specified regions/materials.

Template Parameters

FIELD_TRAIT field trait

Parameters

regionNames	list of region names
materialNames	list of corresponding material names
allowMissingViews	flag to indicate whether it is allowed to miss the specified material data in material list

Returns: ParticleViewAccessor that contains traits::ViewTypeConst< typename FIELD_TRAIT::type > data

Definition at line 1377 of file ParticleManager.hpp.

◆ constructMaterialFieldAccessor() [2/2]

template<typename MATERIAL_TYPE , typename FIELD_TRAIT >

ParticleManager::ParticleViewAccessor< traits::ViewTypeConst< typename FIELD_TRAIT::type > > geos::ParticleManager::constructMaterialFieldAccessor ( bool const allowMissingViews = false ) const

This is a const function to construct a MaterialViewAccessor to access the material data for specified material type.

Template Parameters

MATERIAL_TYPE	base type of material model
FIELD_TRAIT	field trait

Parameters

allowMissingViews flag to indicate whether it is allowed to miss the specified material data in material list

Returns: ParticleViewAccessor that contains traits::ViewTypeConst< typename TRAIT::type > data

Definition at line 1390 of file ParticleManager.hpp.

◆ constructMaterialViewAccessor() [1/3]

template<typename MATERIALTYPE , typename VIEWTYPE , typename LHS >

ParticleManager::ParticleViewAccessor< LHS > geos::ParticleManager::constructMaterialViewAccessor ( string const & viewName ) const

Construct a const view accessor to material data for specified material type.

Template Parameters

MATERIALTYPE	base type of material model
VIEWTYPE	data type

Parameters

viewName view name of the data

Returns: ParticleViewAccessor that contains VIEWTYPE data. Empty views are returned for subregions that don't contain a model derived from MODELTYPE.

Definition at line 1412 of file ParticleManager.hpp.

◆ constructMaterialViewAccessor() [2/3]

template<typename VIEWTYPE , typename LHS >

ParticleManager::ParticleViewAccessor< LHS > geos::ParticleManager::constructMaterialViewAccessor	(	string const &	viewName,
		arrayView1d< string const > const &	regionNames,
		string const &	materialKeyName,
		bool const	allowMissingViews = `false`
	)

This is a function to construct a MaterialViewAccessor to access the material data for specified regions/materials.

Template Parameters

VIEWTYPE data type

Parameters

viewName	view name of the data
regionNames	list of region names
materialKeyName	key of the wrapper that holds the material name on the subRegion.
allowMissingViews	flag to indicate whether it is allowed to miss the specified material data in material list

Returns: ParticleViewAccessor that contains VIEWTYPE data

Definition at line 1330 of file ParticleManager.hpp.

◆ constructMaterialViewAccessor() [3/3]

template<typename VIEWTYPE , typename LHS >

ParticleManager::ParticleViewAccessor< LHS > geos::ParticleManager::constructMaterialViewAccessor	(	string const &	viewName,
		arrayView1d< string const > const &	regionNames,
		string const &	materialKeyName,
		bool const	allowMissingViews = `false`
	)		const

This is a const function to construct a MaterialViewAccessor to access the material data for specified regions/materials.

Template Parameters

VIEWTYPE data type

Parameters

viewName	view name of the data
regionNames	list of region names
materialKeyName	key of the wrapper that holds the material name on the subRegion.
allowMissingViews	flag to indicate whether it is allowed to miss the specified material data in material list

Returns: ParticleViewAccessor that contains VIEWTYPE data

Definition at line 1282 of file ParticleManager.hpp.

◆ constructReferenceAccessor() [1/2]

template<typename VIEWTYPE >

ParticleManager::ParticleViewAccessor< ReferenceWrapper< VIEWTYPE > > geos::ParticleManager::constructReferenceAccessor	(	string const &	viewName,
		string const &	neighborName = `string()`
	)

This is a function to construct a ParticleViewAccessor to access the data registered on the mesh.

Template Parameters

VIEWTYPE data type

Parameters

viewName	view name of the data
neighborName	neighbor data name

Returns: ParticleViewAccessor that contains pointers to wrapped VIEWTYPE data

Definition at line 1179 of file ParticleManager.hpp.

◆ constructReferenceAccessor() [2/2]

template<typename VIEWTYPE >

ParticleManager::ParticleViewAccessor< ReferenceWrapper< VIEWTYPE > > geos::ParticleManager::constructReferenceAccessor	(	string const &	viewName,
		string const &	neighborName = `string()`
	)		const

This is a const function to construct a ParticleViewAccessor to access the data registered on the mesh.

Template Parameters

VIEWTYPE data type

Parameters

viewName	view name of the data
neighborName	neighbor data name

Returns: ParticleViewAccessor that contains pointers to wrapped VIEWTYPE data

Definition at line 1150 of file ParticleManager.hpp.

◆ constructViewAccessor() [1/2]

template<typename VIEWTYPE , typename LHS >

ParticleManager::ParticleViewAccessor< LHS > geos::ParticleManager::constructViewAccessor	(	string const &	name,
		string const &	neighborName = `string()`
	)

This is a function to construct a ParticleViewAccessor to access the data registered on the mesh.

Template Parameters

VIEWTYPE data type

Parameters

name	view name of the data
neighborName	neighbor data name

Returns: ParticleViewAccessor that contains VIEWTYPE data

Definition at line 1103 of file ParticleManager.hpp.

◆ constructViewAccessor() [2/2]

template<typename VIEWTYPE , typename LHS >

ParticleManager::ParticleViewAccessor< LHS > geos::ParticleManager::constructViewAccessor	(	string const &	name,
		string const &	neighborName = `string()`
	)		const

This is a const function to construct a ParticleViewAccessor to access the data registered on the mesh.

Template Parameters

VIEWTYPE data type

Parameters

name	view name of the data
neighborName	neighbor data name

Returns: ParticleViewAccessor that contains VIEWTYPE data

Definition at line 1072 of file ParticleManager.hpp.

◆ createChild()

virtual Group* geos::ParticleManager::createChild	(	string const &	childKey,
		string const &	childName
	)

overridevirtual

Create a new ParticleRegion object as a child of this group.

Parameters

childKey	catalog key of the new ParticleRegion derived type to create
childName	name of the new ParticleRegion object

Returns: pointer to the created ParticleRegion object

Reimplemented from geos::dataRepository::Group.

◆ forParticleRegions() [1/4]

template<typename REGIONTYPE = ParticleRegionBase, typename ... REGIONTYPES, typename LAMBDA >

void geos::ParticleManager::forParticleRegions ( LAMBDA && lambda )

inline

This function is used to launch kernel function over all the particle regions with region type = ParticleRegionBase.

Template Parameters

LAMBDA type of the user-provided function

Parameters

lambda kernel function

Definition at line 263 of file ParticleManager.hpp.

◆ forParticleRegions() [2/4]

template<typename REGIONTYPE = ParticleRegionBase, typename ... REGIONTYPES, typename LAMBDA >

void geos::ParticleManager::forParticleRegions ( LAMBDA && lambda ) const

inline

This const function is used to launch kernel function over all the particle regions with region type = ParticleRegionBase.

Template Parameters

LAMBDA type of the user-provided function

Parameters

lambda kernel function

Definition at line 275 of file ParticleManager.hpp.

◆ forParticleRegions() [3/4]

template<typename REGIONTYPE = ParticleRegionBase, typename ... REGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >

void geos::ParticleManager::forParticleRegions	(	LOOKUP_CONTAINER const &	targetRegions,
		LAMBDA &&	lambda
	)

inline

This function is used to launch kernel function over the target particle regions with region type = ParticleRegionBase.

Template Parameters

LOOKUP_CONTAINER	type of container of names or indices
LAMBDA	type of the user-provided function

Parameters

targetRegions	target particle region names or indices
lambda	kernel function

Definition at line 289 of file ParticleManager.hpp.

◆ forParticleRegions() [4/4]

template<typename REGIONTYPE = ParticleRegionBase, typename ... REGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >

void geos::ParticleManager::forParticleRegions	(	LOOKUP_CONTAINER const &	targetRegions,
		LAMBDA &&	lambda
	)		const

inline

This const function is used to launch kernel function over the target particle regions with region type = ParticleRegionBase.

Template Parameters

LOOKUP_CONTAINER	type of container of names or indices
LAMBDA	type of the user-provided function

Parameters

targetRegions	target particle region names or indices
lambda	kernel function

Definition at line 303 of file ParticleManager.hpp.

◆ forParticleRegionsComplete() [1/8]

template<typename LAMBDA >

void geos::ParticleManager::forParticleRegionsComplete ( LAMBDA lambda )

inline

This function is used to launch kernel function over all the types of particle regions.

Template Parameters

LAMBDA type of the user-provided function

Parameters

lambda kernel function

Definition at line 325 of file ParticleManager.hpp.

◆ forParticleRegionsComplete() [2/8]

template<typename REGIONTYPE , typename ... REGIONTYPES, typename LAMBDA >

void geos::ParticleManager::forParticleRegionsComplete ( LAMBDA lambda )

inline

This function is used to launch kernel function over all the particle regions that can be casted to one of the specified region types.

Template Parameters

LAMBDA type of the user-provided function

Parameters

lambda kernel function

Definition at line 337 of file ParticleManager.hpp.

◆ forParticleRegionsComplete() [3/8]

template<typename LAMBDA >

void geos::ParticleManager::forParticleRegionsComplete ( LAMBDA lambda ) const

inline

This const function is used to launch kernel function over all the types of particle regions.

Template Parameters

LAMBDA type of the user-provided function

Parameters

lambda kernel function

Definition at line 314 of file ParticleManager.hpp.

◆ forParticleRegionsComplete() [4/8]

template<typename REGIONTYPE , typename ... REGIONTYPES, typename LAMBDA >

void geos::ParticleManager::forParticleRegionsComplete ( LAMBDA lambda ) const

inline

This const function is used to launch kernel function over all the particle regions that can be casted to one of the specified region types.

Template Parameters

LAMBDA type of the user-provided function

Parameters

lambda kernel function

Definition at line 357 of file ParticleManager.hpp.

◆ forParticleRegionsComplete() [5/8]

template<typename LOOKUP_CONTAINER , typename LAMBDA >

void geos::ParticleManager::forParticleRegionsComplete	(	LOOKUP_CONTAINER const &	targetRegions,
		LAMBDA	lambda
	)

inline

This function is used to launch kernel function over the specified target particle regions.

Template Parameters

LOOKUP_CONTAINER	type of container of names or indices
LAMBDA	type of the user-provided function

Parameters

targetRegions	target particle region names or indices
lambda	kernel function

Definition at line 391 of file ParticleManager.hpp.

◆ forParticleRegionsComplete() [6/8]

template<typename REGIONTYPE , typename ... REGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >

void geos::ParticleManager::forParticleRegionsComplete	(	LOOKUP_CONTAINER const &	targetRegions,
		LAMBDA	lambda
	)

inline

This function is used to launch kernel function over the specified target particle regions with region type = specified particle region types.

Template Parameters

LOOKUP_CONTAINER	type of container of names or indices
LAMBDA	type of the user-provided function

Parameters

targetRegions	target particle region names or indices
lambda	kernel function

Definition at line 405 of file ParticleManager.hpp.

◆ forParticleRegionsComplete() [7/8]

template<typename LOOKUP_CONTAINER , typename LAMBDA >

void geos::ParticleManager::forParticleRegionsComplete	(	LOOKUP_CONTAINER const &	targetRegions,
		LAMBDA	lambda
	)		const

inline

This const function is used to launch kernel function over the specified target particle regions.

Template Parameters

LOOKUP_CONTAINER	type of container of names or indices
LAMBDA	type of the user-provided function

Parameters

targetRegions	target particle region names or indices
lambda	kernel function

Definition at line 378 of file ParticleManager.hpp.

◆ forParticleRegionsComplete() [8/8]

template<typename REGIONTYPE , typename ... REGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >

void geos::ParticleManager::forParticleRegionsComplete	(	LOOKUP_CONTAINER const &	targetRegions,
		LAMBDA	lambda
	)		const

inline

This const function is used to launch kernel function over the specified target particle regions with region type = specified particle region types.

Template Parameters

LOOKUP_CONTAINER	type of container of names or indices
LAMBDA	type of the user-provided function

Parameters

targetRegions	target particle region names or indices
lambda	kernel function

Definition at line 423 of file ParticleManager.hpp.

◆ forParticleSubRegions() [1/8]

template<typename LAMBDA >

void geos::ParticleManager::forParticleSubRegions ( LAMBDA && lambda )

inline

This function is used to launch kernel function over the particle subregions of all the subregion types.

Template Parameters

LAMBDA type of the user-provided function

Parameters

lambda kernel function

Definition at line 438 of file ParticleManager.hpp.

◆ forParticleSubRegions() [2/8]

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LAMBDA >

void geos::ParticleManager::forParticleSubRegions ( LAMBDA && lambda )

inline

This function is used to launch kernel function over the particle subregions of the specified subregion types.

Template Parameters

LAMBDA type of the user-provided function

Parameters

lambda kernel function

Definition at line 488 of file ParticleManager.hpp.

◆ forParticleSubRegions() [3/8]

template<typename LAMBDA >

void geos::ParticleManager::forParticleSubRegions ( LAMBDA && lambda ) const

inline

This const function is used to launch kernel function over the particle subregions of all the subregion types.

Template Parameters

LAMBDA type of the user-provided function

Parameters

lambda kernel function

Definition at line 450 of file ParticleManager.hpp.

◆ forParticleSubRegions() [4/8]

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LAMBDA >

void geos::ParticleManager::forParticleSubRegions ( LAMBDA && lambda ) const

inline

This const function is used to launch kernel function over the particle subregions of the specified subregion types.

Template Parameters

LAMBDA type of the user-provided function

Parameters

lambda kernel function

Definition at line 508 of file ParticleManager.hpp.

◆ forParticleSubRegions() [5/8]

template<typename LOOKUP_CONTAINER , typename LAMBDA >

void geos::ParticleManager::forParticleSubRegions	(	LOOKUP_CONTAINER const &	targetRegions,
		LAMBDA &&	lambda
	)

inline

This function is used to launch kernel function over the specified target particle subregions.

Template Parameters

LOOKUP_CONTAINER	type of container of names or indices
LAMBDA	type of the user-provided function

Parameters

targetRegions	target particle region names or indices
lambda	kernel function

Definition at line 463 of file ParticleManager.hpp.

◆ forParticleSubRegions() [6/8]

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >

void geos::ParticleManager::forParticleSubRegions	(	LOOKUP_CONTAINER const &	targetRegions,
		LAMBDA &&	lambda
	)

inline

This function is used to launch kernel function over the specified target particle subregions with the specified subregion types.

Template Parameters

LOOKUP_CONTAINER	type of container of names or indices
LAMBDA	type of the user-provided function

Parameters

targetRegions	target particle region names or indices
lambda	kernel function

Definition at line 529 of file ParticleManager.hpp.

◆ forParticleSubRegions() [7/8]

template<typename LOOKUP_CONTAINER , typename LAMBDA >

void geos::ParticleManager::forParticleSubRegions	(	LOOKUP_CONTAINER const &	targetRegions,
		LAMBDA &&	lambda
	)		const

inline

This const function is used to launch kernel function over the specified target particle subregions.

Template Parameters

LOOKUP_CONTAINER	type of container of names or indices
LAMBDA	type of the user-provided function

Parameters

targetRegions	target particle region names or indices
lambda	kernel function

Definition at line 476 of file ParticleManager.hpp.

◆ forParticleSubRegions() [8/8]

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >

void geos::ParticleManager::forParticleSubRegions	(	LOOKUP_CONTAINER const &	targetRegions,
		LAMBDA &&	lambda
	)		const

inline

This const function is used to launch kernel function over the specified target particle subregions with the specified subregion types.

Template Parameters

LOOKUP_CONTAINER	type of container of names or indices
LAMBDA	type of the user-provided function

Parameters

targetRegions	target particle region names or indices
lambda	kernel function

Definition at line 551 of file ParticleManager.hpp.

◆ forParticleSubRegionsComplete() [1/8]

template<typename LAMBDA >

void geos::ParticleManager::forParticleSubRegionsComplete ( LAMBDA && lambda )

inline

This function is used to launch kernel function over the particle subregions of all subregion types.

Template Parameters

LAMBDA type of the user-provided function

Parameters

lambda kernel function

Definition at line 581 of file ParticleManager.hpp.

◆ forParticleSubRegionsComplete() [2/8]

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LAMBDA >

void geos::ParticleManager::forParticleSubRegionsComplete ( LAMBDA && lambda )

inline

This function is used to launch kernel function over all the particle subregions that can be casted to one of the specified subregion types.

Template Parameters

LAMBDA type of the user-provided function

Parameters

lambda kernel function

Definition at line 619 of file ParticleManager.hpp.

◆ forParticleSubRegionsComplete() [3/8]

template<typename LAMBDA >

void geos::ParticleManager::forParticleSubRegionsComplete ( LAMBDA && lambda ) const

inline

This const function is used to launch kernel function over the particle subregions of all subregion types.

Template Parameters

LAMBDA type of the user-provided function

Parameters

lambda kernel function

Definition at line 570 of file ParticleManager.hpp.

◆ forParticleSubRegionsComplete() [4/8]

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LAMBDA >

void geos::ParticleManager::forParticleSubRegionsComplete ( LAMBDA && lambda ) const

inline

This const function is used to launch kernel function over all the particle subregions that can be casted to one of the specified subregion types.

Template Parameters

LAMBDA type of the user-provided function

Parameters

lambda kernel function

Definition at line 644 of file ParticleManager.hpp.

◆ forParticleSubRegionsComplete() [5/8]

template<typename LOOKUP_CONTAINER , typename LAMBDA >

void geos::ParticleManager::forParticleSubRegionsComplete	(	LOOKUP_CONTAINER const &	targetRegions,
		LAMBDA &&	lambda
	)

inline

This function is used to launch kernel function over the specified target particle subregions.

Template Parameters

LOOKUP_CONTAINER	type of container of names or indices
LAMBDA	type of the user-provided function

Parameters

targetRegions	target particle region names or indices
lambda	kernel function

Definition at line 594 of file ParticleManager.hpp.

◆ forParticleSubRegionsComplete() [6/8]

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >

void geos::ParticleManager::forParticleSubRegionsComplete	(	LOOKUP_CONTAINER const &	targetRegions,
		LAMBDA &&	lambda
	)

inline

This function is used to launch kernel function over the specified target particle subregions that can be casted to one of the specified subregion types.

Template Parameters

LOOKUP_CONTAINER	type of container of names or indices
LAMBDA	type of the user-provided function

Parameters

targetRegions	target particle region names or indices
lambda	kernel function

Definition at line 671 of file ParticleManager.hpp.

◆ forParticleSubRegionsComplete() [7/8]

template<typename LOOKUP_CONTAINER , typename LAMBDA >

void geos::ParticleManager::forParticleSubRegionsComplete	(	LOOKUP_CONTAINER const &	targetRegions,
		LAMBDA &&	lambda
	)		const

inline

This const function is used to launch kernel function over the specified target particle subregions.

Template Parameters

LOOKUP_CONTAINER	type of container of names or indices
LAMBDA	type of the user-provided function

Parameters

targetRegions	target particle region names or indices
lambda	kernel function

Definition at line 607 of file ParticleManager.hpp.

◆ forParticleSubRegionsComplete() [8/8]

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >

void geos::ParticleManager::forParticleSubRegionsComplete	(	LOOKUP_CONTAINER const &	targetRegions,
		LAMBDA &&	lambda
	)		const

inline

This const function is used to launch kernel function over the specified target particle subregions that can be casted to one of the specified subregion types.

Template Parameters

LOOKUP_CONTAINER	type of container of names or indices
LAMBDA	type of the user-provided function

Parameters

targetRegions	target particle region names or indices
lambda	kernel function

Definition at line 701 of file ParticleManager.hpp.

◆ generateMesh()

void geos::ParticleManager::generateMesh ( ParticleBlockManagerABC & particleBlockManager )

Generate the mesh.

Parameters

[in] particleBlockManager pointer to the ParticleBlockManager

◆ getCatalogName()

virtual string geos::ParticleManager::getCatalogName ( ) const

inlinefinaloverridevirtual

Virtual access to catalogName()

Returns: string that contains the catalog name used to register/lookup this class in the object catalog

Implements geos::ObjectManagerBase.

Definition at line 110 of file ParticleManager.hpp.

◆ getNumberOfParticles()

template<typename T = ParticleSubRegionBase>

localIndex geos::ParticleManager::getNumberOfParticles ( ) const

inline

Get the number of particles in all ParticleSubRegions of type T.

Returns: number of particles

Definition at line 130 of file ParticleManager.hpp.

◆ getRegion() [1/2]

template<typename T = ParticleRegionBase, typename KEY_TYPE = void>

T& geos::ParticleManager::getRegion ( KEY_TYPE const & key )

inline

Get a particle region.

Parameters

key	The key of the particle region, either name or number.

Returns: Reference to T.

Definition at line 224 of file ParticleManager.hpp.

◆ getRegion() [2/2]

template<typename T = ParticleRegionBase, typename KEY_TYPE = void>

const T& geos::ParticleManager::getRegion ( KEY_TYPE const & key ) const

inline

Get a particle region.

Parameters

key	The key of particle region, either name or number.

Returns: Reference to const T.

Definition at line 213 of file ParticleManager.hpp.

◆ getRegions() [1/2]

subGroupMap& geos::ParticleManager::getRegions ( )

inline

Get a collection of particle regions.

Returns: reference to mutable subGroupMap

Definition at line 202 of file ParticleManager.hpp.

◆ getRegions() [2/2]

const subGroupMap& geos::ParticleManager::getRegions ( ) const

inline

Get a collection of particle regions.

Returns: reference to immutable subGroupMap

Definition at line 193 of file ParticleManager.hpp.

◆ hasRegion()

template<typename T = ParticleRegionBase>

bool geos::ParticleManager::hasRegion ( string const & name ) const

inline

Determines if a ParticleRegion with the input name exists.

Template Parameters

T	The type of ParticleRegion. May be a specific derived type of ParticleRegionBase.

Parameters

name	The name/key of the ParticleRegion

Returns: true if the region exists, false if not.

Definition at line 236 of file ParticleManager.hpp.

◆ numParticleBlocks()

localIndex geos::ParticleManager::numParticleBlocks ( ) const

Get the number of particle blocks.

Returns: number of particle blocks

◆ numRegions()

localIndex geos::ParticleManager::numRegions ( ) const

inline

Get the number of regions.

Returns: number of regions

Definition at line 245 of file ParticleManager.hpp.

◆ pack() [1/3]

localIndex geos::dataRepository::Group::pack

Pack a list of indices for all registered wrappers.

Parameters

[in,out]	buffer	the buffer that will be packed.
[in]	packList	the list of indices to pack
[in]	recursive	whether or not to perform a recursive pack.
[in]	onDevice	whether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]	events	a collection of events to poll for completion of async packing kernels ( device packing is incomplete until all events are finalized )

Returns: the size of data packed to the buffer.

This function takes in a reference to a pointer buffer, and packs data specified by wrapperNames, packList, and recursive to that pointer location. The pointer is altered and returned to the new location corresponding the original value of buffer plus the size of data packed to the buffer.

◆ pack() [2/3]

virtual localIndex geos::dataRepository::Group::pack

Pack a list of indices within a list of wrappers.

Parameters

[in,out]	buffer	the buffer that will be packed.
[in]	wrapperNames	an array that contains the names of the wrappers to pack.
[in]	packList	the list of indices to pack
[in]	recursive	whether or not to perform a recursive pack.
[in]	onDevice	whether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]	events	a collection of events to poll for completion of async packing kernels ( device packing is incomplete until all events are finalized )

Returns: the size of data packed to the buffer.

This function takes in a reference to a pointer buffer, and packs data specified by wrapperNames, packList, and recursive to that pointer location. The pointer is altered and returned to the new location corresponding the original value of buffer plus the size of data packed to the buffer.

◆ pack() [3/3]

virtual localIndex geos::dataRepository::Group::pack

Pack a list of wrappers to a buffer.

Parameters

[in,out]	buffer	the buffer that will be packed.
[in]	wrapperNames	an array that contains the names of the wrappers to pack.
[in]	recursive	whether or not to perform a recursive pack.
[in]	onDevice	whether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]	events	a collection of events to poll for completion of async packing kernels ( device packing is incomplete until all events are finalized )

Returns: the size of data packed to the buffer.

This function takes in a reference to a pointer buffer, and packs data specified by wrapperNames, and recursive to that pointer location. The pointer is altered and returned to the new location corresponding the original value of buffer plus the size of data packed to the buffer.

◆ Pack()

int geos::ParticleManager::Pack	(	buffer_unit_type *&	buffer,
		string_array const &	wrapperNames,
		ParticleViewAccessor< arrayView1d< localIndex > > const &	packList
	)		const

Pack a list of wrappers to a buffer.

Parameters

buffer	pointer to the buffer to be packed
wrapperNames	list of wrapper names
packList	list of indices to pack

Returns: the size of data packed to the buffer

◆ packGlobalMaps()

virtual localIndex geos::ObjectManagerBase::packGlobalMaps

Packs the global maps elements in the @ packList.

Parameters

buffer	The buffer that will receive the packed data.
packList	The element we want packed.
recursive	Boolean like integer for sub-groups packing.

Returns: The packed size.

◆ PackGlobalMaps()

int geos::ParticleManager::PackGlobalMaps	(	buffer_unit_type *&	buffer,
		ParticleViewAccessor< arrayView1d< localIndex > > const &	packList
	)		const

Pack a buffer.

Parameters

buffer	pointer to the buffer to be packed
packList	list of indices to pack

Returns: the size of the data packed

◆ packGlobalMapsSize()

virtual localIndex geos::ObjectManagerBase::packGlobalMapsSize

Computes the pack size of the global maps elements in the @ packList.

Parameters

packList	The element we want packed.
recursive	Boolean like integer for sub-groups packing.

Returns: The packed size.

◆ PackGlobalMapsSize()

int geos::ParticleManager::PackGlobalMapsSize ( ParticleViewAccessor< arrayView1d< localIndex > > const & packList ) const

Get the size of the buffer to be packed.

Parameters

packList list of indices to pack

Returns: the size of the data packed

◆ packSize() [1/3]

localIndex geos::dataRepository::Group::packSize

Get the size required to pack a list of indices for all registered wrappers.

Parameters

[in]	packList	the list of indices to pack
[in]	recursive	whether or not to perform a recursive pack.
[in]	onDevice	whether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]	events	a collection of events to poll for completion of async packing kernels ( device packing is incomplete until all events are finalized )

Returns: the size of the buffer required to pack the wrapper indices.

◆ packSize() [2/3]

virtual localIndex geos::dataRepository::Group::packSize

Get the size required to pack a list of indices within a list of wrappers.

Parameters

[in]	wrapperNames	an array that contains the names of the wrappers to pack.
[in]	packList	the list of indices to pack
[in]	recursive	whether or not to perform a recursive pack.
[in]	onDevice	whether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]	events	a collection of events to poll for completion of async packing kernels ( device packing is incomplete until all events are finalized )

Returns: the size of the buffer required to pack the wrapper indices.

◆ packSize() [3/3]

virtual localIndex geos::dataRepository::Group::packSize

Get the size required to pack a list of wrappers.

Parameters

[in]	wrapperNames	an array that contains the names of the wrappers to pack.
[in]	recursive	whether or not to perform a recursive pack.
[in]	onDevice	whether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]	events	a collection of events to poll for completion of async packing kernels ( device packing is incomplete until all events are finalized )

Returns: the size of the buffer required to pack the wrappers.

◆ PackSize()

int geos::ParticleManager::PackSize	(	string_array const &	wrapperNames,
		ParticleViewAccessor< arrayView1d< localIndex > > const &	packList
	)		const

Get the buffer size needed to pack a list of wrappers.

Parameters

wrapperNames	list of wrapper names
packList	list of indices to pack

Returns: the size of the buffer required to pack the wrappers

◆ resize() [1/2]

void geos::ParticleManager::resize	(	integer_array const &	numParticles,
		string_array const &	regionNames,
		string_array const &	particleTypes
	)

Set the number of particles for a set of particle regions.

Parameters

numParticles	list of the new particle numbers
regionNames	list of the particle region names
particleTypes	list of the particle types

◆ resize() [2/2]

virtual void geos::dataRepository::Group::resize

Resize the group and all contained wrappers that resize with parent.

Parameters

newSize the new size of the group

◆ setSchemaDeviations()

virtual void geos::ParticleManager::setSchemaDeviations	(	xmlWrapper::xmlNode	schemaRoot,
		xmlWrapper::xmlNode	schemaParent,
		integer	documentationType
	)

overridevirtual

Inform the schema generator of any deviations between the xml and GEOS data structures.

Parameters

schemaRoot	XML node corresponding to the root
schemaParent	XML node for the parent node
documentationType	type of XML schema generated

Reimplemented from geos::dataRepository::Group.

◆ unpack()

virtual localIndex geos::ObjectManagerBase::unpack

override

Unpack a buffer.

Parameters

[in,out]	buffer	the buffer to unpack
[in,out]	packList	the list of indices that will be unpacked.
[in]	recursive	whether or not to perform a recursive unpack.
[in]	onDevice	whether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]	events	a collection of events to poll for completion of async packing kernels ( device packing is incomplete until all events are finalized )
[in]	op	the operation to perform while unpacking

Returns: the number of bytes unpacked.

This function takes a reference to a pointer to const buffer type, and unpacks data from that buffer into the current Group. If packList is non-empty, then a check is made to ensure that the data that is unpacked matches packList. If packList is empty, the values of the indices that are unpacked are stored and returned in packList.

◆ Unpack() [1/2]

int geos::ParticleManager::Unpack	(	buffer_unit_type const *&	buffer,
		ParticleReferenceAccessor< array1d< localIndex > > &	packList
	)

Unpack a buffer.

Parameters

buffer	pointer to the buffer to be unpacked
packList	list of indices to unpack

Returns: the size of data unpacked.

◆ Unpack() [2/2]

int geos::ParticleManager::Unpack	(	buffer_unit_type const *&	buffer,
		ParticleViewAccessor< arrayView1d< localIndex > > &	packList
	)

Unpack a buffer.

Parameters

buffer	pointer to the buffer to be unpacked
packList	list of indices to unpack

Returns: the size of data unpacked

◆ unpackGlobalMaps()

virtual localIndex geos::ObjectManagerBase::unpackGlobalMaps

Unpacks the global maps from buffer.

Parameters

buffer	The buffer containing the packed data.
packList	The (un)packed element.
recursive	Boolean like integer for sub-groups unpacking.

Returns: The unpacked size.

◆ UnpackGlobalMaps()

int geos::ParticleManager::UnpackGlobalMaps	(	buffer_unit_type const *&	buffer,
		ParticleViewAccessor< ReferenceWrapper< localIndex_array > > &	packList
	)

Unpack a buffer.

Parameters

buffer	pointer to the buffer to be unpacked
packList	list of indices to pack

Returns: the size of the data unpacked

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

coreComponents/mesh/ParticleManager.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConstitutiveRelationAccessor

◆ MaterialViewAccessor

◆ ParticleReferenceAccessor

◆ ParticleView

◆ ParticleViewAccessor

◆ ParticleViewConst

Constructor & Destructor Documentation

◆ ParticleManager()

Member Function Documentation

◆ catalogName()

◆ constructArrayViewAccessor()

◆ constructFieldAccessor()

◆ constructFullConstitutiveAccessor() [1/2]

◆ constructFullConstitutiveAccessor() [2/2]

◆ constructFullMaterialViewAccessor() [1/2]

◆ constructFullMaterialViewAccessor() [2/2]

◆ constructMaterialArrayViewAccessor() [1/2]

◆ constructMaterialArrayViewAccessor() [2/2]

◆ constructMaterialFieldAccessor() [1/2]

◆ constructMaterialFieldAccessor() [2/2]

◆ constructMaterialViewAccessor() [1/3]

◆ constructMaterialViewAccessor() [2/3]

◆ constructMaterialViewAccessor() [3/3]

◆ constructReferenceAccessor() [1/2]

◆ constructReferenceAccessor() [2/2]

◆ constructViewAccessor() [1/2]

◆ constructViewAccessor() [2/2]

◆ createChild()

◆ forParticleRegions() [1/4]

◆ forParticleRegions() [2/4]

◆ forParticleRegions() [3/4]

◆ forParticleRegions() [4/4]

◆ forParticleRegionsComplete() [1/8]

◆ forParticleRegionsComplete() [2/8]

◆ forParticleRegionsComplete() [3/8]

◆ forParticleRegionsComplete() [4/8]

◆ forParticleRegionsComplete() [5/8]

◆ forParticleRegionsComplete() [6/8]

◆ forParticleRegionsComplete() [7/8]

◆ forParticleRegionsComplete() [8/8]

◆ forParticleSubRegions() [1/8]

◆ forParticleSubRegions() [2/8]

◆ forParticleSubRegions() [3/8]

◆ forParticleSubRegions() [4/8]

◆ forParticleSubRegions() [5/8]

◆ forParticleSubRegions() [6/8]

◆ forParticleSubRegions() [7/8]

◆ forParticleSubRegions() [8/8]

◆ forParticleSubRegionsComplete() [1/8]

◆ forParticleSubRegionsComplete() [2/8]

◆ forParticleSubRegionsComplete() [3/8]

◆ forParticleSubRegionsComplete() [4/8]

◆ forParticleSubRegionsComplete() [5/8]

◆ forParticleSubRegionsComplete() [6/8]

◆ forParticleSubRegionsComplete() [7/8]

◆ forParticleSubRegionsComplete() [8/8]

◆ generateMesh()

◆ getCatalogName()

◆ getNumberOfParticles()

◆ getRegion() [1/2]

◆ getRegion() [2/2]

◆ getRegions() [1/2]

◆ getRegions() [2/2]

◆ hasRegion()

◆ numParticleBlocks()

◆ numRegions()

◆ pack() [1/3]

◆ pack() [2/3]

◆ pack() [3/3]

◆ Pack()

◆ packGlobalMaps()

◆ PackGlobalMaps()

◆ packGlobalMapsSize()