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

Inheritance diagram for Functions::JumpFunction< dim >:

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

Public Member Functions
	JumpFunction (const Point< dim > &direction, const double steepness)

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

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

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

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

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

virtual void	laplacian_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

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_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, RangeNumberType > > &gradients, const unsigned int component=0) const

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

virtual void	vector_gradient_list (const std::vector< Point< dim > > &points, std::vector< std::vector< Tensor< 1, dim, RangeNumberType > > > &gradients) 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)

Public Attributes
const unsigned int	n_components

Static Public Attributes
static constexpr unsigned int	dimension = dim

Protected Attributes
const Point< dim >	direction

const double	steepness

double	angle

double	sine

double	cosine

Private Attributes
Number	time

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

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

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

using	map_value_type = decltype(counter_map)::value_type

using	map_iterator = decltype(counter_map)::iterator

static std::mutex	mutex

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>
class Functions::JumpFunction< dim >

A jump in x-direction transported into some direction.

If the advection is parallel to the y-axis, the function is -atan(sx), where s is the steepness parameter provided in the constructor.

For different advection directions, this function will be turned in the parameter space.

Together with the function, its derivatives and Laplacian are defined.

Definition at line 609 of file function_lib.h.

Member Typedef Documentation

◆ time_type

template<int dim, typename RangeNumberType = double>

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

inherited

The scalar-valued real type used for representing time.

Definition at line 169 of file function.h.

Constructor & Destructor Documentation

◆ JumpFunction()

template<int dim>

Functions::JumpFunction< dim >::JumpFunction	(	const Point< dim > &	direction,
		const double	steepness
	)

Constructor. Provide the advection direction here and the steepness of the slope.

Definition at line 1803 of file function_lib.cc.

Member Function Documentation

◆ value()

template<int dim>

double Functions::JumpFunction< dim >::value	(	const Point< dim > &	p,
		const unsigned int	component = `0`
	)		const

overridevirtual

Function value at one point.

Reimplemented from Function< dim, RangeNumberType >.

Definition at line 1827 of file function_lib.cc.

◆ value_list() [1/2]

template<int dim>

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

overridevirtual

Function values at multiple points.

Definition at line 1837 of file function_lib.cc.

◆ gradient()

template<int dim>

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

overridevirtual

Gradient at one point.

Reimplemented from Function< dim, RangeNumberType >.

Definition at line 1885 of file function_lib.cc.

◆ gradient_list() [1/2]

template<int dim>

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

overridevirtual

Gradients at multiple points.

Definition at line 1899 of file function_lib.cc.

◆ laplacian()

template<int dim>

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

overridevirtual

Laplacian of the function at one point.

Reimplemented from Function< dim, RangeNumberType >.

Definition at line 1854 of file function_lib.cc.

◆ laplacian_list() [1/2]

template<int dim>

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

overridevirtual

Laplacian of the function at multiple points.

Definition at line 1864 of file function_lib.cc.

◆ memory_consumption()

template<int dim>

std::size_t Functions::JumpFunction< dim >::memory_consumption

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 1919 of file function_lib.cc.

◆ vector_value()

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.

Reimplemented in Functions::ConstantFunction< dim, RangeNumberType >, ComponentSelectFunction< dim, RangeNumberType >, VectorFunctionFromScalarFunctionObject< dim, RangeNumberType >, VectorFunctionFromTensorFunction< dim, RangeNumberType >, Functions::IncrementalFunction< dim, RangeNumberType >, and Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ 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.

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

◆ 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.

Reimplemented in Functions::ConstantFunction< dim, RangeNumberType >, VectorFunctionFromTensorFunction< dim, RangeNumberType >, ComponentSelectFunction< dim, RangeNumberType >, and Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ 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.

◆ vector_gradient()

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.

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

◆ 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.

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

◆ vector_gradients()

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.

◆ vector_gradient_list()

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.

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

◆ 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() [2/2]

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.

Reimplemented in Functions::SignedDistance::Plane< dim >, Functions::IdentityFunction< dim, RangeNumberType >, Functions::CSpline< dim >, Functions::CosineFunction< dim >, Functions::Spherical< dim >, Functions::SymbolicFunction< dim, RangeNumberType >, Functions::CoordinateRestriction< dim >, Functions::ConstantFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, double >, Functions::SignedDistance::Sphere< dim >, and NonMatching::internal::DiscreteQuadratureGeneratorImplementation::RefSpaceFEFieldFunction< dim, VectorType >.

◆ 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.

◆ advance_time()

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.

Member Data Documentation

◆ direction

template<int dim>

const Point<dim> Functions::JumpFunction< dim >::direction

protected

Advection vector.

Definition at line 675 of file function_lib.h.

◆ steepness

template<int dim>

const double Functions::JumpFunction< dim >::steepness

protected

Steepness (maximal derivative) of the slope.

Definition at line 680 of file function_lib.h.

◆ angle

template<int dim>

double Functions::JumpFunction< dim >::angle

protected

Advection angle.

Definition at line 685 of file function_lib.h.

◆ sine

template<int dim>

double Functions::JumpFunction< dim >::sine

protected

Sine of angle.

Definition at line 690 of file function_lib.h.

◆ cosine

template<int dim>

double Functions::JumpFunction< dim >::cosine

protected

Cosine of angle.

Definition at line 695 of file function_lib.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 159 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 164 of file function.h.

◆ time

template<typename Number = double>

Number FunctionTime< Number >::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/function_lib.h
source/base/function_lib.cc

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Private Attributes

Subscriptor functionality

Detailed Description

Member Typedef Documentation

◆ time_type

Constructor & Destructor Documentation

◆ JumpFunction()

Member Function Documentation

◆ value()

◆ value_list() [1/2]

◆ gradient()

◆ gradient_list() [1/2]

◆ laplacian()

◆ laplacian_list() [1/2]

◆ memory_consumption()

◆ vector_value()

◆ value_list() [2/2]

◆ vector_value_list()

◆ vector_values()

◆ vector_gradient()

◆ gradient_list() [2/2]

◆ vector_gradients()

◆ vector_gradient_list()

◆ vector_laplacian()

◆ laplacian_list() [2/2]

◆ vector_laplacian_list()

◆ hessian()

◆ vector_hessian()

◆ hessian_list()

◆ vector_hessian_list()

◆ get_time()

◆ set_time()

◆ advance_time()

Member Data Documentation

◆ direction

◆ steepness

◆ angle

◆ sine

◆ cosine

◆ dimension

◆ n_components

◆ time