GenericDofMap.h

Note

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

class GenericDofMap

Parent class(es)

• Variable

This class provides a generic interface for dof maps

GenericDofMap()

Constructor

bool is_view() const = 0

True if dof map is a view into another map (is a sub-dofmap)

std::size_t global_dimension() const = 0

Return the dimension of the global finite element function space

std::size_t local_dimension(std::string type) const = 0

Return number of owned (type=”owned”), unowned (type=”unowned”), or all (type=”all”) dofs in the map on this process

std::size_t cell_dimension(std::size_t index) const

Return the dimension of the local finite element function space on a cell (deprecated API)

std::size_t max_cell_dimension() const

Return the maximum dimension of the local finite element function space (deprecated API)

std::size_t num_element_dofs(std::size_t index) const = 0

Return the dimension of the local finite element function space on a cell

std::size_t max_element_dofs() const = 0

Return the maximum dimension of the local finite element function space

std::size_t num_entity_dofs(std::size_t dim) const = 0

Return the number of dofs for a given entity dimension

std::size_t num_facet_dofs() const = 0

Return number of facet dofs

std::pair<std::size_t, std::size_t> ownership_range() const = 0

Return the ownership range (dofs in this range are owned by this process)

const std::vector<int>& off_process_owner() const = 0

Return map from nonlocal-dofs (that appear in local dof map) to owning process

ArrayView<const dolfin::la_index> cell_dofs(std::size_t cell_index) const = 0

Local-to-global mapping of dofs on a cell

void tabulate_facet_dofs(std::vector<std::size_t>& dofs, std::size_t local_facet) const = 0

Tabulate local-local facet dofs

void tabulate_entity_dofs(std::vector<std::size_t>& dofs, std::size_t dim, std::size_t local_entity) const = 0

Tabulate the local-to-local mapping of dofs on entity (dim, local_entity)

void tabulate_coordinates(boost::multi_array<double, 2>& coordinates, const std::vector<double>& vertex_coordinates, const Cell& cell) const = 0

Tabulate the coordinates of all dofs on a cell (UFC cell version)

std::vector<double> tabulate_all_coordinates(const Mesh& mesh) const = 0

Tabulate the coordinates of all dofs owned by this process. This function is typically used by preconditioners that require the spatial coordinates of dofs, for example for re-partitioning or nullspace computations. The format for the return vector is [x0, y0, z0, x1, y1, z1, . . .].

std::shared_ptr<GenericDofMap> copy() const = 0

Create a copy of the dof map

std::shared_ptr<GenericDofMap> create(const Mesh& new_mesh) const = 0

Create a new dof map on new mesh

std::shared_ptr<GenericDofMap> extract_sub_dofmap(const std::vector<std::size_t>& component, const Mesh& mesh) const = 0

Extract sub dofmap component

std::shared_ptr<GenericDofMap> collapse(std::unordered_map<std::size_t, std::size_t>& collapsed_map, const Mesh& mesh) const = 0

Create a “collapsed” a dofmap (collapses from a sub-dofmap view)

std::vector<dolfin::la_index> dofs(const Mesh& mesh, std::size_t dim) const = 0

Return list of dof indices on this process that belong to mesh entities of dimension dim

std::vector<dolfin::la_index> dofs() const = 0

Return list of global dof indices on this process

void set(GenericVector& x, double value) const = 0

Set dof entries in vector to a specified value. Parallel layout of vector must be consistent with dof map range. This function is typically used to construct the null space of a matrix operator

void set_x(GenericVector& x, double value, std::size_t component, const Mesh& mesh) const = 0

Set dof entries in vector to the value*x[i], where x[i] is the spatial coordinate of the dof. Parallel layout of vector must be consistent with dof map range. This function is typically used to construct the null space of a matrix operator, e.g. rigid body rotations.

const std::vector<std::size_t>& local_to_global_unowned() const = 0

Return the map from unowned local dofmap nodes to global dofmap nodes. Dofmap node is dof index modulo block size.

void tabulate_local_to_global_dofs(std::vector<std::size_t>& local_to_global_map) const = 0

Tabulate map between local (process) and global dof indices

std::size_t local_to_global_index(int local_index) const = 0

Return global dof index corresponding to a given local index

const std::unordered_map<int, std::vector<int>>& shared_nodes() const = 0

Return map from shared nodes to the processes (not including the current process) that share it.

const std::set<int>& neighbours() const = 0

Return set of processes that share dofs with the this process

void clear_sub_map_data() = 0

Clear any data required to build sub-dofmaps (this is to reduce memory use)

std::string str(bool verbose) const = 0

Return informal string representation (pretty-print)