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

Inheritance diagram for Functions::JumpFunction< dim >:

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

std::size_t	memory_consumption () const

Public Member Functions inherited from Function< dim >
	Function (const unsigned int n_components=1, const time_type initial_time=0.0)

	Function (const Function &f)=default

virtual	~Function () override=0

Function &	operator= (const Function &f)

virtual void	vector_value (const Point< dim > &p, Vector< double > &values) 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 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 void	vector_laplacian (const Point< dim > &p, Vector< double > &values) 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

std::size_t	memory_consumption () const

Public Member Functions inherited from FunctionTime< numbers::NumberTraits< double >::real_type >
	FunctionTime (const numbers::NumberTraits< double >::real_type initial_time=numbers::NumberTraits< double >::real_type(0.0))

virtual	~FunctionTime ()=default

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 Member Functions inherited from Subscriptor
	Subscriptor ()

	Subscriptor (const Subscriptor &)

	Subscriptor (Subscriptor &&) noexcept

virtual	~Subscriptor ()

Subscriptor &	operator= (const Subscriptor &)

Subscriptor &	operator= (Subscriptor &&) noexcept

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)

Protected Attributes
const Point< dim >	direction

const double	steepness

double	angle

double	sine

double	cosine

Additional Inherited Members
Public Types inherited from Function< dim >
using	time_type = typename FunctionTime< typename numbers::NumberTraits< double >::real_type >::time_type

Public Types inherited from FunctionTime< numbers::NumberTraits< double >::real_type >
using	time_type = numbers::NumberTraits< double >::real_type

Static Public Member Functions inherited from Subscriptor
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

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

Public Attributes inherited from Function< dim >
const unsigned int	n_components

Static Public Attributes inherited from Function< dim >
static const unsigned int	dimension

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.

Author: : Guido Kanschat, 2000

Definition at line 603 of file function_lib.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 1793 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 >.

Definition at line 1817 of file function_lib.cc.

◆ value_list()

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.

Reimplemented from Function< dim >.

Definition at line 1827 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 >.

Definition at line 1875 of file function_lib.cc.

◆ gradient_list()

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

Definition at line 1844 of file function_lib.cc.

◆ laplacian_list()

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.

Reimplemented from Function< dim >.

Definition at line 1854 of file function_lib.cc.

◆ memory_consumption()

template<int dim>

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

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.

Definition at line 1909 of file function_lib.cc.

Member Data Documentation

◆ direction

template<int dim>

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

protected

Advection vector.

Definition at line 669 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 674 of file function_lib.h.

◆ angle

template<int dim>

double Functions::JumpFunction< dim >::angle

protected

Advection angle.

Definition at line 679 of file function_lib.h.

◆ sine

template<int dim>

double Functions::JumpFunction< dim >::sine

protected

Sine of angle.

Definition at line 684 of file function_lib.h.

◆ cosine

template<int dim>

double Functions::JumpFunction< dim >::cosine

protected

Cosine of angle.

Definition at line 689 of file function_lib.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 Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<int dim> class Functions::JumpFunction< dim >

Constructor & Destructor Documentation

◆ JumpFunction()

Member Function Documentation

◆ value()

◆ value_list()

◆ gradient()

◆ gradient_list()

◆ laplacian()

◆ laplacian_list()

◆ memory_consumption()

Member Data Documentation

◆ direction

◆ steepness

◆ angle

◆ sine

◆ cosine

template<int dim>
class Functions::JumpFunction< dim >