Note: this is documentation for an old release. View the latest documentation at docs.fenicsproject.org/v0.1.0/v0.9.0/cpp
DOLFINx  0.1.0
DOLFINx C++ interface
Public Member Functions | Public Attributes | List of all members
dolfinx::mesh::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<typename Topology , typename Geometry >
 Mesh (MPI_Comm comm, Topology &&topology, Geometry &&geometry)
 Create a mesh. More...
 
 Mesh (const Mesh &mesh)=default
 Copy constructor. More...
 
 Mesh (Mesh &&mesh)=default
 Move constructor. More...
 
 ~Mesh ()=default
 Destructor.
 
Meshoperator= (const Mesh &mesh)=delete
 
Meshoperator= (Mesh &&mesh)=default
 Assignment move operator. More...
 
Topologytopology ()
 Get mesh topology. More...
 
const Topologytopology () const
 Get mesh topology (const version) More...
 
Topologytopology_mutable () const
 Get mesh topology if one really needs the mutable version. More...
 
Geometrygeometry ()
 Get mesh geometry. More...
 
const Geometrygeometry () const
 Get mesh geometry (const version) More...
 
std::size_t id () const
 Get unique identifier for the mesh. More...
 
MPI_Comm mpi_comm () const
 Mesh MPI communicator. More...
 

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<typename Topology , typename Geometry >
dolfinx::mesh::Mesh::Mesh ( MPI_Comm  comm,
Topology &&  topology,
Geometry &&  geometry 
)
inline

Create a mesh.

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

◆ Mesh() [2/3]

dolfinx::mesh::Mesh::Mesh ( const Mesh mesh)
default

Copy constructor.

Parameters
[in]meshMesh to be copied

◆ Mesh() [3/3]

dolfinx::mesh::Mesh::Mesh ( Mesh &&  mesh)
default

Move constructor.

Parameters
meshMesh to be moved.

Member Function Documentation

◆ geometry() [1/2]

const Geometry & Mesh::geometry ( )

Get mesh geometry.

Returns
The geometry object associated with the mesh

◆ geometry() [2/2]

const Geometry& dolfinx::mesh::Mesh::geometry ( ) const

Get mesh geometry (const version)

Returns
The geometry object associated with the mesh

◆ id()

std::size_t dolfinx::mesh::Mesh::id ( ) const
inline

Get unique identifier for the mesh.

Returns
The unique identifier associated with the object

◆ mpi_comm()

MPI_Comm Mesh::mpi_comm ( ) const

Mesh MPI communicator.

Returns
The communicator on which the mesh is distributed

◆ operator=()

Mesh& dolfinx::mesh::Mesh::operator= ( Mesh &&  mesh)
default

Assignment move operator.

Parameters
meshAnother Mesh object

◆ topology() [1/2]

const Topology & Mesh::topology ( )

Get mesh topology.

Returns
The topology object associated with the mesh.

◆ topology() [2/2]

const Topology& dolfinx::mesh::Mesh::topology ( ) const

Get mesh topology (const version)

Returns
The topology object associated with the mesh.

◆ topology_mutable()

Topology & Mesh::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: