#include <ParticleBlock.hpp>

Inheritance diagram for geos::ParticleBlock:

Public Member Functions
Constructor / Destructor
	ParticleBlock ()=delete

	ParticleBlock (string const &name, Group *const parent)
	Constructor for this class. More...

	ParticleBlock (const ParticleBlock &init)=delete
	Copy constructor. More...

	~ParticleBlock ()
	Default destructor.

Getters / Setters
void	setParticleType (ParticleType particleType)
	Defines the underlying particle type (hex, tet...) More...

ParticleType	getParticleType () const override
	Get the type of particle in this subregion. More...

array1d< globalIndex >	getParticleID () const override
	Get the list of particle global IDs in this subregion. More...

void	setParticleID (array1d< globalIndex > const particleID)
	Sets the global IDs of particles in this subregion. More...

array2d< real64 >	getParticleCenter () const override
	Get the list of particle center locations in this subregion. More...

void	setParticleCenter (array2d< real64 > const particleCenter)
	Set the list of particle center locations in this subregion. More...

array2d< real64 >	getParticleVelocity () const override
	Get the list of particle velocities in this subregion. More...

void	setParticleVelocity (array2d< real64 > const particleVelocity)
	Set the list of particle velocities in this subregion. More...

array2d< real64 >	getParticleMaterialDirection () const override
	Get the list of particle material directions in this subregion. More...

void	setParticleMaterialDirection (array2d< real64 > const particleMaterialDirection)
	Set the list of material directions in this subregion. More...

array1d< int >	getParticleGroup () const override
	Get the list of particle group numbers (for contact) in this subregion. More...

void	setParticleGroup (array1d< int > const particleGroup)
	Set the list of particle group numbers (for contact) in this subregion. More...

array1d< int >	getParticleSurfaceFlag () const override
	Get the list of particle surface flag values in this subregion. More...

void	setParticleSurfaceFlag (array1d< int > const particleSurfaceFlag)
	Set the list of particle surface flags in this subregion. More...

array1d< real64 >	getParticleDamage () const override
	Get the list of particle damage values in this subregion. More...

void	setParticleDamage (array1d< real64 > const particleDamage)
	Set the list of particle damage values in this subregion. More...

array1d< real64 >	getParticleStrengthScale () const override
	Get the list of particle strength scale values in this subregion. More...

void	setParticleStrengthScale (array1d< real64 > const particleStrengthScale)
	Set the list of particle strength scale values in this subregion. More...

array1d< real64 >	getParticleVolume () const override
	Get the list of particle volumes in this subregion. More...

void	setParticleVolume (array1d< real64 > const particleVolume)
	Set the list of particle volumes in this subregion. More...

array3d< real64 >	getParticleRVectors () const override
	Get the list of particle r-vectors in this subregion. More...

void	setParticleRVectors (array3d< real64 > const particleRVectors)
	Set the list of particle r-vectors in this subregion. More...

bool	hasRVectors () const override
	Query whether this subregion has particles of a type that have r-vectors that depend on the deformation gradient. More...

localIndex	numParticles () const override
	Get the number of particles. More...

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

array1d< globalIndex >	localToGlobalMap () const override
	Get local to global map. More...

void	resize (dataRepository::indexType const numParticles) override final
	Resize the cell block to hold `numParticles`. More...

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

template<typename LAMBDA >
void	forExternalProperties (LAMBDA &&lambda)
	Helper function to apply a lambda function over all the external properties of the subregion. 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...

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

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	unpack (buffer_unit_type const *&buffer, arrayView1d< localIndex > &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events, MPI_Op op=MPI_REPLACE)
	Unpack a buffer. 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	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

Additional Inherited Members
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.

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

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.

Detailed Description

This implementation of ParticleBlockABC mainly use the cell patterns/shapes to build all the particle to nodes, faces and edges mappings.

Definition at line 30 of file ParticleBlock.hpp.

Constructor & Destructor Documentation

◆ ParticleBlock() [1/2]

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

Constructor for this class.

Parameters

[in]	name	the name of this object manager
[in]	parent	the parent Group

◆ ParticleBlock() [2/2]

geos::ParticleBlock::ParticleBlock ( const ParticleBlock & init )

delete

Copy constructor.

Parameters

[in] init the source to copy

Member Function Documentation

◆ getParticleCenter()

array2d< real64 > geos::ParticleBlock::getParticleCenter ( ) const

inlineoverridevirtual

Get the list of particle center locations in this subregion.

Returns: the list of particle center locations in this subregion.

Implements geos::ParticleBlockABC.

Definition at line 93 of file ParticleBlock.hpp.

◆ getParticleDamage()

array1d< real64 > geos::ParticleBlock::getParticleDamage ( ) const

inlineoverridevirtual

Get the list of particle damage values in this subregion.

Returns: the list of particle damage values in this subregion.

Implements geos::ParticleBlockABC.

Definition at line 143 of file ParticleBlock.hpp.

◆ getParticleGroup()

array1d< int > geos::ParticleBlock::getParticleGroup ( ) const

inlineoverridevirtual

Get the list of particle group numbers (for contact) in this subregion.

Returns: the list of particle group numbers (for contact) in this subregion.

Implements geos::ParticleBlockABC.

Definition at line 123 of file ParticleBlock.hpp.

◆ getParticleID()

array1d< globalIndex > geos::ParticleBlock::getParticleID ( ) const

inlineoverridevirtual

Get the list of particle global IDs in this subregion.

Returns: the list of particle global IDs in this subregion.

Implements geos::ParticleBlockABC.

Definition at line 83 of file ParticleBlock.hpp.

◆ getParticleMaterialDirection()

array2d< real64 > geos::ParticleBlock::getParticleMaterialDirection ( ) const

inlineoverridevirtual

Get the list of particle material directions in this subregion.

Returns: the list of particle material directions in this subregion.

Implements geos::ParticleBlockABC.

Definition at line 113 of file ParticleBlock.hpp.

◆ getParticleRVectors()

array3d< real64 > geos::ParticleBlock::getParticleRVectors ( ) const

inlineoverridevirtual

Get the list of particle r-vectors in this subregion.

Returns: the list of particle r-vectors in this subregion.

Implements geos::ParticleBlockABC.

Definition at line 173 of file ParticleBlock.hpp.

◆ getParticleStrengthScale()

array1d< real64 > geos::ParticleBlock::getParticleStrengthScale ( ) const

inlineoverridevirtual

Get the list of particle strength scale values in this subregion.

Returns: the list of particle strength scale values in this subregion.

Implements geos::ParticleBlockABC.

Definition at line 153 of file ParticleBlock.hpp.

◆ getParticleSurfaceFlag()

array1d< int > geos::ParticleBlock::getParticleSurfaceFlag ( ) const

inlineoverridevirtual

Get the list of particle surface flag values in this subregion.

Returns: the list of particle surface flag values in this subregion.

Implements geos::ParticleBlockABC.

Definition at line 133 of file ParticleBlock.hpp.

◆ getParticleType()

ParticleType geos::ParticleBlock::getParticleType ( ) const

inlineoverridevirtual

Get the type of particle in this subregion.

Returns: an enum specifying the type of particle in this subregion

Implements geos::ParticleBlockABC.

Definition at line 80 of file ParticleBlock.hpp.

◆ getParticleVelocity()

array2d< real64 > geos::ParticleBlock::getParticleVelocity ( ) const

inlineoverridevirtual

Get the list of particle velocities in this subregion.

Returns: the list of particle velocities in this subregion.

Implements geos::ParticleBlockABC.

Definition at line 103 of file ParticleBlock.hpp.

◆ getParticleVolume()

array1d< real64 > geos::ParticleBlock::getParticleVolume ( ) const

inlineoverridevirtual

Get the list of particle volumes in this subregion.

Returns: the list of particle volumes in this subregion.

Implements geos::ParticleBlockABC.

Definition at line 163 of file ParticleBlock.hpp.

◆ hasRVectors()

bool geos::ParticleBlock::hasRVectors ( ) const

inlineoverridevirtual

Query whether this subregion has particles of a type that have r-vectors that depend on the deformation gradient.

Returns: a bool indicating whether particles on this subregion have r-vectors that depend on the deformation gradient

Implements geos::ParticleBlockABC.

Definition at line 183 of file ParticleBlock.hpp.

◆ localToGlobalMap() [1/2]

arrayView1d< globalIndex > geos::ParticleBlock::localToGlobalMap ( )

inline

Get local to global map, non-const version.

Returns: The mapping relationship as a array.

Deprecated:: This accessor is meant to be used like a setter even though it's a bit like having public attribute... Use a real setter instead.

Definition at line 196 of file ParticleBlock.hpp.

◆ localToGlobalMap() [2/2]

array1d< globalIndex > geos::ParticleBlock::localToGlobalMap ( ) const

inlineoverridevirtual

Get local to global map.

Returns: The mapping relationship as an array.

Implements geos::ParticleBlockABC.

Definition at line 199 of file ParticleBlock.hpp.

◆ numParticles()

localIndex geos::ParticleBlock::numParticles ( ) const

inlineoverridevirtual

Get the number of particles.

Returns: number of particles in the particle block

Implements geos::ParticleBlockABC.

Definition at line 186 of file ParticleBlock.hpp.

◆ resize()

void geos::ParticleBlock::resize ( dataRepository::indexType const numParticles )

finaloverridevirtual

Resize the cell block to hold numParticles.

Parameters

numParticles The new number of particles.

Reimplemented from geos::dataRepository::Group.

◆ setParticleCenter()

void geos::ParticleBlock::setParticleCenter ( array2d< real64 > const particleCenter )

inline

Set the list of particle center locations in this subregion.

Parameters

particleCenter The input list of particle center coordinates

Definition at line 100 of file ParticleBlock.hpp.

◆ setParticleDamage()

void geos::ParticleBlock::setParticleDamage ( array1d< real64 > const particleDamage )

inline

Set the list of particle damage values in this subregion.

Parameters

particleDamage The input list of damage values

Definition at line 150 of file ParticleBlock.hpp.

◆ setParticleGroup()

void geos::ParticleBlock::setParticleGroup ( array1d< int > const particleGroup )

inline

Set the list of particle group numbers (for contact) in this subregion.

Parameters

particleGroup The input list of contact group numbers.

Definition at line 130 of file ParticleBlock.hpp.

◆ setParticleID()

void geos::ParticleBlock::setParticleID ( array1d< globalIndex > const particleID )

inline

Sets the global IDs of particles in this subregion.

Parameters

particleID The input list of global IDs

Definition at line 90 of file ParticleBlock.hpp.

◆ setParticleMaterialDirection()

void geos::ParticleBlock::setParticleMaterialDirection ( array2d< real64 > const particleMaterialDirection )

inline

Set the list of material directions in this subregion.

Parameters

particleMaterialDirection The input list of directions

Definition at line 120 of file ParticleBlock.hpp.

◆ setParticleRVectors()

void geos::ParticleBlock::setParticleRVectors ( array3d< real64 > const particleRVectors )

inline

Set the list of particle r-vectors in this subregion.

Parameters

particleRVectors The input list of r-vectors

Definition at line 180 of file ParticleBlock.hpp.

◆ setParticleStrengthScale()

void geos::ParticleBlock::setParticleStrengthScale ( array1d< real64 > const particleStrengthScale )

inline

Set the list of particle strength scale values in this subregion.

Parameters

particleStrengthScale The input list of strength scale values

Definition at line 160 of file ParticleBlock.hpp.

◆ setParticleSurfaceFlag()

void geos::ParticleBlock::setParticleSurfaceFlag ( array1d< int > const particleSurfaceFlag )

inline

Set the list of particle surface flags in this subregion.

Parameters

particleSurfaceFlag The input list of surface flags.

Definition at line 140 of file ParticleBlock.hpp.

◆ setParticleType()

void geos::ParticleBlock::setParticleType ( ParticleType particleType )

Defines the underlying particle type (hex, tet...)

Parameters

[in] particleType the particle type

Note: Allocates the values of the particle to nodes, edges, faces accordingly.

◆ setParticleVelocity()

void geos::ParticleBlock::setParticleVelocity ( array2d< real64 > const particleVelocity )

inline

Set the list of particle velocities in this subregion.

Parameters

particleVelocity The input list of velocities

Definition at line 110 of file ParticleBlock.hpp.

◆ setParticleVolume()

void geos::ParticleBlock::setParticleVolume ( array1d< real64 > const particleVolume )

inline

Set the list of particle volumes in this subregion.

Parameters

particleVolume The input list of volumes

Definition at line 170 of file ParticleBlock.hpp.

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

coreComponents/mesh/generators/ParticleBlock.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ParticleBlock() [1/2]

◆ ParticleBlock() [2/2]

Member Function Documentation

◆ getParticleCenter()

◆ getParticleDamage()

◆ getParticleGroup()

◆ getParticleID()

◆ getParticleMaterialDirection()

◆ getParticleRVectors()

◆ getParticleStrengthScale()

◆ getParticleSurfaceFlag()

◆ getParticleType()

◆ getParticleVelocity()

◆ getParticleVolume()

◆ hasRVectors()

◆ localToGlobalMap() [1/2]

◆ localToGlobalMap() [2/2]

◆ numParticles()

◆ resize()

◆ setParticleCenter()

◆ setParticleDamage()

◆ setParticleGroup()

◆ setParticleID()

◆ setParticleMaterialDirection()

◆ setParticleRVectors()

◆ setParticleStrengthScale()

◆ setParticleSurfaceFlag()

◆ setParticleType()

◆ setParticleVelocity()

◆ setParticleVolume()