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

Inheritance diagram for Functions::IncrementalFunction< dim, RangeNumberType >:

Public Types
using	time_type = typename Function< dim, RangeNumberType >::time_type

Public Member Functions
	IncrementalFunction (Function< dim, RangeNumberType > &base)

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

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

void	set_decrement (const time_type delta_t)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	hessian_list (const std::vector< Point< dim > > &points, std::vector< SymmetricTensor< 2, dim, double > > &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, double > > > &values) const

virtual std::size_t	memory_consumption () const

numbers::NumberTraits< double >::real_type	get_time () const

virtual void	set_time (const numbers::NumberTraits< double >::real_type new_time)

virtual void	advance_time (const numbers::NumberTraits< double >::real_type delta_t)

Public Attributes
const unsigned int	n_components

Static Public Attributes
static const unsigned int	dimension = dim

Private Attributes
Function< dim, RangeNumberType > &	base

time_type	delta_t

Vector< RangeNumberType >	values_old

Threads::Mutex	mutex

numbers::NumberTraits< double >::real_type	time

Subscriptor functionality
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.
std::atomic< unsigned int >	counter

std::map< std::string, unsigned int >	counter_map

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

const std::type_info *	object_info

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

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

using	map_value_type = decltype(counter_map)::value_type

using	map_iterator = decltype(counter_map)::iterator

static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

void	check_no_subscribers () const noexcept

Detailed Description

template<int dim, typename RangeNumberType = double>
class Functions::IncrementalFunction< dim, RangeNumberType >

This class represents an incremental function. That is, given an arbitrary function f, this class will return f(t) - f(t - delta_t), where f(t) denotes the function evaluated at time t and, likewise, f(t - delta_t) denotes the function evaluated at time t - delta_t. The decrement delta_t is set by the method set_decrement(). The main application of this class is to transform a given Dirichlet boundary condition function into incremental form, as is required by some implementations of non-linear solution schemes.

Definition at line 52 of file incremental_function.h.

Member Typedef Documentation

◆ time_type

template<int dim, typename RangeNumberType = double>

using Functions::IncrementalFunction< dim, RangeNumberType >::time_type = typename Function<dim, RangeNumberType>::time_type

The scalar-valued real type used for representing time.

Definition at line 64 of file incremental_function.h.

Constructor & Destructor Documentation

◆ IncrementalFunction()

template<int dim, typename RangeNumberType >

Functions::IncrementalFunction< dim, RangeNumberType >::IncrementalFunction ( Function< dim, RangeNumberType > & base )

Constructor which wraps a given function base.

Note: This class stores a non-constant reference to base and will call base.set_time() during evaluation in order to evaluate the base class at any arbitrary time. It is guaranteed that the temporal state of base is returned to its original settings after each function evaluation in this class.

Definition at line 26 of file incremental_function.cc.

Member Function Documentation

◆ value()

template<int dim, typename RangeNumberType >

RangeNumberType Functions::IncrementalFunction< dim, RangeNumberType >::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. By default, the value of the first component is computed.

Reimplemented from Function< dim, double >.

Definition at line 50 of file incremental_function.cc.

◆ vector_value() [1/2]

template<int dim, typename RangeNumberType >

void Functions::IncrementalFunction< dim, RangeNumberType >::vector_value	(	const Point< dim > &	p,
		Vector< RangeNumberType > &	values
	)		const

overridevirtual

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

It is required that the values vector have the correct size before this function is called.

Definition at line 79 of file incremental_function.cc.

◆ set_decrement()

template<int dim, typename RangeNumberType >

void Functions::IncrementalFunction< dim, RangeNumberType >::set_decrement ( const time_type delta_t )

Set the time decrement.

It is expected that this value be positive.

Definition at line 38 of file incremental_function.cc.

◆ vector_value() [2/2]

virtual void Function< dim, double >::vector_value	(	const Point< dim > &	p,
		Vector< double > &	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.

Reimplemented in Functions::ConstantFunction< dim, double >.

◆ value_list()

virtual void Function< dim, double >::value_list	(	const std::vector< Point< dim > > &	points,
		std::vector< double > &	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.

Reimplemented in Functions::ConstantFunction< dim, double >.

◆ vector_value_list()

virtual void Function< dim, double >::vector_value_list	(	const std::vector< Point< dim > > &	points,
		std::vector< Vector< double > > &	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.

Reimplemented in Functions::ConstantFunction< dim, double >.

◆ vector_values()

virtual void Function< dim, double >::vector_values	(	const std::vector< Point< dim > > &	points,
		std::vector< std::vector< double > > &	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.

◆ gradient()

virtual Tensor< 1, dim, double > Function< dim, double >::gradient	(	const Point< dim > &	p,
		const unsigned int	component = `0`
	)		const

virtualinherited

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

Reimplemented in Functions::ConstantFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, double >, Functions::IdentityFunction< dim, RangeNumberType >, FunctionFromFunctionObjects< dim, RangeNumberType >, Functions::Monomial< dim, Number >, and Functions::SymbolicFunction< dim, RangeNumberType >.

◆ vector_gradient()

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

virtualinherited

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

Reimplemented in Functions::ConstantFunction< dim, double >.

◆ gradient_list()

virtual void Function< dim, double >::gradient_list	(	const std::vector< Point< dim > > &	points,
		std::vector< Tensor< 1, dim, double > > &	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.

Reimplemented in Functions::ConstantFunction< dim, double >.

◆ vector_gradients()

virtual void Function< dim, double >::vector_gradients	(	const std::vector< Point< dim > > &	points,
		std::vector< std::vector< Tensor< 1, dim, double > > > &	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.

◆ vector_gradient_list()

virtual void Function< dim, double >::vector_gradient_list	(	const std::vector< Point< dim > > &	points,
		std::vector< std::vector< Tensor< 1, dim, double > > > &	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.

Reimplemented in Functions::ConstantFunction< dim, double >.

◆ laplacian()

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

virtualinherited

Compute the Laplacian of a given component at point p.

Reimplemented in Functions::IdentityFunction< dim, RangeNumberType >, Functions::SymbolicFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, RangeNumberType >, and Functions::ConstantFunction< dim, double >.

◆ vector_laplacian()

virtual void Function< dim, double >::vector_laplacian	(	const Point< dim > &	p,
		Vector< double > &	values
	)		const

virtualinherited

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

◆ laplacian_list()

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

virtualinherited

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

◆ vector_laplacian_list()

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

virtualinherited

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

◆ hessian()

virtual SymmetricTensor< 2, dim, double > Function< dim, double >::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.

Reimplemented in Functions::IdentityFunction< dim, RangeNumberType >, Functions::SymbolicFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, RangeNumberType >, and Functions::ConstantFunction< dim, double >.

◆ vector_hessian()

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

virtualinherited

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

◆ hessian_list()

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

virtualinherited

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

◆ vector_hessian_list()

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

virtualinherited

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

◆ memory_consumption()

virtual std::size_t Function< dim, double >::memory_consumption ( ) const

virtualinherited

Return an estimate for the memory consumption, in bytes, of this object.

This function is virtual and can be overloaded by derived classes.

Reimplemented in Functions::ConstantFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, double >, and ComponentSelectFunction< dim, RangeNumberType >.

◆ get_time()

numbers::NumberTraits< double >::real_type FunctionTime< numbers::NumberTraits< double >::real_type >::get_time ( ) const

inherited

Return the value of the time variable.

◆ set_time()

virtual void FunctionTime< numbers::NumberTraits< double >::real_type >::set_time ( const numbers::NumberTraits< double >::real_type new_time )

virtualinherited

Set the time to new_time, overwriting the old value.

◆ advance_time()

virtual void FunctionTime< numbers::NumberTraits< double >::real_type >::advance_time ( const numbers::NumberTraits< double >::real_type delta_t )

virtualinherited

Advance the time by the given time step delta_t.

Member Data Documentation

◆ dimension

template<int dim, typename RangeNumberType = double>

const unsigned int Functions::IncrementalFunction< dim, RangeNumberType >::dimension = dim

static

Export the value of the template parameter as a static member constant. This is sometimes useful in the context of template programming.

Definition at line 59 of file incremental_function.h.

◆ base

template<int dim, typename RangeNumberType = double>

Function<dim, RangeNumberType>& Functions::IncrementalFunction< dim, RangeNumberType >::base

private

A reference to the function being wrapped.

Definition at line 110 of file incremental_function.h.

◆ delta_t

template<int dim, typename RangeNumberType = double>

time_type Functions::IncrementalFunction< dim, RangeNumberType >::delta_t

private

The time decrement.

Definition at line 115 of file incremental_function.h.

◆ values_old

template<int dim, typename RangeNumberType = double>

Vector<RangeNumberType> Functions::IncrementalFunction< dim, RangeNumberType >::values_old

mutableprivate

An auxiliary vector to store values.

Definition at line 120 of file incremental_function.h.

◆ mutex

template<int dim, typename RangeNumberType = double>

Threads::Mutex Functions::IncrementalFunction< dim, RangeNumberType >::mutex

mutableprivate

Thread mutex for supporting evaluation in multi-threaded contexts.

Definition at line 125 of file incremental_function.h.

◆ n_components

const unsigned int Function< dim, double >::n_components

inherited

Number of vector components.

Definition at line 164 of file function.h.

◆ time

numbers::NumberTraits< double >::real_type FunctionTime< numbers::NumberTraits< double >::real_type >::time

privateinherited

Store the present time.

Definition at line 113 of file function_time.h.

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

include/deal.II/base/incremental_function.h
source/base/incremental_function.cc

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Subscriptor functionality

Detailed Description

Member Typedef Documentation

◆ time_type

Constructor & Destructor Documentation

◆ IncrementalFunction()

Member Function Documentation

◆ value()

◆ vector_value() [1/2]

◆ set_decrement()

◆ vector_value() [2/2]

◆ value_list()

◆ vector_value_list()

◆ vector_values()

◆ gradient()

◆ vector_gradient()

◆ gradient_list()

◆ vector_gradients()

◆ vector_gradient_list()

◆ laplacian()

◆ vector_laplacian()

◆ laplacian_list()

◆ vector_laplacian_list()

◆ hessian()

◆ vector_hessian()

◆ hessian_list()

◆ vector_hessian_list()

◆ memory_consumption()

◆ get_time()

◆ set_time()

◆ advance_time()

Member Data Documentation

◆ dimension

◆ base

◆ delta_t

◆ values_old

◆ mutex

◆ n_components

◆ time