Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::ItemWithNodes Class Reference

Mesh element based on nodes (Edge,Face,Cell). More...

#include <arcane/core/Item.h>

Public Member Functions

 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.
ItemWithNodesoperator= (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).
ItemWithNodesoperator-> ()
const ItemWithNodesoperator-> () 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.
Itemoperator= (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.
IItemFamilyitemFamily () 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.
ItemInternalinternal () 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 ItemTypeInfotypeInfo () const
 Information about the entity type.
Itemoperator-> ()
const Itemoperator-> () const

Protected Member Functions

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.

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

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 ItemInternalItemInternalPtr
typedef ItemLocalId LocalIdType
 Type of localId().
using ItemBase = impl::ItemBase
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 Attributes inherited from Arcane::Item
Int32 m_local_id = NULL_ITEM_LOCAL_ID
 Local number (in the subdomain) of the entity.

Detailed Description

Mesh element based on nodes (Edge,Face,Cell).

Definition at line 771 of file Item.h.

Constructor & Destructor Documentation

◆ ItemWithNodes() [1/5]

Arcane::ItemWithNodes::ItemWithNodes ( Int32 local_id,
ItemSharedInfo * shared_info )
inlineconstexprprotected

◆ ItemWithNodes() [2/5]

Arcane::ItemWithNodes::ItemWithNodes ( ItemInternal * ainternal)
inline

(deprecated) Constructs a reference to the entity internal

Definition at line 800 of file Item.h.

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

◆ ItemWithNodes() [3/5]

Arcane::ItemWithNodes::ItemWithNodes ( const ItemBase & abase)
inlineconstexpr

Constructs a reference to the entity abase.

Definition at line 807 of file Item.h.

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

◆ ItemWithNodes() [4/5]

Arcane::ItemWithNodes::ItemWithNodes ( const Item & aitem)
inlineexplicitconstexpr

Constructs a reference to the entity aitem.

Definition at line 814 of file Item.h.

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

◆ ItemWithNodes() [5/5]

Arcane::ItemWithNodes::ItemWithNodes ( const ItemInternalPtr * internals,
Int32 local_id )
inline

Constructs a reference to the entity internal.

Definition at line 821 of file Item.h.

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

Member Function Documentation

◆ nbLinearNode()

Int32 Arcane::ItemWithNodes::nbLinearNode ( ) const
inline

Number of nodes of the associated linear entity (if entity order 2 or more).

Definition at line 852 of file Item.h.

References Arcane::Item::_nbLinearNode().

◆ nbNode()

◆ node()

◆ nodeId()

NodeLocalId Arcane::ItemWithNodes::nodeId ( Int32 index) const
inline

i-th node of the entity.

Definition at line 849 of file Item.h.

◆ nodeIds()

NodeLocalIdView Arcane::ItemWithNodes::nodeIds ( ) const
inline

◆ nodes()

◆ operator->() [1/2]

ItemWithNodes * Arcane::ItemWithNodes::operator-> ( )
inline

Definition at line 857 of file Item.h.

◆ operator->() [2/2]

const ItemWithNodes * Arcane::ItemWithNodes::operator-> ( ) const
inline

Definition at line 860 of file Item.h.

◆ operator=()

ItemWithNodes & Arcane::ItemWithNodes::operator= ( ItemInternal * ainternal)
inline

Copy operator.

Definition at line 828 of file Item.h.

References ItemWithNodes().

◆ ItemConnectedEnumeratorBaseT< ThatClass >

friend class ItemConnectedEnumeratorBaseT< ThatClass >
friend

Definition at line 633 of file Item.h.

◆ ItemConnectedListViewConstIteratorT< ThatClass >

friend class ItemConnectedListViewConstIteratorT< ThatClass >
friend

Definition at line 633 of file Item.h.

◆ ItemConnectedListViewT< ThatClass >

friend class ItemConnectedListViewT< ThatClass >
friend

Definition at line 633 of file Item.h.

◆ ItemEnumeratorBaseT< ThatClass >

friend class ItemEnumeratorBaseT< ThatClass >
friend

Definition at line 633 of file Item.h.

◆ ItemInfoListViewT< ThatClass >

friend class ItemInfoListViewT< ThatClass >
friend

Definition at line 633 of file Item.h.

◆ ItemLocalIdToItemConverterT< ThatClass >

friend class ItemLocalIdToItemConverterT< ThatClass >
friend

Definition at line 633 of file Item.h.

◆ ItemVectorT< ThatClass >

friend class ItemVectorT< ThatClass >
friend

Definition at line 633 of file Item.h.

◆ ItemVectorViewConstIteratorT< ThatClass >

friend class ItemVectorViewConstIteratorT< ThatClass >
friend

Definition at line 633 of file Item.h.

◆ ItemVectorViewT< ThatClass >

friend class ItemVectorViewT< ThatClass >
friend

Definition at line 633 of file Item.h.

◆ SimdItemT< ThatClass >

friend class SimdItemT< ThatClass >
friend

Definition at line 633 of file Item.h.


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