FunctionSpace.h

// Copyright (C) 2008-2011 Anders Logg
//
// 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/>.
//
// Modified by Garth N. Wells 2008-2011
// Modified by Kent-Andre Mardal 2009
// Modified by Ola Skavhaug 2009
//
// First added:  2008-09-11
// Last changed: 2014-06-11

#ifndef __FUNCTION_SPACE_H
#define __FUNCTION_SPACE_H

#include <cstddef>
#include <map>
#include <vector>

#include <memory>
#include <unordered_map>
#include <dolfin/common/Array.h>
#include <dolfin/common/Variable.h>
#include <dolfin/common/Hierarchical.h>
#include <dolfin/fem/FiniteElement.h>
#include <dolfin/mesh/Cell.h>

namespace dolfin
{

  class Function;
  class GenericDofMap;
  class GenericFunction;
  class GenericVector;
  class Mesh;


  class FunctionSpace : public Variable, public Hierarchical<FunctionSpace>
  {
  public:

    FunctionSpace(std::shared_ptr<const Mesh> mesh,
                  std::shared_ptr<const FiniteElement> element,
                  std::shared_ptr<const GenericDofMap> dofmap);

  protected:

    explicit FunctionSpace(std::shared_ptr<const Mesh> mesh);

  public:

    FunctionSpace(const FunctionSpace& V);

    virtual ~FunctionSpace();

  protected:

    void attach(std::shared_ptr<const FiniteElement> element,
                std::shared_ptr<const GenericDofMap> dofmap);

  public:

    const FunctionSpace& operator= (const FunctionSpace& V);

    bool operator== (const FunctionSpace& V) const;

    bool operator!= (const FunctionSpace& V) const;

    std::shared_ptr<const Mesh> mesh() const;

    std::shared_ptr<const FiniteElement> element() const;

    std::shared_ptr<const GenericDofMap> dofmap() const;

    std::size_t dim() const;

    void interpolate(GenericVector& expansion_coefficients,
                     const GenericFunction& v) const;

    std::shared_ptr<FunctionSpace> operator[] (std::size_t i) const;

    std::shared_ptr<FunctionSpace> sub(std::size_t component) const
    { return extract_sub_space({component}); }

    std::shared_ptr<FunctionSpace>
    sub(const std::vector<std::size_t>& component) const
    { return extract_sub_space(component); }

    std::shared_ptr<FunctionSpace>
    extract_sub_space(const std::vector<std::size_t>& component) const;

    bool contains(const FunctionSpace& V) const;

    std::shared_ptr<FunctionSpace> collapse() const;

    std::shared_ptr<FunctionSpace>
    collapse(std::unordered_map<std::size_t, std::size_t>& collapsed_dofs) const;

    bool has_cell(const Cell& cell) const
    { return &cell.mesh() == &(*_mesh); }

    bool has_element(const FiniteElement& element) const
    { return element.hash() == _element->hash(); }

    std::vector<std::size_t> component() const;

    std::vector<double> tabulate_dof_coordinates() const;

    void set_x(GenericVector& x, double value, std::size_t component) const;

    std::string str(bool verbose) const;

    void print_dofmap() const;

  private:

    // General interpolation from any GenericFunction on any mesh
    void interpolate_from_any(GenericVector& expansion_coefficients,
                              const GenericFunction& v) const;

    // Specialised interpolate routine when functions are related by a
    // parent mesh
    void interpolate_from_parent(GenericVector& expansion_coefficients,
                                 const GenericFunction& v) const;

    // The mesh
    std::shared_ptr<const Mesh> _mesh;

    // The finite element
    std::shared_ptr<const FiniteElement> _element;

    // The dofmap
    std::shared_ptr<const GenericDofMap> _dofmap;

    // The component w.r.t. to root space
    std::vector<std::size_t> _component;

    // The identifier of root space
    std::size_t _root_space_id;

    // Cache of subspaces
    mutable std::map<std::vector<std::size_t>,
                     std::shared_ptr<FunctionSpace> > _subspaces;

  };

}

#endif