GenericDofMap.h

// Copyright (C) 2010-2015 Anders Logg and Garth N. Wells
//
// This file is part of DOLFIN.
//
// DOLFIN is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// DOLFIN is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with DOLFIN. If not, see <http://www.gnu.org/licenses/>.

#ifndef __GENERIC_DOF_MAP_H
#define __GENERIC_DOF_MAP_H

#include <map>
#include <utility>
#include <vector>
#include <memory>
#include <unordered_map>
#include <unordered_set>
#include <Eigen/Dense>

#include <dolfin/common/types.h>
#include <dolfin/common/Variable.h>
#include <dolfin/la/IndexMap.h>
#include <dolfin/log/log.h>

namespace ufc
{
  class cell;
}

namespace dolfin
{

  class Cell;
  class GenericVector;
  class Mesh;
  class SubDomain;


  class GenericDofMap : public Variable
  {
  public:

    GenericDofMap()
    {}

    virtual bool is_view() const = 0;

    virtual std::size_t global_dimension() const = 0;

    std::size_t cell_dimension(std::size_t index) const
    {
      // TODO: Add deprecation warning
      return num_element_dofs(index);
    }

    std::size_t max_cell_dimension() const
    {
      // TODO: Add deprecation warning
      return max_element_dofs();
    }

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

    virtual std::size_t max_element_dofs() const = 0;

    virtual std::size_t num_entity_dofs(std::size_t entity_dim) const = 0;

    virtual std::size_t num_entity_closure_dofs(std::size_t entity_dim) const = 0;

    virtual std::size_t num_facet_dofs() const = 0;

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

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

    virtual Eigen::Map<const Eigen::Array<dolfin::la_index, Eigen::Dynamic, 1>>
      cell_dofs(std::size_t cell_index) const = 0;

    virtual std::vector<dolfin::la_index>
      entity_dofs(const Mesh& mesh, std::size_t entity_dim,
                  const std::vector<std::size_t> & entity_indices) const = 0;

    virtual std::vector<dolfin::la_index>
      entity_dofs(const Mesh& mesh, std::size_t entity_dim) const = 0;

    virtual std::vector<dolfin::la_index>
      entity_closure_dofs(const Mesh& mesh, std::size_t entity_dim,
                          const std::vector<std::size_t> & entity_indices) const = 0;

    virtual std::vector<dolfin::la_index>
      entity_closure_dofs(const Mesh& mesh, std::size_t entity_dim) const = 0;

    virtual void tabulate_facet_dofs(std::vector<std::size_t>& element_dofs,
                                     std::size_t cell_facet_index) const = 0;

    virtual void tabulate_entity_dofs(std::vector<std::size_t>& element_dofs,
                                      std::size_t entity_dim,
                                      std::size_t cell_entity_index) const = 0;

    virtual void tabulate_entity_closure_dofs(std::vector<std::size_t>& element_dofs,
                                              std::size_t entity_dim,
                                              std::size_t cell_entity_index) const = 0;

    virtual void tabulate_global_dofs(std::vector<std::size_t>& dofs) const = 0;

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

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

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

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

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

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

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

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

    virtual std::shared_ptr<const IndexMap> index_map() const = 0;

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

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

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

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

    virtual void clear_sub_map_data() = 0;

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

    virtual int block_size() const = 0;

    std::shared_ptr<const SubDomain> constrained_domain;

  };

}

#endif