MeshData.h¶

Note

The documentation on this page was automatically extracted from the DOLFIN C++ code and may need to be edited or expanded.

class MeshData¶

Parent class(es)

Variable

The class MeshData is a container for auxiliary mesh data, represented either as arrays or maps. Each dataset is identified by a unique user-specified string. Only std::size_t-valued data are currently supported.

Auxiliary mesh data may be attached to a mesh by users as a convenient way to store data associated with a mesh. It is also used internally by DOLFIN to communicate data associated with meshes. The following named mesh data are recognized by DOLFIN:

Facet orientation (used for assembly over interior facets)

“facet_orientation” - _std:vector_ <std::size_t> of dimension D - 1

Sub meshes (used by the class SubMesh)

“parent_vertex_indices” - _std::vector_ <std::size_t> of dimension 0

Note to developers: use underscore in names in place of spaces.

MeshData()¶: Constructor

const MeshData &operator=(const MeshData &data)¶

Assignment operator

Arguments

data (MeshData): Another MeshData object.

void clear()¶: Clear all data

bool exists(std::string name, std::size_t dim) const¶

Check is array exists

Arguments

name (std::string): The name of the array.

Returns

bool: True is array exists, false otherwise.

boost::shared_ptr<MeshFunction<std::size_t>> create_mesh_function(std::string name)¶: This function is no longer supported. It is retained to print an informative error message. It will be removed in the future.

boost::shared_ptr<MeshFunction<std::size_t>> create_mesh_function(std::string name, std::size_t dim)¶: This function is no longer supported. It is retained to print an informative error message. It will be removed in the future.

boost::shared_ptr<MeshFunction<std::size_t>> mesh_function(const std::string name) const¶: This function is no longer supported. It is retained to print an informative error message. It will be removed in the future.

std::vector<std::size_t> &array(std::string name, std::size_t dim)¶

Return array with given name (returning zero if data is not available)

Arguments

name (std::string): The name of the array.

Returns

std::vector<std::size_t>: The array.

const std::vector<std::size_t> &array(std::string name, std::size_t dim) const¶

Return array with given name (returning zero if data is not available)

Arguments

name (std::string): The name of the array.

Returns

std::vector<std::size_t>: The array.

void erase_array(const std::string name, std::size_t dim)¶

Erase array with given name

Arguments

name (std::string): The name of the array.

std::string str(bool verbose) const¶

Return informal string representation (pretty-print)

Arguments

verbose (bool): Flag to turn on additional output.

Returns

std::string: An informal representation.