ElementDofLayout.h

// Copyright (C) 2019 Chris Richardson and Garth N. Wells
//
// This file is part of DOLFINx (https://www.fenicsproject.org)
//
// SPDX-License-Identifier:    LGPL-3.0-or-later
 
#pragma once
 
#include <array>
#include <dolfinx/common/types.h>
#include <memory>
#include <set>
#include <ufc.h>
#include <vector>
 
namespace dolfinx::mesh
{
enum class CellType;
}
 
namespace dolfinx::fem
{
 
 
// TODO: For this class/concept to be robust, the topology of the
//       reference cell needs to be defined.
 
// TODO: Handle block dofmaps properly
 
class ElementDofLayout
{
public:
  ElementDofLayout(
      int block_size,
      const std::vector<std::vector<std::set<int>>>& entity_dofs,
      const std::vector<std::vector<std::set<int>>>& entity_closure_dofs,
      const std::vector<int>& parent_map,
      const std::vector<std::shared_ptr<const ElementDofLayout>>& sub_dofmaps);
 
  ElementDofLayout copy() const;
 
  ElementDofLayout(const ElementDofLayout& dofmap) = default;
 
  ElementDofLayout(ElementDofLayout&& dofmap) = default;
 
  ~ElementDofLayout() = default;
 
  ElementDofLayout& operator=(const ElementDofLayout& dofmap) = default;
 
  ElementDofLayout& operator=(ElementDofLayout&& dofmap) = default;
 
  int num_dofs() const;
 
  int num_entity_dofs(int dim) const;
 
  int num_entity_closure_dofs(int dim) const;
 
  std::vector<int> entity_dofs(int entity_dim, int cell_entity_index) const;
 
  std::vector<int> entity_closure_dofs(int entity_dim,
                                       int cell_entity_index) const;
 
  const std::vector<std::vector<std::set<int>>>& entity_dofs_all() const;
 
  const std::vector<std::vector<std::set<int>>>&
  entity_closure_dofs_all() const;
 
  int num_sub_dofmaps() const;
 
  std::shared_ptr<const ElementDofLayout>
  sub_dofmap(const std::vector<int>& component) const;
 
  std::vector<int> sub_view(const std::vector<int>& component) const;
 
  int block_size() const;
 
  bool is_view() const;
 
private:
  // Block size
  int _block_size;
 
  // Mapping of dofs to this ElementDofLayout's immediate parent
  std::vector<int> _parent_map;
 
  // Total number of dofs on this element dofmap
  int _num_dofs;
 
  // The number of dofs associated with each entity type
  std::array<int, 4> _num_entity_dofs;
 
  // The number of dofs associated with each entity type, including all
  // connected entities of lower dimension.
  std::array<int, 4> _num_entity_closure_dofs;
 
  // List of dofs per entity, ordered by dimension.
  // dof = _entity_dofs[dim][entity][i]
  std::vector<std::vector<std::set<int>>> _entity_dofs;
 
  // List of dofs with connected entities of lower dimension
  std::vector<std::vector<std::set<int>>> _entity_closure_dofs;
 
  // List of sub dofmaps
  std::vector<std::shared_ptr<const ElementDofLayout>> _sub_dofmaps;
};
 
} // namespace dolfinx::fem