#include <arcane/core/Item.h>

Inheritance diagram for Arcane::Particle:

Collaboration diagram for Arcane::Particle:

Public Types
typedef ParticleLocalId	LocalIdType
	Type of localId().
Public Types inherited from Arcane::Item
enum	{ Unknown = IT_NullType , Vertex = IT_Vertex , Bar2 = IT_Line2 , Tri3 = IT_Triangle3 , Quad4 = IT_Quad4 , Pentagon5 = IT_Pentagon5 , Hexagon6 = IT_Hexagon6 , Tetra = IT_Tetraedron4 , Pyramid = IT_Pyramid5 , Penta = IT_Pentaedron6 , Hexa = IT_Hexaedron8 , Wedge7 = IT_Heptaedron10 , Wedge8 = IT_Octaedron12 }
	Element types. More...
typedef ItemInternal *	ItemInternalPtr
typedef ItemLocalId	LocalIdType
	Type of localId().
using	ItemBase = impl::ItemBase

Public Member Functions
	Particle ()=default
	Constructor for a null particle.
	Particle (ItemInternal *ainternal)
	(deprecated) Constructs a reference to the internal entity
constexpr	Particle (const ItemBase &abase)
	Constructs a reference to the abase entity.
constexpr	Particle (const Item &aitem)
	Constructs a reference to the aitem entity.
	Particle (const ItemInternalPtr *internals, Int32 local_id)
	Constructs a reference to the internal entity.
Particle &	operator= (ItemInternal *ainternal)
	Copy operator.
constexpr eItemKind	kind () const
	Entity kind.
ParticleLocalId	itemLocalId () const
	Local identifier of the entity in the processor subdomain.
Cell	cell () const
	Cell to which the particle belongs. You must call setCell() before calling this function. \precondition hasCell() must be true.
CellLocalId	cellId () const
	Cell connected to the particle.
bool	hasCell () const
	True if the particle is in a mesh cell.
Cell	cellOrNull () const
	Cell to which the particle belongs or null cell. Returns cell() if the particle is in a cell or the null cell if the particle is not in any cell.
Particle *	operator-> ()
const Particle *	operator-> () const
Public Member Functions inherited from Arcane::Item
	Item ()=default
	Creation of a null mesh entity.
	Item (ItemInternal *ainternal)
	Constructs a reference to the internal entity.
constexpr __host__ __device__	Item (const ItemBase &abase)
	Constructs a reference to the abase entity.
	Item (const ItemInternalPtr *internals, Int32 local_id)
	Constructs a reference to the internal entity.
Item &	operator= (ItemInternal *ainternal)
	Copy operator.
constexpr bool	null () const
	true if the entity is null (i.e. not connected to the mesh)
constexpr Int32	localId () const
	Local identifier of the entity in the processor subdomain.
constexpr ItemLocalId	itemLocalId () const
	Local identifier of the entity in the processor subdomain.
ItemUniqueId	uniqueId () const
	Unique identifier across all domains.
Int32	owner () const
	Owner subdomain number of the entity.
Int16	type () const
	Entity type.
ItemTypeId	itemTypeId () const
	Entity type.
IItemFamily *	itemFamily () const
	Family from which the entity originates.
constexpr eItemKind	kind () const
	Entity kind.
constexpr bool	isOwn () const
	true if the entity belongs to the subdomain
bool	isShared () const
	True if the entity is shared by other subdomains.
ItemWithNodes	toItemWithNodes () const
	Converts the entity to the ItemWithNodes kind.
Node	toNode () const
	Converts the entity to the Node kind.
Cell	toCell () const
	Converts the entity to the Cell kind.
Edge	toEdge () const
	Converts the entity to the Edge kind.
Face	toFace () const
	Converts the entity to the Face kind.
Particle	toParticle () const
	Converts the entity to the Particle kind.
DoF	toDoF () const
	Converts the entity to the DoF kind.
Int32	nbParent () const
	Number of parents for submeshes.
Item	parent (Int32 i) const
	i-th parent for submeshes
Item	parent () const
	first parent for submeshes
constexpr bool	isItemWithNodes () const
	true if the entity is of the ItemWithNodes kind.
constexpr bool	isNode () const
	true if the entity is of the Node kind.
constexpr bool	isCell () const
	true if the entity is of the Cell kind.
constexpr bool	isEdge () const
	true if the entity is of the Edge kind.
constexpr bool	isFace () const
	true if the entity is of the Face kind.
constexpr bool	isParticle () const
	true if the entity is of the Particle kind.
constexpr bool	isDoF () const
	true if the entity is of the DoF kind
constexpr bool	hasFlags (Int32 flags) const
	Returns if the flags are set for the entity.
constexpr Int32	flags () const
	Entity flags.
ItemInternal *	internal () const
	Internal part of the entity.
impl::ItemBase	itemBase () const
	Internal part of the entity.
impl::MutableItemBase	mutableItemBase () const
	Mutable internal part of the entity.
const ItemTypeInfo *	typeInfo () const
	Information about the entity type.
Item *	operator-> ()
const Item *	operator-> () const

Private Types
using	ThatClass = Particle

Private Member Functions
	Particle (Int32 local_id, ItemSharedInfo *shared_info)
	Constructor reserved for enumerators.

Friends
class	ItemEnumeratorBaseT< ThatClass >
class	ItemConnectedEnumeratorBaseT< ThatClass >
class	ItemVectorT< ThatClass >
class	ItemVectorViewT< ThatClass >
class	ItemConnectedListViewT< ThatClass >
class	ItemVectorViewConstIteratorT< ThatClass >
class	ItemConnectedListViewConstIteratorT< ThatClass >
class	SimdItemT< ThatClass >
class	ItemInfoListViewT< ThatClass >
class	ItemLocalIdToItemConverterT< ThatClass >

Additional Inherited Members
Static Public Member Functions inherited from Arcane::Item
static String	typeName (Int32 type)
	Cell type name cell_type.
static void	dumpStats (ITraceMng *tm)
static void	resetStats ()
Static Public Attributes inherited from Arcane::Item
static const Int32	NULL_ELEMENT = NULL_ITEM_ID
	Null element index.
Protected Member Functions inherited from Arcane::Item
constexpr __host__ __device__	Item (Int32 local_id, ItemSharedInfo *shared_info)
	Constructor reserved for enumerators.
constexpr void	_checkKind (bool is_valid) const
void	_badConversion () const
void	_set (ItemInternal *ainternal)
constexpr void	_set (const Item &rhs)
constexpr Int32	_flags () const
	Entity flags.
constexpr Integer	_nbNode () const
	Number of nodes of the entity.
constexpr Integer	_nbEdge () const
	Number of edges of the entity or number of edges connected to the entity (for nodes).
constexpr Integer	_nbFace () const
	Number of faces of the entity or number of faces connected to the entity (for nodes and edges).
constexpr Integer	_nbCell () const
	Number of cells connected to the entity (for nodes, edges and faces).
Int32	_nbHParent () const
	Number of parents for AMR.
Int32	_nbHChildren () const
	Number of children for AMR.
Integer	_nbParent () const
	Number of parents for submeshes.
constexpr NodeLocalId	_nodeId (Int32 index) const
constexpr EdgeLocalId	_edgeId (Int32 index) const
constexpr FaceLocalId	_faceId (Int32 index) const
constexpr CellLocalId	_cellId (Int32 index) const
Int32	_hParentId (Int32 index) const
Int32	_hChildId (Int32 index) const
impl::ItemIndexedListView< DynExtent >	_nodeList () const
impl::ItemIndexedListView< DynExtent >	_edgeList () const
impl::ItemIndexedListView< DynExtent >	_faceList () const
impl::ItemIndexedListView< DynExtent >	_cellList () const
NodeLocalIdView	_nodeIds () const
EdgeLocalIdView	_edgeIds () const
FaceLocalIdView	_faceIds () const
CellLocalIdView	_cellIds () const
constexpr Node	_node (Int32 index) const
constexpr Edge	_edge (Int32 index) const
constexpr Face	_face (Int32 index) const
constexpr Cell	_cell (Int32 index) const
ItemBase	_hParentBase (Int32 index) const
ItemBase	_hChildBase (Int32 index) const
ItemBase	_toItemBase () const
Int32	_nbLinearNode () const
	Number of nodes of the entity.
Protected Attributes inherited from Arcane::Item
Int32	m_local_id = NULL_ITEM_LOCAL_ID
	Local number (in the subdomain) of the entity.

Detailed Description

Particle.

Definition at line 1527 of file Item.h.

Member Typedef Documentation

◆ LocalIdType

typedef ParticleLocalId Arcane::Particle::LocalIdType

Type of localId().

Definition at line 1553 of file Item.h.

◆ ThatClass

using Arcane::Particle::ThatClass = Particle

private

Definition at line 1530 of file Item.h.

Constructor & Destructor Documentation

◆ Particle() [1/5]

Arcane::Particle::Particle	(	Int32	local_id,
		ItemSharedInfo *	shared_info )

inlineprivate

Constructor reserved for enumerators.

Definition at line 1546 of file Item.h.

References Arcane::Item::Item().

Referenced by operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Particle() [2/5]

Arcane::Particle::Particle ( ItemInternal * ainternal )

inline

(deprecated) Constructs a reference to the internal entity

Definition at line 1559 of file Item.h.

References Arcane::Item::isParticle(), and Arcane::Item::Item().

Here is the call graph for this function:

◆ Particle() [3/5]

Arcane::Particle::Particle ( const ItemBase & abase )

inlineconstexpr

Constructs a reference to the abase entity.

Definition at line 1566 of file Item.h.

References Arcane::Item::isParticle(), and Arcane::Item::Item().

Here is the call graph for this function:

◆ Particle() [4/5]

Arcane::Particle::Particle ( const Item & aitem )

inlineexplicitconstexpr

Constructs a reference to the aitem entity.

Definition at line 1573 of file Item.h.

References Arcane::Item::isParticle(), and Arcane::Item::Item().

Here is the call graph for this function:

◆ Particle() [5/5]

Arcane::Particle::Particle	(	const ItemInternalPtr *	internals,
		Int32	local_id )

inline

Constructs a reference to the internal entity.

Definition at line 1580 of file Item.h.

References Arcane::Item::isParticle(), and Arcane::Item::Item().

Here is the call graph for this function:

Member Function Documentation

◆ cell()

Cell Arcane::Particle::cell ( ) const

inline

Cell to which the particle belongs. You must call setCell() before calling this function. \precondition hasCell() must be true.

Definition at line 1606 of file Item.h.

Referenced by Arcane::UnstructuredMeshUtilities::changeOwnersFromCells(), and Arcane::mesh::ParticleFamilySerializer::serializeItems().

Here is the caller graph for this function:

◆ cellId()

CellLocalId Arcane::Particle::cellId ( ) const

inline

Cell connected to the particle.

Definition at line 1609 of file Item.h.

◆ cellOrNull()

Cell Arcane::Particle::cellOrNull ( ) const

inline

Cell to which the particle belongs or null cell. Returns cell() if the particle is in a cell or the null cell if the particle is not in any cell.

Definition at line 1619 of file Item.h.

References Arcane::Cell.

◆ hasCell()

bool Arcane::Particle::hasCell ( ) const

inline

True if the particle is in a mesh cell.

Definition at line 1612 of file Item.h.

References Arcane::Item::localId().

Referenced by Arcane::mesh::ParticleFamilySerializer::serializeItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ itemLocalId()

ParticleLocalId Arcane::Particle::itemLocalId ( ) const

inline

Local identifier of the entity in the processor subdomain.

Definition at line 1599 of file Item.h.

References Arcane::Item::m_local_id.

◆ kind()

eItemKind Arcane::Particle::kind ( ) const

inlineconstexpr

Entity kind.

Definition at line 1596 of file Item.h.

References Arcane::IK_Particle.

◆ operator->() [1/2]

Particle * Arcane::Particle::operator-> ( )

inline

Definition at line 1628 of file Item.h.

◆ operator->() [2/2]

const Particle * Arcane::Particle::operator-> ( ) const

inline

Definition at line 1631 of file Item.h.

◆ operator=()

Particle & Arcane::Particle::operator= ( ItemInternal * ainternal )

inline

Copy operator.

Definition at line 1587 of file Item.h.

References Particle().

Here is the call graph for this function: