DOLFINx
DOLFINx C++ interface
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
Mesh Class Reference

A Mesh consists of a set of connected and numbered mesh topological entities, and geometry data. More...

#include <Mesh.h>

Public Member Functions

template<std::convertible_to< Topology > U, std::convertible_to< Geometry > V>
 Mesh (MPI_Comm comm, U &&topology, V &&geometry)
 Create a mesh.
 
 Mesh (const Mesh &mesh)=default
 Copy constructor.
 
 Mesh (Mesh &&mesh)=default
 Move constructor.
 
 ~Mesh ()=default
 Destructor.
 
Meshoperator= (const Mesh &mesh)=delete
 
Meshoperator= (Mesh &&mesh)=default
 Assignment move operator.
 
Topologytopology ()
 Get mesh topology.
 
const Topologytopology () const
 Get mesh topology (const version)
 
Topologytopology_mutable () const
 Get mesh topology if one really needs the mutable version.
 
Geometrygeometry ()
 Get mesh geometry.
 
const Geometrygeometry () const
 Get mesh geometry (const version)
 
MPI_Comm comm () const
 Mesh MPI communicator.
 

Public Attributes

std::string name = "mesh"
 Name.
 

Detailed Description

A Mesh consists of a set of connected and numbered mesh topological entities, and geometry data.

Constructor & Destructor Documentation

◆ Mesh() [1/3]

template<std::convertible_to< Topology > U, std::convertible_to< Geometry > V>
Mesh ( MPI_Comm  comm,
U &&  topology,
V &&  geometry 
)
inline

Create a mesh.

Parameters
[in]commMPI Communicator
[in]topologyMesh topology
[in]geometryMesh geometry

◆ Mesh() [2/3]

Mesh ( const Mesh mesh)
default

Copy constructor.

Parameters
[in]meshMesh to be copied

◆ Mesh() [3/3]

Mesh ( Mesh &&  mesh)
default

Move constructor.

Parameters
meshMesh to be moved.

Member Function Documentation

◆ comm()

MPI_Comm comm ( ) const

Mesh MPI communicator.

Returns
The communicator on which the mesh is distributed

◆ geometry() [1/2]

Geometry & geometry ( )

Get mesh geometry.

Returns
The geometry object associated with the mesh

◆ geometry() [2/2]

const Geometry & geometry ( ) const

Get mesh geometry (const version)

Returns
The geometry object associated with the mesh

◆ operator=()

Mesh & operator= ( Mesh &&  mesh)
default

Assignment move operator.

Parameters
meshAnother Mesh object

◆ topology() [1/2]

Topology & topology ( )

Get mesh topology.

Returns
The topology object associated with the mesh.

◆ topology() [2/2]

const Topology & topology ( ) const

Get mesh topology (const version)

Returns
The topology object associated with the mesh.

◆ topology_mutable()

Topology & topology_mutable ( ) const

Get mesh topology if one really needs the mutable version.

Returns
The topology object associated with the mesh.

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