GenericDofMap

class dolfin.cpp.fem.GenericDofMap(*args, **kwargs)

Bases: dolfin.cpp.common.Variable

This class provides a generic interface for dof maps.

block_size()

Get block size.

Return type:int
cell_dimension()

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

Parameters:index (std::size_t) –
Return type:std::size_t
cell_dofs(i)

Return the dofmap for a cell

clear_sub_map_data()

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

Return type:void
collapse()

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

Parameters:
  • std::size_t, std::size_t > & collapsed_map (std::unordered_map<) –
  • Mesh & mesh (const) –
Return type:

std::shared_ptr< GenericDofMap >
constrained_domain

Subdomain mapping constrained boundaries, e.g. periodic conditions

Return type:std::shared_ptr< const SubDomain >
copy()

Create a copy of the dof map.

Return type:std::shared_ptr< GenericDofMap >
create()

Create a new dof map on new mesh.

Parameters:Mesh & new_mesh (const) –
Return type:std::shared_ptr< GenericDofMap >
dofs()

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

Parameters:
  • Mesh & mesh (const) –
  • dim (std::size_t) –
Return type:

std::vector< dolfin::la_index >
entity_closure_dofs()

Return the dof indices associated with the closure of entities of given dimension and entity indices

Parameters:
  • Mesh & mesh (const) –
  • entity_dim (std::size_t) –
  • std::vector< std::size_t > & entity_indices (const) –
Return type:

std::vector< dolfin::la_index >
entity_dofs()

Return the dof indices associated with entities of given dimension and entity indices.

Parameters:
  • Mesh & mesh (const) –
  • entity_dim (std::size_t) –
  • std::vector< std::size_t > & entity_indices (const) –
Return type:

std::vector< dolfin::la_index >
extract_sub_dofmap()

Extract sub dofmap component.

Parameters:
  • std::vector< std::size_t > & component (const) –
  • Mesh & mesh (const) –
Return type:

std::shared_ptr< GenericDofMap >
global_dimension()

Return the dimension of the global finite element function space

Return type:std::size_t
index_map()

Index map (const access)

Return type:std::shared_ptr< const IndexMap >
is_view()

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

Return type:bool
local_to_global_index()

Return global dof index corresponding to a given local index.

Parameters:local_index (int) –
Return type:std::size_t
local_to_global_unowned()

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

Return type:const std::vector< std::size_t > &
max_cell_dimension()

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

Return type:std::size_t
max_element_dofs()

Return the maximum dimension of the local finite element function space

Return type:std::size_t
neighbours()

Return set of processes that share dofs with the this process.

Return type:const std::set< int > &
num_element_dofs()

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

Parameters:index (std::size_t) –
Return type:std::size_t
num_entity_closure_dofs()

Return the number of dofs for closure of entity of given dimension.

Parameters:entity_dim (std::size_t) –
Return type:std::size_t
num_entity_dofs()

Return the number of dofs for a given entity dimension.

Parameters:entity_dim (std::size_t) –
Return type:std::size_t
num_facet_dofs()

Return number of facet dofs.

Return type:std::size_t
off_process_owner()

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

Return type:const std::vector< int > &
ownership_range()

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

Return type:std::pair< std::size_t, std::size_t >
set()

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

Parameters:
Return type:

void
shared_nodes()

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

Return type:const std::unordered_map< int, std::vector< int > > &
tabulate_entity_closure_dofs()

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

Parameters:
  • std::size_t > & element_dofs (std::vector<) –
  • entity_dim (std::size_t) –
  • cell_entity_index (std::size_t) –
Return type:

void
tabulate_entity_dofs()

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

Parameters:
  • std::size_t > & element_dofs (std::vector<) –
  • entity_dim (std::size_t) –
  • cell_entity_index (std::size_t) –
Return type:

void
tabulate_facet_dofs()

Tabulate local-local facet dofs.

Parameters:
  • std::size_t > & element_dofs (std::vector<) –
  • cell_facet_index (std::size_t) –
Return type:

void
tabulate_global_dofs()

Tabulate globally supported dofs.

Parameters:std::size_t > & dofs (std::vector<) –
Return type:void
tabulate_local_to_global_dofs()

Tabulate map between local (process) and global dof indices.

Parameters:std::size_t > & local_to_global_map (std::vector<) –
Return type:void
thisown

The membership flag