fe_field_function.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
// Copyright (C) 2007 - 2024 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Detailed license information governing the source code and contributions
// can be found in LICENSE.md and CONTRIBUTING.md at the top level directory.
//
// -----------------------------------------------------------------------------
 
#ifndef dealii_fe_function_h
#define dealii_fe_function_h
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/function.h>
#include <deal.II/base/point.h>
#include <deal.II/base/tensor.h>
#include <deal.II/base/thread_local_storage.h>
 
#include <deal.II/dofs/dof_accessor.h>
#include <deal.II/dofs/dof_handler.h>
 
#include <deal.II/fe/mapping_q1.h>
 
#include <deal.II/grid/grid_tools_cache.h>
 
#include <deal.II/lac/vector.h>
 
#include <optional>
 
 
DEAL_II_NAMESPACE_OPEN
 
// Forward declaration
#ifndef DOXYGEN
namespace VectorTools
{
  class ExcPointNotAvailableHere;
}
#endif
 
namespace Functions
{
  template <int dim, typename VectorType = Vector<double>, int spacedim = dim>
  class FEFieldFunction : public Function<dim, typename VectorType::value_type>
  {
  public:
    FEFieldFunction(const DoFHandler<dim, spacedim> &dh,
                    const VectorType                &data_vector,
                    const Mapping<dim>              &mapping);
 
    FEFieldFunction(const DoFHandler<dim, spacedim> &dh,
                    const VectorType                &data_vector);
 
    void
    set_active_cell(
      const typename DoFHandler<dim, spacedim>::active_cell_iterator &newcell);
 
    virtual void
    vector_value(
      const Point<dim>                        &p,
      Vector<typename VectorType::value_type> &values) const override;
 
    virtual typename VectorType::value_type
    value(const Point<dim> &p, const unsigned int component = 0) const override;
 
    virtual void
    value_list(const std::vector<Point<dim>>                &points,
               std::vector<typename VectorType::value_type> &values,
               const unsigned int component = 0) const override;
 
 
    virtual void
    vector_value_list(const std::vector<Point<dim>> &points,
                      std::vector<Vector<typename VectorType::value_type>>
                        &values) const override;
 
    virtual void
    vector_gradient(const Point<dim> &p,
                    std::vector<Tensor<1, dim, typename VectorType::value_type>>
                      &gradients) const override;
 
    virtual Tensor<1, dim, typename VectorType::value_type>
    gradient(const Point<dim>  &p,
             const unsigned int component = 0) const override;
 
    virtual void
    vector_gradient_list(
      const std::vector<Point<dim>> &p,
      std::vector<std::vector<Tensor<1, dim, typename VectorType::value_type>>>
        &gradients) const override;
 
    virtual void
    gradient_list(
      const std::vector<Point<dim>>                                &p,
      std::vector<Tensor<1, dim, typename VectorType::value_type>> &gradients,
      const unsigned int component = 0) const override;
 
 
    virtual typename VectorType::value_type
    laplacian(const Point<dim>  &p,
              const unsigned int component = 0) const override;
 
    virtual void
    vector_laplacian(
      const Point<dim>                        &p,
      Vector<typename VectorType::value_type> &values) const override;
 
    virtual void
    laplacian_list(const std::vector<Point<dim>>                &points,
                   std::vector<typename VectorType::value_type> &values,
                   const unsigned int component = 0) const override;
 
    virtual void
    vector_laplacian_list(const std::vector<Point<dim>> &points,
                          std::vector<Vector<typename VectorType::value_type>>
                            &values) const override;
 
    unsigned int
    compute_point_locations(
      const std::vector<Point<dim>> &points,
      std::vector<typename DoFHandler<dim, spacedim>::active_cell_iterator>
                                             &cells,
      std::vector<std::vector<Point<dim>>>   &qpoints,
      std::vector<std::vector<unsigned int>> &maps) const;
 
  private:
    using cell_hint_t = Threads::ThreadLocalStorage<
      typename DoFHandler<dim, spacedim>::active_cell_iterator>;
 
    ObserverPointer<const DoFHandler<dim, spacedim>,
                    FEFieldFunction<dim, VectorType, spacedim>>
      dh;
 
    const VectorType &data_vector;
 
    const Mapping<dim> &mapping;
 
    GridTools::Cache<dim, spacedim> cache;
 
    mutable cell_hint_t cell_hint;
 
    std::optional<Point<dim>>
    get_reference_coordinates(
      const typename DoFHandler<dim, spacedim>::active_cell_iterator &cell,
      const Point<dim> &point) const;
  };
} // namespace Functions
 
 
DEAL_II_NAMESPACE_CLOSE
 
#endif