Reference documentation for deal.II version Git 2c472e7589 2019-11-13 14:15:54 +0100
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | List of all members
Functions::CutOffFunctionLinfty< dim > Class Template Reference

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

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

Public Member Functions

 CutOffFunctionLinfty (const double radius=1., const Point< dim >=Point< dim >(), const unsigned int n_components=1, const unsigned int select=CutOffFunctionBase< dim >::no_component, const bool integrate_to_one=false)
 
virtual double value (const Point< dim > &p, const unsigned int component=0) const override
 
virtual void value_list (const std::vector< Point< dim >> &points, std::vector< double > &values, const unsigned int component=0) const override
 
virtual void vector_value_list (const std::vector< Point< dim >> &points, std::vector< Vector< double >> &values) 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)
 
virtual void set_center (const Point< dim > &p)
 
virtual void set_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)
 
virtual ~Function () override=0
 
Functionoperator= (const Function &f)
 
virtual void vector_value (const Point< dim > &p, 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< 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 ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (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 >
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 ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (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::CutOffFunctionLinfty< dim >

Cut-off function in L-infinity for an arbitrary ball. This function is the characteristic function of a ball around center with a specified radius, that is,

\[ f = \chi(B_r(c)). \]

If vector valued, it can be restricted to a single component.

Author
Guido Kanschat, 2001, 2002

Definition at line 1123 of file function_lib.h.

Constructor & Destructor Documentation

◆ CutOffFunctionLinfty()

template<int dim>
Functions::CutOffFunctionLinfty< dim >::CutOffFunctionLinfty ( const double  radius = 1.,
const Point< dim >  p = Point<dim>(),
const unsigned int  n_components = 1,
const unsigned int  select = CutOffFunctionBase<dim>::no_component,
const bool  integrate_to_one = false 
)

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 219 of file function_lib_cutoff.cc.

Member Function Documentation

◆ value()

template<int dim>
double Functions::CutOffFunctionLinfty< 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 236 of file function_lib_cutoff.cc.

◆ value_list()

template<int dim>
void Functions::CutOffFunctionLinfty< dim >::value_list ( const std::vector< Point< dim >> &  points,
std::vector< double > &  values,
const unsigned int  component = 0 
) const
overridevirtual

Function values at multiple points.

Reimplemented from Function< dim >.

Definition at line 248 of file function_lib_cutoff.cc.

◆ vector_value_list()

template<int dim>
void Functions::CutOffFunctionLinfty< dim >::vector_value_list ( const std::vector< Point< dim >> &  points,
std::vector< Vector< double >> &  values 
) const
overridevirtual

Function values at multiple points.

Reimplemented from Function< dim >.

Definition at line 271 of file function_lib_cutoff.cc.


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