deal.II version GIT relicensing-1834-gcb0191c2bf 2024-09-10 15:10:00+00:00
Searching...
No Matches
FunctionDerivative< dim > Class Template Reference

#include <deal.II/base/function_derivative.h>

Inheritance diagram for FunctionDerivative< dim >:
[legend]

## Public Types

enum  DifferenceFormula { Euler , UpwindEuler , FourthOrder }

using time_type = typename FunctionTime< typename numbers::NumberTraits< RangeNumberType >::real_type >::time_type

## Public Member Functions

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

void set_formula (const DifferenceFormula formula=Euler)

virtual Tensor< 1, dim > gradient (const Point< dim > &p, const unsigned int component=0) const override

virtual void vector_gradient (const Point< dim > &p, std::vector< Tensor< 1, dim > > &gradients) const override

virtual void vector_gradient (const Point< dim > &p, std::vector< Tensor< 1, dim, RangeNumberType > > &gradients) const

virtual void gradient_list (const std::vector< Point< dim > > &points, std::vector< Tensor< 1, dim > > &gradients, const unsigned int component=0) const override

virtual void gradient_list (const std::vector< Point< dim > > &points, std::vector< Tensor< 1, dim, RangeNumberType > > &gradients, const unsigned int component=0) const

virtual void vector_gradient_list (const std::vector< Point< dim > > &points, std::vector< std::vector< Tensor< 1, dim > > > &gradients) const override

virtual void vector_gradient_list (const std::vector< Point< dim > > &points, std::vector< std::vector< Tensor< 1, dim, RangeNumberType > > > &gradients) const

virtual void vector_value (const Point< dim > &p, Vector< RangeNumberType > &values) const

virtual void value_list (const std::vector< Point< dim > > &points, std::vector< RangeNumberType > &values, const unsigned int component=0) const

virtual void vector_value_list (const std::vector< Point< dim > > &points, std::vector< Vector< RangeNumberType > > &values) const

virtual void vector_values (const std::vector< Point< dim > > &points, std::vector< std::vector< RangeNumberType > > &values) const

virtual void vector_gradients (const std::vector< Point< dim > > &points, std::vector< std::vector< Tensor< 1, dim, RangeNumberType > > > &gradients) const

virtual RangeNumberType laplacian (const Point< dim > &p, const unsigned int component=0) const

virtual void vector_laplacian (const Point< dim > &p, Vector< RangeNumberType > &values) const

virtual void laplacian_list (const std::vector< Point< dim > > &points, std::vector< RangeNumberType > &values, const unsigned int component=0) const

virtual void vector_laplacian_list (const std::vector< Point< dim > > &points, std::vector< Vector< RangeNumberType > > &values) const

virtual SymmetricTensor< 2, dim, RangeNumberType > hessian (const Point< dim > &p, const unsigned int component=0) const

virtual void vector_hessian (const Point< dim > &p, std::vector< SymmetricTensor< 2, dim, RangeNumberType > > &values) const

virtual void hessian_list (const std::vector< Point< dim > > &points, std::vector< SymmetricTensor< 2, dim, RangeNumberType > > &values, const unsigned int component=0) const

virtual void vector_hessian_list (const std::vector< Point< dim > > &points, std::vector< std::vector< SymmetricTensor< 2, dim, RangeNumberType > > > &values) const

Number get_time () const

virtual void set_time (const Number new_time)

virtual void advance_time (const Number delta_t)

template<class Archive >
void serialize (Archive &ar, const unsigned int version)

Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

void subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

void unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

unsigned int n_subscriptions () const

template<typename StreamType >
void list_subscribers (StreamType &stream) const

void list_subscribers () const

## Static Public Member Functions

static DifferenceFormula get_formula_of_order (const unsigned int ord)

static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)

## Public Attributes

const unsigned int n_components

## Static Public Attributes

static constexpr unsigned int dimension = dim

## Private Types

using map_value_type = decltype(counter_map)::value_type

using map_iterator = decltype(counter_map)::iterator

## Private Member Functions

void check_no_subscribers () const noexcept

## Private Attributes

const Function< dim > & f

double h

AutoDerivativeFunction< dim >::DifferenceFormula formula

std::vector< Tensor< 1, dim > > incr

std::vector< Tensor< 1, dim > > ht

Number time

std::atomic< unsigned intcounter

std::map< std::string, unsigned intcounter_map

std::vector< std::atomic< bool > * > validity_pointers

const std::type_info * object_info

## Static Private Attributes

static std::mutex mutex

## Detailed Description

template<int dim>
class FunctionDerivative< dim >

Derivative of a function object. The value access functions of this class return the directional derivative of a function with respect to a direction provided on construction. If b is the vector, the derivative b . grad f is computed. This derivative is evaluated directly, not by computing the gradient of f and its scalar product with b.

The derivative is computed numerically, using one of the provided difference formulas (see set_formula for available schemes). Experimenting with h and the difference scheme may be necessary to obtain sufficient results.

Definition at line 43 of file function_derivative.h.

## ◆ time_type

template<int dim, typename RangeNumberType = double>
 using Function< dim, RangeNumberType >::time_type = typename FunctionTime< typename numbers::NumberTraits::real_type>::time_type
inherited

The scalar-valued real type used for representing time.

Definition at line 168 of file function.h.

## ◆ map_value_type

 using Subscriptor::map_value_type = decltype(counter_map)::value_type
privateinherited

The data type used in counter_map.

Definition at line 229 of file subscriptor.h.

## ◆ map_iterator

 using Subscriptor::map_iterator = decltype(counter_map)::iterator
privateinherited

The iterator type used in counter_map.

Definition at line 234 of file subscriptor.h.

## ◆ DifferenceFormula

template<int dim>
 inherited

Names of difference formulas.

Enumerator
Euler

The symmetric Euler formula of second order:

$u'(t) \approx \frac{u(t+h) - u(t-h)}{2h}.$

UpwindEuler

The upwind Euler formula of first order:

$u'(t) \approx \frac{u(t) - u(t-h)}{h}.$

FourthOrder

The fourth order scheme

$u'(t) \approx \frac{u(t-2h) - 8u(t-h) + 8u(t+h) - u(t+2h)}{12h}.$

Definition at line 87 of file auto_derivative_function.h.

## ◆ FunctionDerivative() [1/2]

template<int dim>
 FunctionDerivative< dim >::FunctionDerivative ( const Function< dim > & f, const Point< dim > & direction, const double h = 1.e-6 )

Constructor. Provided are the functions to compute derivatives of, the direction vector of the differentiation and the step size h of the difference formula.

Definition at line 25 of file function_derivative.cc.

## ◆ FunctionDerivative() [2/2]

template<int dim>
 FunctionDerivative< dim >::FunctionDerivative ( const Function< dim > & f, const std::vector< Point< dim > > & direction, const double h = 1.e-6 )

Constructor. Provided are the functions to compute derivatives of and the direction vector of the differentiation in each quadrature point and the difference step size.

This is the constructor for a variable velocity field. Most probably, a new object of FunctionDerivative has to be constructed for each set of quadrature points.

The number of quadrature point must still be the same, when values are accessed.

Definition at line 39 of file function_derivative.cc.

## ◆ set_formula() [1/2]

template<int dim>
 void FunctionDerivative< dim >::set_formula ( typename AutoDerivativeFunction< dim >::DifferenceFormula formula = AutoDerivativeFunction::Euler )

Choose the difference formula. This is set to the default in the constructor.

Formulas implemented right now are first order backward Euler (UpwindEuler), second order symmetric Euler (Euler) and a symmetric fourth order formula (FourthOrder).

Definition at line 56 of file function_derivative.cc.

## ◆ set_h()

template<int dim>
 void FunctionDerivative< dim >::set_h ( const double h )

Change the base step size of the difference formula

Definition at line 80 of file function_derivative.cc.

## ◆ value()

template<int dim>
 double FunctionDerivative< dim >::value ( const Point< dim > & p, const unsigned int component = 0 ) const
overridevirtual

Return the value of the function at the given point. Unless there is only one component (i.e. the function is scalar), you should state the component you want to have evaluated; it defaults to zero, i.e. the first component.

Reimplemented from Function< dim, RangeNumberType >.

Definition at line 91 of file function_derivative.cc.

## ◆ vector_value() [1/2]

template<int dim>
 void FunctionDerivative< dim >::vector_value ( const Point< dim > & p, Vector< double > & value ) const
overridevirtual

Definition at line 122 of file function_derivative.cc.

## ◆ value_list() [1/2]

template<int dim>
 void FunctionDerivative< dim >::value_list ( const std::vector< Point< dim > > & points, std::vector< double > & values, const unsigned int component = 0 ) const
overridevirtual

Definition at line 164 of file function_derivative.cc.

## ◆ memory_consumption()

template<int dim>
 std::size_t FunctionDerivative< dim >::memory_consumption ( ) const
overridevirtual

Return an estimate for the memory consumption, in bytes, of this object. This is not exact (but will usually be close) because calculating the memory usage of trees (e.g., std::map) is difficult.

Reimplemented from Function< dim, RangeNumberType >.

Definition at line 230 of file function_derivative.cc.

## ◆ set_formula() [2/2]

template<int dim>
 void AutoDerivativeFunction< dim >::set_formula ( const DifferenceFormula formula = Euler )
inherited

Choose the difference formula. See the enum DifferenceFormula for available choices.

Definition at line 42 of file auto_derivative_function.cc.

template<int dim>
 Tensor< 1, dim > AutoDerivativeFunction< dim >::gradient ( const Point< dim > & p, const unsigned int component = 0 ) const
overridevirtualinherited

Return the gradient of the specified component of the function at the given point.

Compute numerical difference quotients using the preset DifferenceFormula.

Reimplemented from Function< dim, RangeNumberType >.

Definition at line 74 of file auto_derivative_function.cc.

## ◆ vector_gradient() [1/2]

template<int dim>
 void AutoDerivativeFunction< dim >::vector_gradient ( const Point< dim > & p, std::vector< Tensor< 1, dim > > & gradients ) const
overridevirtualinherited

Return the gradient of all components of the function at the given point.

Compute numerical difference quotients using the preset DifferenceFormula.

Definition at line 126 of file auto_derivative_function.cc.

## ◆ vector_gradient() [2/2]

template<int dim, typename RangeNumberType = double>
 virtual void Function< dim, RangeNumberType >::vector_gradient ( const Point< dim > & p, std::vector< Tensor< 1, dim, RangeNumberType > > & gradients ) const
virtualinherited

Return the gradient of all components of the function at the given point.

## ◆ gradient_list() [1/2]

template<int dim>
 void AutoDerivativeFunction< dim >::gradient_list ( const std::vector< Point< dim > > & points, std::vector< Tensor< 1, dim > > & gradients, const unsigned int component = 0 ) const
overridevirtualinherited

Set gradients to the gradients of the specified component of the function at the points. It is assumed that gradients already has the right size, i.e. the same size as the points array.

Compute numerical difference quotients using the preset DifferenceFormula.

Definition at line 203 of file auto_derivative_function.cc.

## ◆ gradient_list() [2/2]

template<int dim, typename RangeNumberType = double>
 virtual void Function< dim, RangeNumberType >::gradient_list ( const std::vector< Point< dim > > & points, std::vector< Tensor< 1, dim, RangeNumberType > > & gradients, const unsigned int component = 0 ) const
virtualinherited

Set gradients to the gradients of the specified component of the function at the points. It is assumed that gradients already has the right size, i.e. the same size as the points array.

## ◆ vector_gradient_list() [1/2]

template<int dim>
 void AutoDerivativeFunction< dim >::vector_gradient_list ( const std::vector< Point< dim > > & points, std::vector< std::vector< Tensor< 1, dim > > > & gradients ) const
overridevirtualinherited

Set gradients to the gradients of the function at the points, for all components. It is assumed that gradients already has the right size, i.e. the same size as the points array.

The outer loop over gradients is over the points in the list, the inner loop over the different components of the function.

Compute numerical difference quotients using the preset DifferenceFormula.

Definition at line 267 of file auto_derivative_function.cc.

## ◆ vector_gradient_list() [2/2]

template<int dim, typename RangeNumberType = double>
 virtual void Function< dim, RangeNumberType >::vector_gradient_list ( const std::vector< Point< dim > > & points, std::vector< std::vector< Tensor< 1, dim, RangeNumberType > > > & gradients ) const
virtualinherited

Set gradients to the gradients of the function at the points, for all components. It is assumed that gradients already has the right size, i.e. the same size as the points array.

The outer loop over gradients is over the points in the list, the inner loop over the different components of the function.

## ◆ get_formula_of_order()

template<int dim>
 AutoDerivativeFunction< dim >::DifferenceFormula AutoDerivativeFunction< dim >::get_formula_of_order ( const unsigned int ord )
staticinherited

Return a DifferenceFormula of the order ord at minimum.

Definition at line 335 of file auto_derivative_function.cc.

## ◆ vector_value() [2/2]

template<int dim, typename RangeNumberType = double>
 virtual void Function< dim, RangeNumberType >::vector_value ( const Point< dim > & p, Vector< RangeNumberType > & values ) const
virtualinherited

Return all components of a vector-valued function at a given point.

values shall have the right size beforehand, i.e. n_components.

The default implementation will call value() for each component.

## ◆ value_list() [2/2]

template<int dim, typename RangeNumberType = double>
 virtual void Function< dim, RangeNumberType >::value_list ( const std::vector< Point< dim > > & points, std::vector< RangeNumberType > & values, const unsigned int component = 0 ) const
virtualinherited

Set values to the point values of the specified component of the function at the points. It is assumed that values already has the right size, i.e. the same size as the points array.

By default, this function repeatedly calls value() for each point separately, to fill the output array.

## ◆ vector_value_list()

template<int dim, typename RangeNumberType = double>
 virtual void Function< dim, RangeNumberType >::vector_value_list ( const std::vector< Point< dim > > & points, std::vector< Vector< RangeNumberType > > & values ) const
virtualinherited

Set values to the point values of the function at the points. It is assumed that values already has the right size, i.e. the same size as the points array, and that all elements be vectors with the same number of components as this function has.

By default, this function repeatedly calls vector_value() for each point separately, to fill the output array.

## ◆ vector_values()

template<int dim, typename RangeNumberType = double>
 virtual void Function< dim, RangeNumberType >::vector_values ( const std::vector< Point< dim > > & points, std::vector< std::vector< RangeNumberType > > & values ) const
virtualinherited

For each component of the function, fill a vector of values, one for each point.

The default implementation of this function in Function calls value_list() for each component. In order to improve performance, this can be reimplemented in derived classes to speed up performance.

template<int dim, typename RangeNumberType = double>
 virtual void Function< dim, RangeNumberType >::vector_gradients ( const std::vector< Point< dim > > & points, std::vector< std::vector< Tensor< 1, dim, RangeNumberType > > > & gradients ) const
virtualinherited

For each component of the function, fill a vector of gradient values, one for each point.

The default implementation of this function in Function calls value_list() for each component. In order to improve performance, this can be reimplemented in derived classes to speed up performance.

Reimplemented in VectorFunctionFromTensorFunction< dim, RangeNumberType >.

## ◆ laplacian()

template<int dim, typename RangeNumberType = double>
 virtual RangeNumberType Function< dim, RangeNumberType >::laplacian ( const Point< dim > & p, const unsigned int component = 0 ) const
virtualinherited

## ◆ vector_laplacian()

template<int dim, typename RangeNumberType = double>
 virtual void Function< dim, RangeNumberType >::vector_laplacian ( const Point< dim > & p, Vector< RangeNumberType > & values ) const
virtualinherited

Compute the Laplacian of all components at point p and store them in values.

Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >.

## ◆ laplacian_list()

template<int dim, typename RangeNumberType = double>
 virtual void Function< dim, RangeNumberType >::laplacian_list ( const std::vector< Point< dim > > & points, std::vector< RangeNumberType > & values, const unsigned int component = 0 ) const
virtualinherited

Compute the Laplacian of one component at a set of points.

Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >.

## ◆ vector_laplacian_list()

template<int dim, typename RangeNumberType = double>
 virtual void Function< dim, RangeNumberType >::vector_laplacian_list ( const std::vector< Point< dim > > & points, std::vector< Vector< RangeNumberType > > & values ) const
virtualinherited

Compute the Laplacians of all components at a set of points.

Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >.

## ◆ hessian()

template<int dim, typename RangeNumberType = double>
 virtual SymmetricTensor< 2, dim, RangeNumberType > Function< dim, RangeNumberType >::hessian ( const Point< dim > & p, const unsigned int component = 0 ) const
virtualinherited

Compute the Hessian of a given component at point p, that is the gradient of the gradient of the function.

## ◆ vector_hessian()

template<int dim, typename RangeNumberType = double>
 virtual void Function< dim, RangeNumberType >::vector_hessian ( const Point< dim > & p, std::vector< SymmetricTensor< 2, dim, RangeNumberType > > & values ) const
virtualinherited

Compute the Hessian of all components at point p and store them in values.

## ◆ hessian_list()

template<int dim, typename RangeNumberType = double>
 virtual void Function< dim, RangeNumberType >::hessian_list ( const std::vector< Point< dim > > & points, std::vector< SymmetricTensor< 2, dim, RangeNumberType > > & values, const unsigned int component = 0 ) const
virtualinherited

Compute the Hessian of one component at a set of points.

## ◆ vector_hessian_list()

template<int dim, typename RangeNumberType = double>
 virtual void Function< dim, RangeNumberType >::vector_hessian_list ( const std::vector< Point< dim > > & points, std::vector< std::vector< SymmetricTensor< 2, dim, RangeNumberType > > > & values ) const
virtualinherited

Compute the Hessians of all components at a set of points.

## ◆ get_time()

template<typename Number = double>
 Number FunctionTime< Number >::get_time ( ) const
inherited

Return the value of the time variable.

## ◆ set_time()

template<typename Number = double>
 virtual void FunctionTime< Number >::set_time ( const Number new_time )
virtualinherited

Set the time to new_time, overwriting the old value.

template<typename Number = double>
 virtual void FunctionTime< Number >::advance_time ( const Number delta_t )
virtualinherited

Advance the time by the given time step delta_t.

## ◆ subscribe()

 void Subscriptor::subscribe ( std::atomic< bool > *const validity, const std::string & identifier = "" ) const
inherited

Subscribes a user of the object by storing the pointer validity. The subscriber may be identified by text supplied as identifier.

Definition at line 130 of file subscriptor.cc.

## ◆ unsubscribe()

 void Subscriptor::unsubscribe ( std::atomic< bool > *const validity, const std::string & identifier = "" ) const
inherited

Unsubscribes a user from the object.

Note
The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 150 of file subscriptor.cc.

## ◆ n_subscriptions()

 unsigned int Subscriptor::n_subscriptions ( ) const
inlineinherited

Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.

Definition at line 300 of file subscriptor.h.

## ◆ list_subscribers() [1/2]

template<typename StreamType >
 void Subscriptor::list_subscribers ( StreamType & stream ) const
inlineinherited

List the subscribers to the input stream.

Definition at line 317 of file subscriptor.h.

## ◆ list_subscribers() [2/2]

 void Subscriptor::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 198 of file subscriptor.cc.

## ◆ serialize()

template<class Archive >
 void Subscriptor::serialize ( Archive & ar, const unsigned int version )
inlineinherited

Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.

Definition at line 309 of file subscriptor.h.

## ◆ check_no_subscribers()

 void Subscriptor::check_no_subscribers ( ) const
privatenoexceptinherited

Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.

Note
Since this function is just a consistency check it does nothing in release mode.
If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.

Definition at line 52 of file subscriptor.cc.

## ◆ f

template<int dim>
 const Function& FunctionDerivative< dim >::f
private

Function for differentiation.

Definition at line 111 of file function_derivative.h.

## ◆ h

template<int dim>
 double FunctionDerivative< dim >::h
private

Step size of the difference formula.

Definition at line 116 of file function_derivative.h.

## ◆ formula

template<int dim>
 AutoDerivativeFunction::DifferenceFormula FunctionDerivative< dim >::formula
private

Difference formula.

Definition at line 121 of file function_derivative.h.

## ◆ incr

template<int dim>
 std::vector > FunctionDerivative< dim >::incr
private

Helper object. Contains the increment vector for the formula.

Definition at line 126 of file function_derivative.h.

## ◆ ht

template<int dim>
 std::vector > AutoDerivativeFunction< dim >::ht
privateinherited

Includes the unit vectors scaled by h.

Definition at line 227 of file auto_derivative_function.h.

## ◆ dimension

template<int dim, typename RangeNumberType = double>
 constexpr unsigned int Function< dim, RangeNumberType >::dimension = dim
staticconstexprinherited

Export the value of the template parameter as a static member constant. Sometimes useful for some expression template programming.

Definition at line 158 of file function.h.

## ◆ n_components

template<int dim, typename RangeNumberType = double>
 const unsigned int Function< dim, RangeNumberType >::n_components
inherited

Number of vector components.

Definition at line 163 of file function.h.

## ◆ time

template<typename Number = double>
 Number FunctionTime< Number >::time
privateinherited

Store the present time.

Definition at line 112 of file function_time.h.

## ◆ counter

 std::atomic Subscriptor::counter
mutableprivateinherited

Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).

The creator (and owner) of an object is counted in the map below if HE manages to supply identification.

We use the mutable keyword in order to allow subscription to constant objects also.

This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic class template.

Definition at line 218 of file subscriptor.h.

## ◆ counter_map

 std::map Subscriptor::counter_map
mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 224 of file subscriptor.h.

## ◆ validity_pointers

 std::vector *> Subscriptor::validity_pointers
mutableprivateinherited

In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.

Definition at line 240 of file subscriptor.h.

## ◆ object_info

 const std::type_info* Subscriptor::object_info
mutableprivateinherited

Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.

Definition at line 248 of file subscriptor.h.

## ◆ mutex

 std::mutex Subscriptor::mutex
staticprivateinherited

A mutex used to ensure data consistency when accessing the mutable members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers().

Definition at line 271 of file subscriptor.h.

The documentation for this class was generated from the following files: