Reference documentation for deal.II version GIT 6da2e5d553 2022-07-01 18:55:02+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::ZeroFunction< dim, RangeNumberType > Class Template Reference

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

Inheritance diagram for Functions::ZeroFunction< dim, RangeNumberType >:
[legend]

Public Types

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

Public Member Functions

 ZeroFunction (const unsigned int n_components=1)
 
virtual double value (const Point< dim > &p, const unsigned int component=0) const override
 
virtual void vector_value (const Point< dim > &p, Vector< double > &return_value) const override
 
virtual void value_list (const std::vector< Point< dim >> &points, std::vector< double > &return_values, const unsigned int component=0) const override
 
virtual void vector_value_list (const std::vector< Point< dim >> &points, std::vector< Vector< double >> &return_values) const override
 
virtual Tensor< 1, dim, doublegradient (const Point< dim > &p, const unsigned int component=0) const override
 
virtual void vector_gradient (const Point< dim > &p, std::vector< Tensor< 1, dim, double >> &gradients) const override
 
virtual void gradient_list (const std::vector< Point< dim >> &points, std::vector< Tensor< 1, dim, double >> &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, double >>> &gradients) const override
 
virtual SymmetricTensor< 2, dim, doublehessian (const Point< dim > &point, const unsigned int component=0) const override
 
virtual double laplacian (const Point< dim > &point, const unsigned int component=0) const override
 
virtual std::size_t memory_consumption () const override
 
virtual void vector_values (const std::vector< Point< dim >> &points, std::vector< std::vector< double >> &values) const
 
virtual void vector_gradients (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
 
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 constexpr unsigned int dimension
 

Protected Attributes

std::vector< doublefunction_value_vector
 

Private Attributes

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.

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)
 
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
 
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, typename RangeNumberType = double>
class Functions::ZeroFunction< dim, RangeNumberType >

Provide a function which always returns zero. Obviously, also the derivatives of this function are zero. Also, it returns zero on all components in case the function is not a scalar one, which can be obtained by passing the constructor the appropriate number of components.

This function is of use when you want to implement homogeneous boundary conditions, or zero initial conditions.

Definition at line 510 of file function.h.

Member Typedef Documentation

◆ time_type

using Function< dim, double >::time_type = typename FunctionTime< typename numbers::NumberTraits<double >::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

◆ ZeroFunction()

template<int dim, typename RangeNumberType = double>
Functions::ZeroFunction< dim, RangeNumberType >::ZeroFunction ( const unsigned int  n_components = 1)
explicit

Constructor. The number of components is preset to one.

Member Function Documentation

◆ value()

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

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

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

Reimplemented from Function< dim, double >.

◆ value_list()

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

Reimplemented from Function< dim, double >.

◆ vector_value_list()

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

Reimplemented from Function< dim, double >.

◆ gradient()

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

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

Reimplemented from Function< dim, double >.

◆ vector_gradient()

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

Reimplemented from Function< dim, double >.

◆ gradient_list()

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

Reimplemented from Function< dim, double >.

◆ vector_gradient_list()

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

Reimplemented from Function< dim, double >.

◆ hessian()

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

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

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

Compute the Laplacian of a given component at point p.

Reimplemented from Function< dim, double >.

◆ memory_consumption()

virtual std::size_t Functions::ConstantFunction< dim, double >::memory_consumption ( ) const
overridevirtualinherited

Return an estimate for the memory consumption, in bytes, of this object.

This function is virtual and can be overloaded by derived classes.

Reimplemented from Function< dim, double >.

Reimplemented in ComponentSelectFunction< dim, RangeNumberType >.

◆ vector_values()

virtual void Function< dim, double >::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_gradients()

virtual void Function< dim, double >::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_laplacian()

virtual void Function< dim, double >::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.

◆ laplacian_list()

virtual void Function< dim, double >::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.

◆ vector_laplacian_list()

virtual void Function< dim, double >::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.

◆ vector_hessian()

virtual void Function< dim, double >::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()

virtual void Function< dim, double >::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()

virtual void Function< dim, double >::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.

◆ 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

◆ function_value_vector

std::vector<double > Functions::ConstantFunction< dim, double >::function_value_vector
protectedinherited

Store the constant function value vector.

Definition at line 493 of file function.h.

◆ dimension

constexpr unsigned int Function< dim, double >::dimension
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

const unsigned int Function< dim, double >::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 file: