function_derivative.h

Go to the documentation of this file.

// ------------------------------------------------------------------------
//
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2000 - 2023 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Part of the source code is dual licensed under Apache-2.0 WITH
// LLVM-exception OR LGPL-2.1-or-later. Detailed license information
// governing the source code and code contributions can be found in
// LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
//
// ------------------------------------------------------------------------
 
#ifndef dealii_function_derivative_h
#define dealii_function_derivative_h
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/auto_derivative_function.h>
#include <deal.II/base/exceptions.h>
#include <deal.II/base/function.h>
 
DEAL_II_NAMESPACE_OPEN
 
 
template <int dim>
class FunctionDerivative : public AutoDerivativeFunction<dim>
{
public:
  FunctionDerivative(const Function<dim> &f,
                     const Point<dim>    &direction,
                     const double         h = 1.e-6);
 
  FunctionDerivative(const Function<dim>           &f,
                     const std::vector<Point<dim>> &direction,
                     const double                   h = 1.e-6);
 
  void
  set_formula(typename AutoDerivativeFunction<dim>::DifferenceFormula formula =
                AutoDerivativeFunction<dim>::Euler);
  void
  set_h(const double h);
 
  virtual double
  value(const Point<dim> &p, const unsigned int component = 0) const override;
 
  virtual void
  vector_value(const Point<dim> &p, Vector<double> &value) const override;
 
  virtual void
  value_list(const std::vector<Point<dim>> &points,
             std::vector<double>           &values,
             const unsigned int             component = 0) const override;
 
  virtual std::size_t
  memory_consumption() const override;
 
private:
  const Function<dim> &f;
 
  double h;
 
  typename AutoDerivativeFunction<dim>::DifferenceFormula formula;
 
  std::vector<Tensor<1, dim>> incr;
};
 
DEAL_II_NAMESPACE_CLOSE
 
#endif