Reference documentation for deal.II version GIT 0f6eca7a35 2022-05-23 02:45:01+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Protected Attributes | Private Attributes | List of all members
Functions::CutOffFunctionTensorProduct< dim > Class Template Reference

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

Inheritance diagram for Functions::CutOffFunctionTensorProduct< dim >:
[legend]

Public Types

using time_type = typename FunctionTime< typename numbers::NumberTraits< RangeNumberType >::real_type >::time_type
 

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
 
const Point< dim > & get_center () const
 
double get_radius () const
 
bool integrates_to_one () const
 
virtual void vector_value (const Point< dim > &p, Vector< RangeNumberType > &values) const
 
virtual void value_list (const std::vector< Point< dim >> &points, std::vector< RangeNumberType > &values, const unsigned int component=0) const
 
virtual void vector_value_list (const std::vector< Point< dim >> &points, std::vector< Vector< RangeNumberType >> &values) const
 
virtual void vector_values (const std::vector< Point< dim >> &points, std::vector< std::vector< RangeNumberType >> &values) const
 
virtual void vector_gradient (const Point< dim > &p, std::vector< Tensor< 1, dim, RangeNumberType >> &gradients) const
 
virtual void gradient_list (const std::vector< Point< dim >> &points, std::vector< Tensor< 1, dim, RangeNumberType >> &gradients, const unsigned int component=0) const
 
virtual void vector_gradients (const std::vector< Point< dim >> &points, std::vector< std::vector< Tensor< 1, dim, RangeNumberType >>> &gradients) const
 
virtual void vector_gradient_list (const std::vector< Point< dim >> &points, std::vector< std::vector< Tensor< 1, dim, RangeNumberType >>> &gradients) const
 
virtual RangeNumberType laplacian (const Point< dim > &p, const unsigned int component=0) const
 
virtual void vector_laplacian (const Point< dim > &p, Vector< RangeNumberType > &values) const
 
virtual void laplacian_list (const std::vector< Point< dim >> &points, std::vector< RangeNumberType > &values, const unsigned int component=0) const
 
virtual void vector_laplacian_list (const std::vector< Point< dim >> &points, std::vector< Vector< RangeNumberType >> &values) const
 
virtual SymmetricTensor< 2, dim, RangeNumberType > hessian (const Point< dim > &p, const unsigned int component=0) const
 
virtual void vector_hessian (const Point< dim > &p, std::vector< SymmetricTensor< 2, dim, RangeNumberType >> &values) const
 
virtual void hessian_list (const std::vector< Point< dim >> &points, std::vector< SymmetricTensor< 2, dim, RangeNumberType >> &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, RangeNumberType >>> &values) const
 
virtual std::size_t memory_consumption () const
 
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 Attributes

const unsigned int n_components
 

Static Public Attributes

static const unsigned int no_component = numbers::invalid_unsigned_int
 
static constexpr unsigned int dimension = dim
 

Protected Attributes

Point< dim > center
 
double radius
 
const unsigned int selected
 
bool integrate_to_one
 
const double unitary_integral_value
 
double rescaling
 

Private Attributes

std::array< std::unique_ptr< CutOffFunctionBase< 1 > >, dim > base
 
bool initialized
 
numbers::NumberTraits< double >::real_type time
 

Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

std::atomic< unsigned int > counter
 
std::map< std::string, unsigned int > counter_map
 
std::vector< std::atomic< bool > * > validity_pointers
 
const std::type_info * object_info
 
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)
 
using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 
static std::mutex mutex
 
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 
void check_no_subscribers () const noexcept
 

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.

Definition at line 1037 of file function_lib.h.

Member Typedef Documentation

◆ time_type

template<int dim, typename RangeNumberType = double>
using Function< dim, RangeNumberType >::time_type = typename FunctionTime< typename numbers::NumberTraits<RangeNumberType>::real_type>::time_type
inherited

The scalar-valued real type used for representing time.

Definition at line 169 of file function.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 104 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 122 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 134 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, RangeNumberType >.

Definition at line 146 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, RangeNumberType >.

Definition at line 160 of file function_lib_cutoff.cc.

◆ get_center()

template<int dim>
const Point< dim > & Functions::CutOffFunctionBase< dim >::get_center
inherited

Return the center stored in this object.

Definition at line 63 of file function_lib_cutoff.cc.

◆ get_radius()

template<int dim>
double Functions::CutOffFunctionBase< dim >::get_radius
inherited

Return the radius stored in this object.

Definition at line 87 of file function_lib_cutoff.cc.

◆ integrates_to_one()

template<int dim>
bool Functions::CutOffFunctionBase< dim >::integrates_to_one
inherited

Return a boolean indicating whether this function integrates to one.

Definition at line 96 of file function_lib_cutoff.cc.

◆ vector_value()

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::vector_value ( const Point< dim > &  p,
Vector< RangeNumberType > &  values 
) const
virtualinherited

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 in Functions::FEFieldFunction< dim, VectorType, spacedim >, and Functions::ConstantFunction< dim, double >.

◆ value_list()

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::value_list ( const std::vector< Point< dim >> &  points,
std::vector< RangeNumberType > &  values,
const unsigned int  component = 0 
) const
virtualinherited

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 in Functions::FEFieldFunction< dim, VectorType, spacedim >, and Functions::ConstantFunction< dim, double >.

◆ vector_value_list()

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::vector_value_list ( const std::vector< Point< dim >> &  points,
std::vector< Vector< RangeNumberType >> &  values 
) const
virtualinherited

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 in Functions::FEFieldFunction< dim, VectorType, spacedim >, and Functions::ConstantFunction< dim, double >.

◆ vector_values()

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::vector_values ( const std::vector< Point< dim >> &  points,
std::vector< std::vector< RangeNumberType >> &  values 
) const
virtualinherited

For each component of the function, fill a vector of values, one for each point.

The default implementation of this function in Function calls value_list() for each component. In order to improve performance, this can be reimplemented in derived classes to speed up performance.

◆ vector_gradient()

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::vector_gradient ( const Point< dim > &  p,
std::vector< Tensor< 1, dim, RangeNumberType >> &  gradients 
) const
virtualinherited

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

Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >, and Functions::ConstantFunction< dim, double >.

◆ gradient_list()

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::gradient_list ( const std::vector< Point< dim >> &  points,
std::vector< Tensor< 1, dim, RangeNumberType >> &  gradients,
const unsigned int  component = 0 
) const
virtualinherited

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 in Functions::ConstantFunction< dim, double >, and Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ vector_gradients()

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::vector_gradients ( const std::vector< Point< dim >> &  points,
std::vector< std::vector< Tensor< 1, dim, RangeNumberType >>> &  gradients 
) const
virtualinherited

For each component of the function, fill a vector of gradient values, one for each point.

The default implementation of this function in Function calls value_list() for each component. In order to improve performance, this can be reimplemented in derived classes to speed up performance.

◆ vector_gradient_list()

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::vector_gradient_list ( const std::vector< Point< dim >> &  points,
std::vector< std::vector< Tensor< 1, dim, RangeNumberType >>> &  gradients 
) const
virtualinherited

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 in Functions::ConstantFunction< dim, double >, and Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ laplacian()

template<int dim, typename RangeNumberType = double>
virtual RangeNumberType Function< dim, RangeNumberType >::laplacian ( const Point< dim > &  p,
const unsigned int  component = 0 
) const
virtualinherited

◆ vector_laplacian()

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::vector_laplacian ( const Point< dim > &  p,
Vector< RangeNumberType > &  values 
) const
virtualinherited

Compute the Laplacian of all components at point p and store them in values.

Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ laplacian_list()

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::laplacian_list ( const std::vector< Point< dim >> &  points,
std::vector< RangeNumberType > &  values,
const unsigned int  component = 0 
) const
virtualinherited

Compute the Laplacian of one component at a set of points.

Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ vector_laplacian_list()

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::vector_laplacian_list ( const std::vector< Point< dim >> &  points,
std::vector< Vector< RangeNumberType >> &  values 
) const
virtualinherited

Compute the Laplacians of all components at a set of points.

Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ hessian()

template<int dim, typename RangeNumberType = double>
virtual SymmetricTensor<2, dim, RangeNumberType> Function< dim, RangeNumberType >::hessian ( const Point< dim > &  p,
const unsigned int  component = 0 
) const
virtualinherited

◆ vector_hessian()

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::vector_hessian ( const Point< dim > &  p,
std::vector< SymmetricTensor< 2, dim, RangeNumberType >> &  values 
) const
virtualinherited

Compute the Hessian of all components at point p and store them in values.

◆ hessian_list()

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::hessian_list ( const std::vector< Point< dim >> &  points,
std::vector< SymmetricTensor< 2, dim, RangeNumberType >> &  values,
const unsigned int  component = 0 
) const
virtualinherited

Compute the Hessian of one component at a set of points.

◆ vector_hessian_list()

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::vector_hessian_list ( const std::vector< Point< dim >> &  points,
std::vector< std::vector< SymmetricTensor< 2, dim, RangeNumberType >>> &  values 
) const
virtualinherited

Compute the Hessians of all components at a set of points.

◆ memory_consumption()

template<int dim, typename RangeNumberType = double>
virtual std::size_t Function< dim, RangeNumberType >::memory_consumption ( ) const
virtualinherited

◆ get_time()

numbers::NumberTraits< double >::real_type FunctionTime< numbers::NumberTraits< double >::real_type >::get_time ( ) const
inherited

Return the value of the time variable.

◆ set_time()

virtual void FunctionTime< numbers::NumberTraits< double >::real_type >::set_time ( const Number  new_time)
virtualinherited

Set the time to new_time, overwriting the old value.

◆ advance_time()

virtual void FunctionTime< numbers::NumberTraits< double >::real_type >::advance_time ( const Number  delta_t)
virtualinherited

Advance the time by the given time step delta_t.

Member Data Documentation

◆ base

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

Definition at line 1090 of file function_lib.h.

◆ initialized

template<int dim>
bool Functions::CutOffFunctionTensorProduct< dim >::initialized
private

Definition at line 1092 of file function_lib.h.

◆ no_component

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

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

Definition at line 932 of file function_lib.h.

◆ center

template<int dim>
Point<dim> Functions::CutOffFunctionBase< dim >::center
protectedinherited

Center of the integration ball.

Definition at line 996 of file function_lib.h.

◆ radius

template<int dim>
double Functions::CutOffFunctionBase< dim >::radius
protectedinherited

Radius of the ball.

Definition at line 1001 of file function_lib.h.

◆ selected

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

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

Definition at line 1007 of file function_lib.h.

◆ integrate_to_one

template<int dim>
bool Functions::CutOffFunctionBase< dim >::integrate_to_one
protectedinherited

Flag that controls whether we rescale the value when the radius changes.

Definition at line 1012 of file function_lib.h.

◆ unitary_integral_value

template<int dim>
const double Functions::CutOffFunctionBase< dim >::unitary_integral_value
protectedinherited

The reference integral value. Derived classes should specify what their integral is when radius = 1.0.

Definition at line 1018 of file function_lib.h.

◆ rescaling

template<int dim>
double Functions::CutOffFunctionBase< dim >::rescaling
protectedinherited

Current rescaling to apply the cut-off function.

Definition at line 1023 of file function_lib.h.

◆ dimension

template<int dim, typename RangeNumberType = double>
constexpr unsigned int Function< dim, RangeNumberType >::dimension = dim
staticconstexprinherited

Export the value of the template parameter as a static member constant. Sometimes useful for some expression template programming.

Definition at line 159 of file function.h.

◆ n_components

template<int dim, typename RangeNumberType = double>
const unsigned int Function< dim, RangeNumberType >::n_components
inherited

Number of vector components.

Definition at line 164 of file function.h.

◆ time

numbers::NumberTraits< double >::real_type FunctionTime< numbers::NumberTraits< double >::real_type >::time
privateinherited

Store the present time.

Definition at line 113 of file function_time.h.


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