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

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

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

Public Member Functions
	ConstantFunction (const RangeNumberType value, const unsigned int n_components=1)
	ConstantFunction (const std::vector< RangeNumberType > &values)
	ConstantFunction (const Vector< RangeNumberType > &values)
	ConstantFunction (const RangeNumberType *begin_ptr, const unsigned int n_components)
virtual RangeNumberType	value (const Point< dim > &p, const unsigned int component=0) const override
virtual void	vector_value (const Point< dim > &p, Vector< RangeNumberType > &return_value) const override
virtual void	value_list (const std::vector< Point< dim >> &points, std::vector< RangeNumberType > &return_values, const unsigned int component=0) const override
virtual void	vector_value_list (const std::vector< Point< dim >> &points, std::vector< Vector< RangeNumberType >> &return_values) const override
virtual Tensor< 1, dim, RangeNumberType >	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, RangeNumberType >> &gradients) const override
virtual void	gradient_list (const std::vector< Point< dim >> &points, std::vector< Tensor< 1, dim, RangeNumberType >> &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, RangeNumberType >>> &gradients) const override
virtual SymmetricTensor< 2, dim, RangeNumberType >	hessian (const Point< dim > &point, const unsigned int component=0) const override
virtual RangeNumberType	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_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 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	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)

Protected Attributes
std::vector< RangeNumberType >	function_value_vector

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

Detailed Description

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

Provide a function which always returns the constant values handed to the constructor.

Author

Wolfgang Bangerth, 1998, 1999, Lei Qiao, 2015

Definition at line 412 of file function.h.

Constructor & Destructor Documentation

ConstantFunction() [1/4]

template<int dim, typename RangeNumberType = double>

Functions::ConstantFunction< dim, RangeNumberType >::ConstantFunction	(	const RangeNumberType	value,
		const unsigned int	n_components = 1
	)

Constructor; set values of all components to the provided one. The default number of components is one.

ConstantFunction() [2/4]

template<int dim, typename RangeNumberType = double>

Functions::ConstantFunction< dim, RangeNumberType >::ConstantFunction

(

const std::vector< RangeNumberType > &

values

)

Constructor; takes an std::vector<RangeNumberType> object as an argument. The number of components is determined by values.size().

ConstantFunction() [3/4]

template<int dim, typename RangeNumberType = double>

Functions::ConstantFunction< dim, RangeNumberType >::ConstantFunction

(

const Vector< RangeNumberType > &

values

)

Constructor; takes an Vector<RangeNumberType> object as an argument. The number of components is determined by values.size().

ConstantFunction() [4/4]

template<int dim, typename RangeNumberType = double>

Functions::ConstantFunction< dim, RangeNumberType >::ConstantFunction	(	const RangeNumberType *	begin_ptr,
		const unsigned int	n_components
	)

Constructor; uses whatever stores in [begin_ptr, begin_ptr+n_components) to initialize a new object.

Member Function Documentation

value()

template<int dim, typename RangeNumberType = double>

virtual RangeNumberType Functions::ConstantFunction< 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; it defaults to zero, i.e. the first component.

Reimplemented from Function< dim, double >.

vector_value()

template<int dim, typename RangeNumberType = double>

virtual void Functions::ConstantFunction< dim, RangeNumberType >::vector_value ( const Point< dim > &  p, Vector< RangeNumberType > &  return_value  ) const

overridevirtual

Reimplemented in ComponentSelectFunction< dim, RangeNumberType >.

value_list()

template<int dim, typename RangeNumberType = double>

virtual void Functions::ConstantFunction< dim, RangeNumberType >::value_list ( const std::vector< Point< dim >> &  points, std::vector< RangeNumberType > &  return_values, const unsigned int  component = 0  ) const

overridevirtual

vector_value_list()

template<int dim, typename RangeNumberType = double>

virtual void Functions::ConstantFunction< dim, RangeNumberType >::vector_value_list ( const std::vector< Point< dim >> &  points, std::vector< Vector< RangeNumberType >> &  return_values  ) const

overridevirtual

Reimplemented in ComponentSelectFunction< dim, RangeNumberType >.

gradient()

template<int dim, typename RangeNumberType = double>

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

overridevirtual

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

Reimplemented from Function< dim, double >.

vector_gradient()

template<int dim, typename RangeNumberType = double>

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

overridevirtual

gradient_list()

template<int dim, typename RangeNumberType = double>

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

overridevirtual

vector_gradient_list()

template<int dim, typename RangeNumberType = double>

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

overridevirtual

hessian()

template<int dim, typename RangeNumberType = double>

virtual SymmetricTensor<2, dim, RangeNumberType> Functions::ConstantFunction< dim, RangeNumberType >::hessian ( const Point< dim > &  p, const unsigned int  component = 0  ) const

overridevirtual

Compute the Hessian of a given component at point p, that is the gradient of the gradient of the function.

Reimplemented from Function< dim, double >.

laplacian()

template<int dim, typename RangeNumberType = double>

virtual RangeNumberType Functions::ConstantFunction< dim, RangeNumberType >::laplacian ( const Point< dim > &  p, const unsigned int  component = 0  ) const

overridevirtual

Compute the Laplacian of a given component at point p.

Reimplemented from Function< dim, double >.

memory_consumption()

template<int dim, typename RangeNumberType = double>

std::size_t Functions::ConstantFunction< dim, RangeNumberType >::memory_consumption

(

)

const

Member Data Documentation

function_value_vector

template<int dim, typename RangeNumberType = double>

std::vector<RangeNumberType> Functions::ConstantFunction< dim, RangeNumberType >::function_value_vector

protected

Store the constant function value vector.

Definition at line 495 of file function.h.

---

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

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