Functions::ZeroFunction< dim, RangeNumberType > Class Template Reference

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

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

Public Member Functions
	ZeroFunction (const unsigned int n_components=1)
Public Member Functions inherited from Functions::ConstantFunction< dim, double >
	ConstantFunction (const double value, const unsigned int n_components=1)
	ConstantFunction (const std::vector< double > &values)
	ConstantFunction (const Vector< double > &values)
	ConstantFunction (const double *begin_ptr, const unsigned int n_components)
virtual double	value (const Point< dim > &p, const unsigned int component=0) const override
virtual void	vector_value (const Point< dim > &p, Vector< double > &return_value) const override
virtual void	value_list (const std::vector< Point< dim >> &points, std::vector< double > &return_values, const unsigned int component=0) const override
virtual void	vector_value_list (const std::vector< Point< dim >> &points, std::vector< Vector< double >> &return_values) const override
virtual Tensor< 1, dim, double >	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, double >> &gradients) const override
virtual void	gradient_list (const std::vector< Point< dim >> &points, std::vector< Tensor< 1, dim, double >> &gradients, const unsigned int component=0) const override
virtual void	vector_gradient_list (const std::vector< Point< dim >> &points, std::vector< std::vector< Tensor< 1, dim, double >>> &gradients) const override
virtual SymmetricTensor< 2, dim, double >	hessian (const Point< dim > &point, const unsigned int component=0) const override
virtual double	laplacian (const Point< dim > &point, const unsigned int component=0) const override
std::size_t	memory_consumption () const
Public Member Functions inherited from Function< dim, double >
	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_values (const std::vector< Point< dim >> &points, std::vector< std::vector< double >> &values) const
virtual void	vector_gradients (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	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 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)

Additional Inherited Members
Public Types inherited from Function< dim, double >
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, double >
const unsigned int	n_components
Static Public Attributes inherited from Function< dim, double >
static const unsigned int	dimension
Protected Attributes inherited from Functions::ConstantFunction< dim, double >
std::vector< double >	function_value_vector

Detailed Description

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

Provide a function which always returns zero. Obviously, also the derivatives 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 513 of file function.h.

Constructor & Destructor Documentation

ZeroFunction()

template<int dim, typename RangeNumberType = double>

Functions::ZeroFunction< dim, RangeNumberType >::ZeroFunction

(

const unsigned int

n_components = 1

)

Constructor. The number of components is preset to one.

---

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

• include/deal.II/base/function.h