Edge of a cell. More...

#include <arcane/core/Item.h>

Classes
class	Index
	Index of an Edge in a variable. More...

Public Types
typedef EdgeLocalId	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
	Edge ()=default
	Creates a null edge.
	Edge (ItemInternal *ainternal)
	(deprecated) Constructs a reference to the entity internal
constexpr	Edge (const ItemBase &abase)
	Constructs a reference to the entity abase.
constexpr	Edge (const Item &aitem)
	Constructs a reference to the entity aitem.
	Edge (const ItemInternalPtr *internals, Int32 local_id)
	Constructs a reference to the entity internal.
Edge &	operator= (ItemInternal *ainternal)
	Copy operator.
constexpr eItemKind	kind () const
	Kind of the entity.
EdgeLocalId	itemLocalId () const
	Local identifier of the entity in the processor subdomain.
Int32	nbNode () const
	Number of vertices of the edge.
Int32	nbFace () const
	Number of faces connected to the edge.
Int32	nbCell () const
	Number of cells connected to the edge.
Cell	cell (Int32 i) const
	i-th cell of the edge
CellConnectedListViewType	cells () const
	List of edge cells.
CellLocalId	cellId (Int32 i) const
	i-th edge cell
CellLocalIdView	cellIds () const
	List of edge cells.
Face	face (Int32 i) const
	i-th face of the edge
FaceConnectedListViewType	faces () const
	List of faces of the edge.
FaceLocalId	faceId (Int32 i) const
	i-th face of the edge
FaceLocalIdView	faceIds () const
	List of faces of the edge.
Edge *	operator-> ()
const Edge *	operator-> () const
Public Member Functions inherited from Arcane::ItemWithNodes
	ItemWithNodes ()=default
	Creation of an entity not connected to the mesh.
	ItemWithNodes (ItemInternal *ainternal)
	(deprecated) Constructs a reference to the entity internal
constexpr	ItemWithNodes (const ItemBase &abase)
	Constructs a reference to the entity abase.
constexpr	ItemWithNodes (const Item &aitem)
	Constructs a reference to the entity aitem.
	ItemWithNodes (const ItemInternalPtr *internals, Int32 local_id)
	Constructs a reference to the entity internal.
ItemWithNodes &	operator= (ItemInternal *ainternal)
	Copy operator.
Int32	nbNode () const
	Number of nodes of the entity.
Node	node (Int32 i) const
	i-th node of the entity
NodeConnectedListViewType	nodes () const
	List of nodes of the entity.
NodeLocalIdView	nodeIds () const
	List of nodes of the entity.
NodeLocalId	nodeId (Int32 index) const
	i-th node of the entity.
Int32	nbLinearNode () const
	Number of nodes of the associated linear entity (if entity order 2 or more).
ItemWithNodes *	operator-> ()
const ItemWithNodes *	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

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::ItemWithNodes
constexpr	ItemWithNodes (Int32 local_id, ItemSharedInfo *shared_info)
	Constructor reserved for enumerators.
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

Edge of a cell.

Edges only exist in 3D. In 2D, you must use the 'Face' structure.

Definition at line 873 of file Item.h.

Member Typedef Documentation

◆ LocalIdType

typedef EdgeLocalId Arcane::Edge::LocalIdType

Type of localId().

Definition at line 923 of file Item.h.

Constructor & Destructor Documentation

◆ Edge() [1/4]

Arcane::Edge::Edge ( ItemInternal * ainternal )

inline

(deprecated) Constructs a reference to the entity internal

Definition at line 929 of file Item.h.

References Arcane::Item::isEdge(), and Arcane::ItemWithNodes::ItemWithNodes().

◆ Edge() [2/4]

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

inlineconstexpr

Constructs a reference to the entity abase.

Definition at line 936 of file Item.h.

References Arcane::Item::isEdge(), and Arcane::ItemWithNodes::ItemWithNodes().

◆ Edge() [3/4]

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

inlineexplicitconstexpr

Constructs a reference to the entity aitem.

Definition at line 943 of file Item.h.

References Arcane::Item::isEdge(), and Arcane::ItemWithNodes::ItemWithNodes().

◆ Edge() [4/4]

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

inline

Constructs a reference to the entity internal.

Definition at line 950 of file Item.h.

References Arcane::Item::isEdge(), and Arcane::ItemWithNodes::ItemWithNodes().

Member Function Documentation

◆ cell()

Cell Arcane::Edge::cell ( Int32 i ) const

inline

i-th cell of the edge

Definition at line 1758 of file Item.h.

Referenced by Arcane::MeshUtils::writeMeshInfosSorted().

◆ cellId()

CellLocalId Arcane::Edge::cellId ( Int32 i ) const

inline

i-th edge cell

Definition at line 987 of file Item.h.

◆ cellIds()

CellLocalIdView Arcane::Edge::cellIds ( ) const

inline

List of edge cells.

Definition at line 990 of file Item.h.

◆ cells()

CellConnectedListViewType Arcane::Edge::cells ( ) const

inline

List of edge cells.

Definition at line 984 of file Item.h.

◆ face()

Face Arcane::Edge::face ( Int32 i ) const

inline

i-th face of the edge

Definition at line 1752 of file Item.h.

Referenced by Arcane::MeshUtils::writeMeshInfosSorted().

◆ faceId()

FaceLocalId Arcane::Edge::faceId ( Int32 i ) const

inline

i-th face of the edge

Definition at line 999 of file Item.h.

◆ faceIds()

FaceLocalIdView Arcane::Edge::faceIds ( ) const

inline

List of faces of the edge.

Definition at line 1002 of file Item.h.

◆ faces()

FaceConnectedListViewType Arcane::Edge::faces ( ) const

inline

List of faces of the edge.

Definition at line 996 of file Item.h.

◆ itemLocalId()

EdgeLocalId Arcane::Edge::itemLocalId ( ) const

inline

Local identifier of the entity in the processor subdomain.

Definition at line 969 of file Item.h.

References Arcane::Item::m_local_id.

◆ kind()

eItemKind Arcane::Edge::kind ( ) const

inlineconstexpr

Kind of the entity.

Definition at line 966 of file Item.h.

References Arcane::IK_Edge.

◆ nbCell()

Int32 Arcane::Edge::nbCell ( ) const

inline

Number of cells connected to the edge.

Definition at line 978 of file Item.h.

References Arcane::Item::_nbCell().

Referenced by Arcane::MeshUtils::writeMeshInfosSorted().

◆ nbFace()

Int32 Arcane::Edge::nbFace ( ) const

inline

Number of faces connected to the edge.

Definition at line 975 of file Item.h.

References Arcane::Item::_nbFace().

Referenced by Arcane::MeshUtils::writeMeshInfosSorted().

◆ nbNode()

Int32 Arcane::Edge::nbNode ( ) const

inline

Number of vertices of the edge.

Definition at line 972 of file Item.h.

Referenced by Arcane::MeshUtils::writeMeshInfosSorted().

◆ operator->() [1/2]

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

inline

Definition at line 1005 of file Item.h.

◆ operator->() [2/2]

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

inline

Definition at line 1008 of file Item.h.

◆ operator=()

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

inline

Copy operator.

Definition at line 957 of file Item.h.