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

Inheritance diagram for Functions::CutOffFunctionBase< dim >:

Public Member Functions
	CutOffFunctionBase (const double radius=1., const Point< dim >=Point< dim >(), const unsigned int n_components=1, const unsigned int select=CutOffFunctionBase< dim >::no_component)

void	new_center (const Point< dim > &p)

void	new_radius (const double r)

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

virtual	~Function ()=0

Function &	operator= (const Function &f)

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

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 Tensor< 1, dim, double >	gradient (const Point< dim > &p, const unsigned int component=0) 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 double	laplacian (const Point< dim > &p, const unsigned int component=0) 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 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< Number >
	FunctionTime (const Number initial_time=Number(0.0))

virtual	~FunctionTime ()=default

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 &&) noexcept

virtual	~Subscriptor ()

Subscriptor &	operator= (const Subscriptor &)

Subscriptor &	operator= (Subscriptor &&) noexcept

void	subscribe (const char *identifier=nullptr) const

void	unsubscribe (const char *identifier=nullptr) const

unsigned int	n_subscriptions () const

void	list_subscribers () const

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

Static Public Attributes
static const unsigned int	no_component = numbers::invalid_unsigned_int

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

Protected Attributes
Point< dim >	center

double	radius

const unsigned int	selected

Additional Inherited Members
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

Detailed Description

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

Base function for cut-off function. This class stores the center and the radius of the supporting ball of a cut-off function. It also stores the number of the non-zero component, if the function is vector-valued.

Author: Guido Kanschat, 2002

Definition at line 836 of file function_lib.h.

Constructor & Destructor Documentation

◆ CutOffFunctionBase()

template<int dim>

Functions::CutOffFunctionBase< dim >::CutOffFunctionBase	(	const double	radius = `1.`,
		const Point< dim >	p = `Point<dim>()`,
		const unsigned int	n_components = `1`,
		const unsigned int	select = `CutOffFunctionBase<dim>::no_component`
	)

Constructor. Arguments are the center of the ball and its radius.

If an argument select is given and not -1, the cut-off function will be non-zero for this component only.

Definition at line 29 of file function_lib_cutoff.cc.

Member Function Documentation

◆ new_center()

template<int dim>

void Functions::CutOffFunctionBase< dim >::new_center ( const Point< dim > & p )

Move the center of the ball to new point p.

Definition at line 43 of file function_lib_cutoff.cc.

◆ new_radius()

template<int dim>

void Functions::CutOffFunctionBase< dim >::new_radius ( const double r )

Set the radius of the ball to r.

Definition at line 51 of file function_lib_cutoff.cc.

Member Data Documentation

◆ no_component

template<int dim>

const unsigned int Functions::CutOffFunctionBase< dim >::no_component = numbers::invalid_unsigned_int

static

Value used in the constructor of this and derived classes to denote that no component is selected.

Definition at line 843 of file function_lib.h.

◆ center

template<int dim>

Point<dim> Functions::CutOffFunctionBase< dim >::center

protected

Center of the integration ball.

Definition at line 870 of file function_lib.h.

◆ radius

template<int dim>

double Functions::CutOffFunctionBase< dim >::radius

protected

Radius of the ball.

Definition at line 875 of file function_lib.h.

◆ selected

template<int dim>

const unsigned int Functions::CutOffFunctionBase< dim >::selected

protected

Component selected. If no_component, the function is the same in all components.

Definition at line 881 of file function_lib.h.

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

deal.II/base/function_lib.h
source/base/function_lib_cutoff.cc

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ CutOffFunctionBase()

Member Function Documentation

◆ new_center()

◆ new_radius()

Member Data Documentation

◆ no_component

◆ center

◆ radius

◆ selected

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