deal.II version GIT relicensing-2287-g6548a49e0a 2024-12-20 18:30:00+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\}}\)
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Attributes | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
Functions::CutOffFunctionC1< dim > Class Template Reference
Functions

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

Inheritance diagram for Functions::CutOffFunctionC1< dim >:
Inheritance graph
[legend]

Public Types

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

Public Member Functions

 CutOffFunctionC1 (const double radius=1., const Point< dim >=Point< dim >(), const unsigned int n_components=1, const unsigned int select=CutOffFunctionBase< dim >::no_component, 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
 
virtual Tensor< 1, dim > gradient (const Point< dim > &p, const unsigned int component=0) const override
 
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
 
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
 
Number get_time () const
 
virtual void set_time (const Number new_time)
 
virtual void advance_time (const Number delta_t)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
EnableObserverPointer functionality

Classes derived from EnableObserverPointer provide a facility to subscribe to this object. This is mostly used by the ObserverPointer 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
 

Static Public Member Functions

static ::ExceptionBase & ExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBase & ExcNoSubscriber (std::string arg1, std::string arg2)
 

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 Types

using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 

Private Member Functions

void check_no_subscribers () const noexcept
 

Private Attributes

Number time
 
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
 

Static Private Attributes

static std::mutex mutex
 

Detailed Description

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

A cut-off function for an arbitrarily-sized ball that is in the space \(C^1\) (i.e., continuously differentiable). This is a cut-off function that is often used in the literature of the Immersed Boundary Method.

The expression of the function in radial coordinates is given by \(f(r)=1/2(cos(\pi r/s)+1)\) where \(r<s\) is the distance to the center, and \(s\) is the radius of the sphere. If vector valued, it can be restricted to a single component.

Definition at line 1205 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 168 of file function.h.

◆ map_value_type

using EnableObserverPointer::map_value_type = decltype(counter_map)::value_type
privateinherited

The data type used in counter_map.

Definition at line 238 of file enable_observer_pointer.h.

◆ map_iterator

using EnableObserverPointer::map_iterator = decltype(counter_map)::iterator
privateinherited

The iterator type used in counter_map.

Definition at line 243 of file enable_observer_pointer.h.

Constructor & Destructor Documentation

◆ CutOffFunctionC1()

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

Constructor.

Definition at line 483 of file function_lib_cutoff.cc.

Member Function Documentation

◆ value()

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

◆ value_list() [1/2]

template<int dim>
void Functions::CutOffFunctionC1< 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.

Definition at line 517 of file function_lib_cutoff.cc.

◆ vector_value_list() [1/2]

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

Function values at multiple points.

Definition at line 548 of file function_lib_cutoff.cc.

◆ gradient()

template<int dim>
Tensor< 1, dim > Functions::CutOffFunctionC1< 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 579 of file function_lib_cutoff.cc.

◆ set_center()

template<int dim>
void Functions::CutOffFunctionBase< dim >::set_center ( const Point< dim > &  p)
virtualinherited

Set the center of the ball to the point p.

Reimplemented in Functions::CutOffFunctionTensorProduct< dim >.

Definition at line 53 of file function_lib_cutoff.cc.

◆ set_radius()

template<int dim>
void Functions::CutOffFunctionBase< dim >::set_radius ( const double  r)
virtualinherited

Set the radius of the ball to r

Reimplemented in Functions::CutOffFunctionTensorProduct< dim >.

Definition at line 71 of file function_lib_cutoff.cc.

◆ get_center()

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

Return the center stored in this object.

Definition at line 62 of file function_lib_cutoff.cc.

◆ get_radius()

template<int dim>
double Functions::CutOffFunctionBase< dim >::get_radius ( ) const
inherited

Return the radius stored in this object.

Definition at line 86 of file function_lib_cutoff.cc.

◆ integrates_to_one()

template<int dim>
bool Functions::CutOffFunctionBase< dim >::integrates_to_one ( ) const
inherited

Return a boolean indicating whether this function integrates to one.

Definition at line 95 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::ConstantFunction< dim, RangeNumberType >, ComponentSelectFunction< dim, RangeNumberType >, VectorFunctionFromScalarFunctionObject< dim, RangeNumberType >, VectorFunctionFromTensorFunction< dim, RangeNumberType >, Functions::IncrementalFunction< dim, RangeNumberType >, and Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ value_list() [2/2]

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

◆ vector_value_list() [2/2]

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::ConstantFunction< dim, RangeNumberType >, VectorFunctionFromTensorFunction< dim, RangeNumberType >, ComponentSelectFunction< dim, RangeNumberType >, and Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ 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::ConstantFunction< dim, RangeNumberType >, VectorFunctionFromTensorFunction< dim, RangeNumberType >, and Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ 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::FEFieldFunction< dim, VectorType, spacedim >, Functions::ConstantFunction< dim, RangeNumberType >, and VectorFunctionFromTensorFunction< dim, RangeNumberType >.

◆ 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.

Reimplemented in VectorFunctionFromTensorFunction< dim, RangeNumberType >.

◆ 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::FEFieldFunction< dim, VectorType, spacedim >, Functions::ConstantFunction< dim, RangeNumberType >, and VectorFunctionFromTensorFunction< dim, RangeNumberType >.

◆ laplacian()

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

Compute the Laplacian of a given component at point p.

Reimplemented in Functions::CosineGradFunction< dim >, Functions::IdentityFunction< dim, RangeNumberType >, Functions::CSpline< dim >, Functions::SquareFunction< dim >, Functions::Q1WedgeFunction< dim >, Functions::PillowFunction< dim >, Functions::CosineFunction< dim >, Functions::ExpFunction< dim >, Functions::SlitSingularityFunction< dim >, Functions::JumpFunction< dim >, Functions::FourierCosineFunction< dim >, Functions::FourierSineFunction< dim >, Functions::FourierSineSum< dim >, Functions::FourierCosineSum< dim >, Functions::SymbolicFunction< dim, RangeNumberType >, Functions::FEFieldFunction< dim, VectorType, spacedim >, Functions::ConstantFunction< dim, RangeNumberType >, and Functions::ConstantFunction< dim, double >.

◆ 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

Compute the Hessian of a given component at point p, that is the gradient of the gradient of the function.

Reimplemented in Functions::SignedDistance::Plane< dim >, Functions::IdentityFunction< dim, RangeNumberType >, Functions::CSpline< dim >, Functions::CosineFunction< dim >, Functions::Spherical< dim >, Functions::SymbolicFunction< dim, RangeNumberType >, Functions::CoordinateRestriction< dim >, Functions::ConstantFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, double >, Functions::SignedDistance::Sphere< dim >, and NonMatching::internal::DiscreteQuadratureGeneratorImplementation::RefSpaceFEFieldFunction< dim, Number >.

◆ 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

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

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

Reimplemented in Functions::FlowFunction< dim >, Functions::FlowFunction< 2 >, Functions::ConstantFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, double >, ComponentSelectFunction< dim, RangeNumberType >, Functions::CSpline< dim >, FunctionDerivative< dim >, Functions::JumpFunction< dim >, Functions::InterpolatedTensorProductGridData< dim >, Functions::InterpolatedUniformGridData< dim >, Functions::Polynomial< dim >, and Functions::Spherical< dim >.

◆ get_time()

template<typename Number = double>
Number FunctionTime< Number >::get_time ( ) const
inherited

Return the value of the time variable.

◆ set_time()

template<typename Number = double>
virtual void FunctionTime< Number >::set_time ( const Number  new_time)
virtualinherited

Set the time to new_time, overwriting the old value.

◆ advance_time()

template<typename Number = double>
virtual void FunctionTime< Number >::advance_time ( const Number  delta_t)
virtualinherited

Advance the time by the given time step delta_t.

◆ subscribe()

void EnableObserverPointer::subscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
inherited

Subscribes a user of the object by storing the pointer validity. The subscriber may be identified by text supplied as identifier.

Definition at line 131 of file enable_observer_pointer.cc.

◆ unsubscribe()

void EnableObserverPointer::unsubscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
inherited

Unsubscribes a user from the object.

Note
The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 151 of file enable_observer_pointer.cc.

◆ n_subscriptions()

unsigned int EnableObserverPointer::n_subscriptions ( ) const
inlineinherited

Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.

Definition at line 322 of file enable_observer_pointer.h.

◆ list_subscribers() [1/2]

template<typename StreamType >
void EnableObserverPointer::list_subscribers ( StreamType &  stream) const
inlineinherited

List the subscribers to the input stream.

Definition at line 339 of file enable_observer_pointer.h.

◆ list_subscribers() [2/2]

void EnableObserverPointer::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 199 of file enable_observer_pointer.cc.

◆ serialize()

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

Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.

Definition at line 331 of file enable_observer_pointer.h.

◆ check_no_subscribers()

void EnableObserverPointer::check_no_subscribers ( ) const
privatenoexceptinherited

Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.

Note
Since this function is just a consistency check it does nothing in release mode.
If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.

Definition at line 53 of file enable_observer_pointer.cc.

Member Data Documentation

◆ 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 931 of file function_lib.h.

◆ center

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

Center of the integration ball.

Definition at line 995 of file function_lib.h.

◆ radius

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

Radius of the ball.

Definition at line 1000 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 1006 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 1011 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 1017 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 1022 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 158 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 163 of file function.h.

◆ time

template<typename Number = double>
Number FunctionTime< Number >::time
privateinherited

Store the present time.

Definition at line 112 of file function_time.h.

◆ counter

std::atomic<unsigned int> EnableObserverPointer::counter
mutableprivateinherited

Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).

The creator (and owner) of an object is counted in the map below if HE manages to supply identification.

We use the mutable keyword in order to allow subscription to constant objects also.

This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic class template.

Definition at line 227 of file enable_observer_pointer.h.

◆ counter_map

std::map<std::string, unsigned int> EnableObserverPointer::counter_map
mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 233 of file enable_observer_pointer.h.

◆ validity_pointers

std::vector<std::atomic<bool> *> EnableObserverPointer::validity_pointers
mutableprivateinherited

In this vector, we store pointers to the validity bool in the ObserverPointer objects that subscribe to this class.

Definition at line 249 of file enable_observer_pointer.h.

◆ object_info

const std::type_info* EnableObserverPointer::object_info
mutableprivateinherited

Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.

Definition at line 257 of file enable_observer_pointer.h.

◆ mutex

std::mutex EnableObserverPointer::mutex
staticprivateinherited

A mutex used to ensure data consistency when accessing the mutable members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers().

Definition at line 280 of file enable_observer_pointer.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8