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

Inheritance diagram for Functions::CutOffFunctionTensorProduct< dim >:

Public Member Functions
	CutOffFunctionTensorProduct (double radius=1.0, const Point< dim > &center=Point< dim >(), const unsigned int n_components=1, const unsigned int select=CutOffFunctionBase< dim >::no_component, const bool integrate_to_one=false)

template<template< int > class CutOffFunctionBaseType>
void	set_base ()

virtual void	set_center (const Point< dim > &center) override

virtual void	set_radius (const double radius) override

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

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

Public Member Functions inherited from Functions::CutOffFunctionBase< dim >
	CutOffFunctionBase (const double radius=1., const Point< dim > center=Point< dim >(), const unsigned int n_components=1, const unsigned int select=CutOffFunctionBase< dim >::no_component, const bool integrate_to_one=false, const double unitary_integral_value=1.0)

virtual	~CutOffFunctionBase ()=default

void	new_center (const Point< dim > &p)

void	new_radius (const double r)

const Point< dim > &	get_center () const

double	get_radius () const

bool	integrates_to_one () 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	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 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< 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)

Private Attributes
std::array< std::unique_ptr< CutOffFunctionBase< 1 > >, dim >	base

bool	initialized

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 Functions::CutOffFunctionBase< dim >
static const unsigned int	no_component = numbers::invalid_unsigned_int

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

Protected Attributes inherited from Functions::CutOffFunctionBase< dim >
Point< dim >	center

double	radius

const unsigned int	selected

bool	integrate_to_one

const double	unitary_integral_value

double	rescaling

Detailed Description

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

Tensor product of CutOffFunctionBase objects.

Instead of using the distance to compute the cut-off function, this class performs a tensor product of the same CutOffFunctionBase object in each coordinate direction.

Author: Luca Heltai, 2019.

Definition at line 1053 of file function_lib.h.

Constructor & Destructor Documentation

◆ CutOffFunctionTensorProduct()

template<int dim>

Functions::CutOffFunctionTensorProduct< dim >::CutOffFunctionTensorProduct	(	double	radius = `1.0`,
		const Point< dim > &	center = `Point<dim>()`,
		const unsigned int	n_components = `1`,
		const unsigned int	select = `CutOffFunctionBase<dim>::no_component`,
		const bool	integrate_to_one = `false`
	)

Construct an empty CutOffFunctionTensorProduct object.

Before you can use this class, you have to call the set_base() method with a class derived from the CutOffFunctionBase object.

If you try to use this class before you call the set_base() method, and exception will be triggered.

Definition at line 121 of file function_lib_cutoff.cc.

Member Function Documentation

◆ set_base()

template<int dim>

template<template< int > class CutOffFunctionBaseType>

void Functions::CutOffFunctionTensorProduct< dim >::set_base ( )

Initialize the class with an object of type

Template Parameters

CutOffFunctionBaseType<1>.

◆ set_center()

template<int dim>

void Functions::CutOffFunctionTensorProduct< dim >::set_center ( const Point< dim > & center )

overridevirtual

Set the new center.

Reimplemented from Functions::CutOffFunctionBase< dim >.

Definition at line 139 of file function_lib_cutoff.cc.

◆ set_radius()

template<int dim>

void Functions::CutOffFunctionTensorProduct< dim >::set_radius ( const double radius )

overridevirtual

Set the new radius.

Reimplemented from Functions::CutOffFunctionBase< dim >.

Definition at line 151 of file function_lib_cutoff.cc.

◆ value()

template<int dim>

double Functions::CutOffFunctionTensorProduct< 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 163 of file function_lib_cutoff.cc.

◆ gradient()

template<int dim>

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

overridevirtual

Function gradient at one point.

Reimplemented from Function< dim >.

Definition at line 177 of file function_lib_cutoff.cc.

Member Data Documentation

◆ base

template<int dim>

std::array<std::unique_ptr<CutOffFunctionBase<1> >, dim> Functions::CutOffFunctionTensorProduct< dim >::base

private

Definition at line 1106 of file function_lib.h.

◆ initialized

template<int dim>

bool Functions::CutOffFunctionTensorProduct< dim >::initialized

private

Definition at line 1108 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_cutoff.cc

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ CutOffFunctionTensorProduct()

Member Function Documentation

◆ set_base()

◆ set_center()

◆ set_radius()

◆ value()

◆ gradient()

Member Data Documentation

◆ base

◆ initialized

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