Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::IMeshBase Class Referenceabstract
Inheritance diagram for Arcane::IMeshBase:
Collaboration diagram for Arcane::IMeshBase:

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

◆ allCells()

virtual CellGroup Arcane::IMeshBase::allCells ( )
pure virtual

Group of all cells.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

Referenced by Arcane::VariableMng::dumpStats().

Here is the caller graph for this function:

◆ allEdges()

virtual EdgeGroup Arcane::IMeshBase::allEdges ( )
pure virtual

Group of all edges.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

◆ allFaces()

virtual FaceGroup Arcane::IMeshBase::allFaces ( )
pure virtual

Group of all faces.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

◆ allNodes()

virtual NodeGroup Arcane::IMeshBase::allNodes ( )
pure virtual

Group of all nodes.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

◆ cellFamily()

virtual IItemFamily * Arcane::IMeshBase::cellFamily ( )
pure virtual

Returns the cell family.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

Referenced by Arcane::ArcaneCasePartitioner::_addGhostGroups(), Arcane::CartesianPatchGroup::addPatch(), and Arcane::Materials::MeshMaterialExchangeMng::registerFactory().

Here is the caller graph for this function:

◆ createItemFamily()

virtual IItemFamily * Arcane::IMeshBase::createItemFamily ( eItemKind ik,
const String & name )
pure virtual

Create a particle family named name.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

References name().

Here is the call graph for this function:

◆ 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;

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

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

Here is the caller graph for this function:

◆ edgeFamily()

virtual IItemFamily * Arcane::IMeshBase::edgeFamily ( )
pure virtual

Returns the edge family.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

◆ faceFamily()

virtual IItemFamily * Arcane::IMeshBase::faceFamily ( )
pure virtual

Returns the face family.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

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

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

References name().

Here is the call graph for this function:

◆ 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

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

References name().

Referenced by Arcane::mesh::ItemFamily::readFromDump().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

References name().

Here is the call graph for this function:

◆ handle()

virtual MeshHandle Arcane::IMeshBase::handle ( ) const
pure virtual

Handle on this mesh.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

◆ 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

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

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

Here is the caller graph for this function:

◆ name()

virtual String Arcane::IMeshBase::name ( ) const
pure virtual

Mesh name.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

Referenced by Arcane::VtkPolyhedralCaseMeshReader::Builder::allocateMeshItems(), createItemFamily(), Arcane::IMesh::findGroup(), findItemFamily(), findItemFamily(), findItemFamilyModifier(), and Arcane::mesh::ItemFamily::findVariable().

Here is the caller graph for this function:

◆ nbCell()

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

Number of mesh cells.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

◆ nbEdge()

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

Number of mesh edges.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

◆ nbFace()

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

Number of mesh faces.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

◆ 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

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

◆ nbNode()

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

Number of mesh nodes.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

◆ nodeFamily()

virtual IItemFamily * Arcane::IMeshBase::nodeFamily ( )
pure virtual

Returns the node family.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

Referenced by Arcane::ArcaneCasePartitioner::_addGhostGroups(), and Arcane::NodeDirectionMng::_internalInit().

Here is the caller graph for this function:

◆ outerFaces()

virtual FaceGroup Arcane::IMeshBase::outerFaces ( )
pure virtual

Group of all faces on the boundary.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

◆ ownCells()

virtual CellGroup Arcane::IMeshBase::ownCells ( )
pure virtual

Group of all domain-specific cells.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

◆ ownEdges()

virtual EdgeGroup Arcane::IMeshBase::ownEdges ( )
pure virtual

Group of all domain-specific edges.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

◆ ownFaces()

virtual FaceGroup Arcane::IMeshBase::ownFaces ( )
pure virtual

Group of all domain-specific faces.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

◆ ownNodes()

virtual NodeGroup Arcane::IMeshBase::ownNodes ( )
pure virtual

Group of all domain-specific nodes.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

◆ traceMng()

virtual ITraceMng * Arcane::IMeshBase::traceMng ( )
pure virtual

Associated message manager.

Implemented in Arcane::mesh::DynamicMesh, and Arcane::mesh::EmptyMesh.

Referenced by Arcane::ItemGroupImpl::addItems(), Arcane::CartesianMeshAllocateBuildInfo::allocateMesh(), Arcane::UnstructuredMeshAllocateBuildInfo::allocateMesh(), Arcane::VtuCaseMeshReader::Builder::allocateMeshItems(), and Arcane::ItemGroupImpl::removeAddItems().

Here is the caller graph for this function:

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