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

Inheritance diagram for ZeroFunction< dim, Number >:

Public Member Functions
	ZeroFunction (const unsigned int n_components=1)

virtual	~ZeroFunction ()

virtual Number	value (const Point< dim > &p, const unsigned int component) const

virtual void	vector_value (const Point< dim > &p, Vector< Number > &return_value) const

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

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

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

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

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

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

virtual	~Function ()=0

Function &	operator= (const Function &f)

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

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

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

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

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

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

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

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

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

std::size_t	memory_consumption () const

Public Member Functions inherited from FunctionTime< Number >
	FunctionTime (const Number initial_time=Number(0.0))

virtual	~FunctionTime ()

Number	get_time () const

virtual void	set_time (const Number new_time)

virtual void	advance_time (const Number delta_t)

Public Member Functions inherited from Subscriptor
	Subscriptor ()

	Subscriptor (const Subscriptor &)

	Subscriptor (Subscriptor &&)

virtual	~Subscriptor ()

Subscriptor &	operator= (const Subscriptor &)

Subscriptor &	operator= (Subscriptor &&)

void	subscribe (const char *identifier=0) const

void	unsubscribe (const char *identifier=0) const

unsigned int	n_subscriptions () const

void	list_subscribers () const

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

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

static ::ExceptionBase &	ExcNoSubscriber (char arg1, char arg2)

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

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

Detailed Description

template<int dim, typename Number = double>
class ZeroFunction< dim, Number >

Provide a function which always returns zero. Obviously, also the derivates of this function are zero. Also, it returns zero on all components in case the function is not a scalar one, which can be obtained by passing the constructor the appropriate number of components.

This function is of use when you want to implement homogeneous boundary conditions, or zero initial conditions.

Author: Wolfgang Bangerth, 1998, 1999

Definition at line 364 of file function.h.

Constructor & Destructor Documentation

◆ ZeroFunction()

template<int dim, typename Number = double>

ZeroFunction< dim, Number >::ZeroFunction ( const unsigned int n_components = 1 )

Constructor. The number of components is preset to one.

◆ ~ZeroFunction()

template<int dim, typename Number = double>

virtual ZeroFunction< dim, Number >::~ZeroFunction ( )

virtual

Virtual destructor; absolutely necessary in this case.

Member Function Documentation

◆ value()

template<int dim, typename Number = double>

virtual Number ZeroFunction< dim, Number >::value	(	const Point< dim > &	p,
		const unsigned int	component
	)		const

virtual

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, Number >.

Reimplemented in ConstantFunction< dim, Number >.

◆ vector_value()

template<int dim, typename Number = double>

virtual void ZeroFunction< dim, Number >::vector_value	(	const Point< dim > &	p,
		Vector< Number > &	values
	)		const

virtual

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 from Function< dim, Number >.

Reimplemented in ComponentSelectFunction< dim, Number >, and ConstantFunction< dim, Number >.

◆ value_list()

template<int dim, typename Number = double>

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

virtual

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 from Function< dim, Number >.

Reimplemented in ConstantFunction< dim, Number >.

◆ vector_value_list()

template<int dim, typename Number = double>

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

virtual

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 from Function< dim, Number >.

Reimplemented in ComponentSelectFunction< dim, Number >, and ConstantFunction< dim, Number >.

◆ gradient()

template<int dim, typename Number = double>

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

virtual

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

Reimplemented from Function< dim, Number >.

◆ vector_gradient()

template<int dim, typename Number = double>

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

virtual

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

Reimplemented from Function< dim, Number >.

◆ gradient_list()

template<int dim, typename Number = double>

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

virtual

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 from Function< dim, Number >.

◆ vector_gradient_list()

template<int dim, typename Number = double>

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

virtual

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 from Function< dim, Number >.

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

deal.II/base/function.h

Public Member Functions

Additional Inherited Members

Detailed Description

template<int dim, typename Number = double> class ZeroFunction< dim, Number >

Constructor & Destructor Documentation

◆ ZeroFunction()

◆ ~ZeroFunction()

Member Function Documentation

◆ value()

◆ vector_value()

◆ value_list()

◆ vector_value_list()

◆ gradient()

◆ vector_gradient()

◆ gradient_list()

◆ vector_gradient_list()

template<int dim, typename Number = double>
class ZeroFunction< dim, Number >