#include <ParticleSubRegion.hpp>
Inheritance diagram for geos::ParticleSubRegion:
Classes | |
| struct | viewKeyStruct |
| struct to serve as a container for variable strings and keys More... | |
Public Member Functions | |
| virtual string | getCatalogName () const override final |
| Const getter for the catalog name. More... | |
| virtual viewKeyStruct & | viewKeys () override |
| Get the view keys for Group access. More... | |
| virtual viewKeyStruct const & | viewKeys () const override |
| Get the view keys for Group access, const version. More... | |
Constructor / Destructor | |
| ParticleSubRegion (string const &name, Group *const parent) | |
| Constructor for this class. More... | |
| virtual | ~ParticleSubRegion () override |
| Destructor. | |
Helpers for ParticleSubRegion construction | |
| void | setParticleRank (int const rank) |
| Set the ghost rank of particles in this subregion. More... | |
| void | copyFromParticleBlock (ParticleBlockABC &particleBlock) |
| Fill the ParticleSubRegion by copying those of the source ParticleBlock. More... | |
Miscellaneous | |
| template<typename LAMBDA > | |
| void | forMaterials (LAMBDA lambda) |
| Helper function to apply a lambda function over all constructive groups. More... | |
 Public Member Functions inherited from geos::ParticleSubRegionBase | |
| unsigned int | particlePack (buffer_type &buffer, arrayView1d< localIndex > const &localIndices, bool doPack) const |
| Packs the data of particles on this subregion. More... | |
| void | particleUnpack (buffer_type &buffer, int const &startingIndex, int const &numberOfIncomingParticles) |
| Unpacks the data of particles on this subregion. More... | |
| void | erase (std::set< localIndex > const &indicesToErase) |
| Erases particle field data at the provided local indices. More... | |
| void | setActiveParticleIndices () |
| Identifies the local indices of non-ghost particles. | |
| SortedArrayView< localIndex const > const | activeParticleIndices () const |
| Returns the local indices of all non-ghost particles. More... | |
| void | updateMaps () |
| Updates the globalToLocal and localToGlobal maps. | |
| ParticleSubRegionBase (string const &name, dataRepository::Group *const parent) | |
| Constructor for this class. More... | |
| ~ParticleSubRegionBase () | |
| Destructor. | |
| bool | hasRVectors () const |
| Get whether particle has r-vectors. More... | |
| void | setHasRVectors (bool hasRVectors) |
| Set whether particle has r-vectors. More... | |
| arrayView1d< globalIndex const > | getParticleID () const |
| Get the global ID of each particle in this subregion. More... | |
| arrayView1d< globalIndex > | getParticleID () |
| Get the global ID of each particle in this subregion. More... | |
| arrayView1d< int const > | getParticleGroup () const |
| Get the contact group of each particle in this subregion. More... | |
| arrayView1d< int > | getParticleGroup () |
| Get the contact group of each particle in this subregion. More... | |
| arrayView1d< int const > | getParticleSurfaceFlag () const |
| Get the contact group of each particle in this subregion. More... | |
| arrayView1d< int > | getParticleSurfaceFlag () |
| Get the contact group of each particle in this subregion. More... | |
| arrayView1d< real64 const > | getParticleDamage () const |
| Get the damage of each particle in this subregion. More... | |
| arrayView1d< real64 > | getParticleDamage () |
| Get the damage of each particle in this subregion. More... | |
| arrayView1d< real64 const > | getParticleStrengthScale () const |
| Get the strength scale of each particle in this subregion. More... | |
| arrayView1d< real64 > | getParticleStrengthScale () |
| Get the strength scale of each particle in this subregion. More... | |
| arrayView1d< int const > | getParticleRank () const |
| Get the ghost rank of each particle in this subregion. More... | |
| arrayView1d< int > | getParticleRank () |
| Get the ghost rank of each particle in this subregion. More... | |
| arrayView2d< real64 const > | getParticleCenter () const |
| Get the center of each particle in this subregion. More... | |
| arrayView2d< real64 > | getParticleCenter () |
| Get the center of each particle in this subregion. More... | |
| void | setParticleCenter (array2d< real64 > particleCenter) |
| Set the center of each particle in this subregion. More... | |
| arrayView2d< real64 const > | getParticleVelocity () const |
| Get the velocity of each particle in this subregion. More... | |
| arrayView2d< real64 > | getParticleVelocity () |
| Get the velocity of each particle in this subregion. More... | |
| arrayView2d< real64 const > | getParticleMaterialDirection () const |
| Get the material direction of each particle in this subregion. More... | |
| arrayView2d< real64 > | getParticleMaterialDirection () |
| Get the material direction of each particle in this subregion. More... | |
| arrayView1d< real64 const > | getParticleVolume () const |
| Get the current volume of each particle in this subregion. More... | |
| arrayView1d< real64 > | getParticleVolume () |
| Get the current volume of each particle in this subregion. More... | |
| arrayView3d< real64 const > | getParticleRVectors () const |
| Get the r-vectors of each particle in this subregion. More... | |
| arrayView3d< real64 > | getParticleRVectors () |
| Get the r-vectors of each particle in this subregion. More... | |
| dataRepository::Group const & | getConstitutiveModels () const |
| Get the group in which the constitutive models of this subregion are registered. More... | |
| dataRepository::Group & | getConstitutiveModels () |
| Get the group in which the constitutive models of this subregion are registered. More... | |
| template<typename T = constitutive::ConstitutiveBase> | |
| T const & | getConstitutiveModel (string const &name) const |
| Get a pointer to the constitutive model. More... | |
| template<typename T = constitutive::ConstitutiveBase> | |
| T & | getConstitutiveModel (string const &name) |
| Get a pointer to the constitutive model. More... | |
| ParticleType | getParticleType () const |
| Get the type of particle in this subregion. More... | |
| virtual void | setParticleType (ParticleType const particleType) |
| Set the type of particle in this subregion. More... | |
| int | numberOfVerticesPerParticle () const |
| Get the number of vertices for particles in this subregion. More... | |
| virtual void | setNumberOfVerticesPerParticle (ParticleType const particleType) |
| Set the number of vertices for particles in this subregion. More... | |
| OrderedVariableToManyParticleRelation const & | neighborList () const |
| Provide an immutable accessor to the particle neighbor list. More... | |
| OrderedVariableToManyParticleRelation & | neighborList () |
| Get a mutable accessor to the particle neighbor list. 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 | setMaxGlobalIndex () |
| Computes the maximum global index allong all the MPI ranks. | |
| 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 groupKeyStruct & | groupKeys () |
| Get the group keys for Group access. More... | |
| virtual groupKeyStruct const & | groupKeys () const |
| Get the group keys for Group access, const version. More... | |
| Group & | sets () |
| Get the group holding the object sets. More... | |
| Group const & | 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... | |
| unordered_map< globalIndex, localIndex > const & | globalToLocalMap () const |
| Get global to local map. More... | |
| localIndex | globalToLocalMap (globalIndex const gid) const |
| Retrieves the local index for given global index. More... | |
| array1d< integer > const & | isExternal () |
| Get the locality information of the objects. More... | |
| arrayView1d< integer const > | isExternal () const |
| Get the locality information of the objects. More... | |
| array1d< integer > const & | 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... | |
| NeighborData const & | 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 | |
| template<typename LOG_LEVEL_INFO > | |
| std::enable_if_t< geos::is_log_level_info< LOG_LEVEL_INFO >, void > | addLogLevel () |
| Append a levelCondition and a log description to the description of the wrapped object given a log info struct. Must be called in constructor. More... | |
| 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... | |
| virtual Group * | createChild (string const &childKey, string const &childName) |
| Creates a new sub-Group using the ObjectCatalog functionality. 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> | |
| T const * | 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> | |
| T const & | 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> | |
| T const & | getGroupByPath (string const &path) const |
| Retrieve a group from the hierarchy using a path. More... | |
| subGroupMap & | getSubGroups () |
| Get the subgroups object. More... | |
| subGroupMap const & | getSubGroups () const |
| Get the subgroups object. More... | |
| localIndex | numSubGroups () const |
| return the number of sub groups in this Group More... | |
| 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 | postInputInitializationRecursive () |
| Recursively call postInputInitialization() 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 | expandObjectCatalogs () |
| Expand any catalogs in the data structure. | |
| virtual void | setSchemaDeviations (xmlWrapper::xmlNode schemaRoot, xmlWrapper::xmlNode schemaParent, integer documentationType) |
| Inform the schema generator of any deviations between the xml and GEOS data structures. More... | |
| virtual void | 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 > | |
| WrapperBase const & | 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 |
| wrapperMap const & | 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 > | |
| Wrapper< T > const & | getWrapper (LOOKUP_TYPE const &index) const |
| Retrieve a Wrapper stored in this group. More... | |
| template<typename T , typename LOOKUP_TYPE > | |
| Wrapper< T > & | getWrapper (LOOKUP_TYPE const &index) |
| Retrieve a Wrapper stored in this group. More... | |
| template<typename T , typename LOOKUP_TYPE > | |
| Wrapper< T > const * | 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... | |
| string const & | 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... | |
| DataContext const & | getDataContext () const |
| template<typename KEY > | |
| DataContext const & | getWrapperDataContext (KEY key) const |
| Group & | getParent () |
| Access the group's parent. More... | |
| Group const & | 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... | |
| conduit::Node const & | 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 () |
| void | setLogLevel (integer const logLevel) |
| Set verbosity level. More... | |
| integer | getLogLevel () const |
Static Public Member Functions | |
| static string | catalogName () |
| Const getter for the catalog name. 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 Group. More... | |
Public Attributes | |
| geos::ParticleSubRegion::viewKeyStruct | m_ParticleBlockSubRegionViewKeys |
| viewKey struct for the ParticleSubRegion class | |
| 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 | |
Additional Inherited Members | |
| 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. | |
| Protected Member Functions inherited from geos::dataRepository::Group | |
| virtual void | postInputInitialization () |
| 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::ParticleSubRegionBase | |
| bool | m_hasRVectors |
| Boolean indicating whether the particle subregion contains particles needing r-vectors defining their domain extent. | |
| int | m_numVerticesPerParticle |
| The number of vertices each particle has. | |
| array1d< int > | m_particleRank |
| Member level field for particle ghost ranks. | |
| array1d< globalIndex > | m_particleID |
| Member level field for the particle global ID. | |
| array1d< int > | m_particleGroup |
| Member level field for the particle contact group. | |
| array1d< int > | m_particleSurfaceFlag |
| Member level field for the particle surface flag. | |
| array1d< real64 > | m_particleDamage |
| Member level field for the particle damage. | |
| array1d< real64 > | m_particleStrengthScale |
| Member level field for the particle strength scale. | |
| array2d< real64 > | m_particleCenter |
| Member level field for the particle center. | |
| array2d< real64 > | m_particleVelocity |
| Member level field for the particle velocity. | |
| array2d< real64 > | m_particleMaterialDirection |
| Member level field for the particle material direction. | |
| array1d< real64 > | m_particleVolume |
| Member level field for the current particle volume. | |
| ParticleType | m_particleType |
| Type of particles in this subregion. | |
| array3d< real64 > | m_particleRVectors |
| current half-R-vectors (center to face) | |
| SortedArray< localIndex > | m_activeParticleIndices |
| Indices of particles that are not ghosts. | |
| OrderedVariableToManyParticleRelation | m_neighborList |
| Neighbor list. | |
| 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
Class specializing the particle subregion for a cell particle. This is the class used in the physics solvers to represent a collection of mesh cell particles
Definition at line 35 of file ParticleSubRegion.hpp.
Constructor & Destructor Documentation
◆ ParticleSubRegion()
Constructor for this class.
- Parameters
-
[in] name the name of this object manager [in] parent the parent Group
Member Function Documentation
◆ catalogName()
|
inlinestatic |
Const getter for the catalog name.
- Returns
- the name of this type in the catalog
Definition at line 43 of file ParticleSubRegion.hpp.
◆ copyFromParticleBlock()
| void geos::ParticleSubRegion::copyFromParticleBlock | ( | ParticleBlockABC & | particleBlock | ) |
Fill the ParticleSubRegion by copying those of the source ParticleBlock.
- Parameters
-
particleBlock the ParticleBlock which properties (connectivity info) will be copied.
◆ forMaterials()
template<typename LAMBDA >
|
inline |
Helper function to apply a lambda function over all constructive groups.
- Template Parameters
-
LAMBDA the type of the lambda function
- Parameters
-
lambda the lambda function
Definition at line 101 of file ParticleSubRegion.hpp.
◆ getCatalogName()
|
inlinefinaloverridevirtual |
Const getter for the catalog name.
- Returns
- the name of this type in the catalog
Implements geos::ObjectManagerBase.
Definition at line 49 of file ParticleSubRegion.hpp.
◆ setParticleRank()
| void geos::ParticleSubRegion::setParticleRank | ( | int const | rank | ) |
Set the ghost rank of particles in this subregion.
- Parameters
-
rank the mpi rank to which all particles in this subregion (in this partition) will have their ghost rank set to
◆ viewKeys() [1/2]
|
inlineoverridevirtual |
Get the view keys for Group access, const version.
- Returns
- The keys.
Reimplemented from geos::ObjectManagerBase.
Definition at line 131 of file ParticleSubRegion.hpp.
◆ viewKeys() [2/2]
|
inlineoverridevirtual |
Get the view keys for Group access.
- Returns
- The keys.
Reimplemented from geos::ObjectManagerBase.
Definition at line 130 of file ParticleSubRegion.hpp.
The documentation for this class was generated from the following file:
- coreComponents/mesh/ParticleSubRegion.hpp
