Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::IMeshBase Class Referenceabstract

Public Member Functions

virtual MeshHandle handle () const =0
 Handle on this mesh.
virtual String name () const =0
 Mesh name.
virtual Integer nbNode ()=0
 Number of mesh nodes.
virtual Integer nbEdge ()=0
 Number of mesh edges.
virtual Integer nbFace ()=0
 Number of mesh faces.
virtual Integer nbCell ()=0
 Number of mesh cells.
virtual Integer nbItem (eItemKind ik)=0
 Number of elements of type ik.
virtual ITraceMngtraceMng ()=0
 Associated message manager.
virtual Integer dimension ()=0
 Mesh dimension (1D, 2D, or 3D).
virtual NodeGroup allNodes ()=0
 Group of all nodes.
virtual EdgeGroup allEdges ()=0
 Group of all edges.
virtual FaceGroup allFaces ()=0
 Group of all faces.
virtual CellGroup allCells ()=0
 Group of all cells.
virtual NodeGroup ownNodes ()=0
 Group of all domain-specific nodes.
virtual EdgeGroup ownEdges ()=0
 Group of all domain-specific edges.
virtual FaceGroup ownFaces ()=0
 Group of all domain-specific faces.
virtual CellGroup ownCells ()=0
 Group of all domain-specific cells.
virtual FaceGroup outerFaces ()=0
 Group of all faces on the boundary.
virtual IItemFamilycreateItemFamily (eItemKind ik, const String &name)=0
 Create a particle family named name.
virtual IItemFamilyfindItemFamily (eItemKind ik, const String &name, bool create_if_needed=false, bool register_modifier_if_created=false)=0
 Returns the family named name.
virtual IItemFamilyfindItemFamily (const String &name, bool throw_exception=false)=0
 Returns the family named name.
virtual IItemFamilyModifierfindItemFamilyModifier (eItemKind ik, const String &name)=0
 Returns the IItemFamilyModifier interface for the family named name and of type ik.
virtual IItemFamilyitemFamily (eItemKind ik)=0
 Returns the entity family of type ik.
virtual IItemFamilynodeFamily ()=0
 Returns the node family.
virtual IItemFamilyedgeFamily ()=0
 Returns the edge family.
virtual IItemFamilyfaceFamily ()=0
 Returns the face family.
virtual IItemFamilycellFamily ()=0
 Returns the cell family.
virtual IItemFamilyCollection itemFamilies ()=0

Detailed Description

Definition at line 45 of file IMeshBase.h.

Member Function Documentation

◆ dimension()

virtual Integer Arcane::IMeshBase::dimension ( )
pure virtual

Mesh dimension (1D, 2D, or 3D).

The dimension corresponds to the dimension of the cells. If cells of multiple dimensions are present, the highest dimension is returned. If the dimension has not yet been set, returns -1;

Referenced by Arcane::MeshToMeshTransposer::kindTranspose().

◆ findItemFamily() [1/2]

virtual IItemFamily * Arcane::IMeshBase::findItemFamily ( const String & name,
bool throw_exception = false )
pure virtual

Returns the family named name.

If the requested family does not exist, if throw_exception is true, an exception is thrown, otherwise a null pointer is returned.

References name().

◆ findItemFamily() [2/2]

virtual IItemFamily * Arcane::IMeshBase::findItemFamily ( eItemKind ik,
const String & name,
bool create_if_needed = false,
bool register_modifier_if_created = false )
pure virtual

Returns the family named name.

If create_if_needed is true, the family is created if it did not exist. If register_modifier_if_created is true, the family modifier is registered

References name().

◆ findItemFamilyModifier()

virtual IItemFamilyModifier * Arcane::IMeshBase::findItemFamilyModifier ( eItemKind ik,
const String & name )
pure virtual

Returns the IItemFamilyModifier interface for the family named name and of type ik.

If this modifier is not found, returns nullptr

References name().

◆ itemFamily()

virtual IItemFamily * Arcane::IMeshBase::itemFamily ( eItemKind ik)
pure virtual

Returns the entity family of type ik.

Precondition
ik==IK_Node || ik==IK_Edge || ik==IK_Face || ik==IK_Cell

Referenced by Arcane::MeshToMeshTransposer::transpose().

◆ nbItem()

virtual Integer Arcane::IMeshBase::nbItem ( eItemKind ik)
pure virtual

Number of elements of type ik.

Precondition
ik==IK_Node || ik==IK_Edge || ik==IK_Face || ik==IK_Cell

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