Reference documentation for deal.II version Git f09805cc1d 2021-10-18 06:49:49 +0200
\(\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 | Static Public Member Functions | Public Attributes | Static Public Attributes | Private Attributes | List of all members
Functions::IncrementalFunction< dim, RangeNumberType > Class Template Reference

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

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

Public Types

using time_type = typename Function< dim, RangeNumberType >::time_type
 

Public Member Functions

 IncrementalFunction (Function< dim, RangeNumberType > &base)
 
virtual RangeNumberType value (const Point< dim > &p, const unsigned int component=0) const override
 
virtual void vector_value (const Point< dim > &p, Vector< RangeNumberType > &values) const override
 
void set_decrement (const time_type delta_t)
 
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 Tensor< 1, dim, RangeNumberType > gradient (const Point< dim > &p, const unsigned int component=0) 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< RangeNumberType >::real_type get_time () const
 
virtual void set_time (const numbers::NumberTraits< RangeNumberType >::real_type new_time)
 
virtual void advance_time (const numbers::NumberTraits< RangeNumberType >::real_type delta_t)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
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
 

Static Public Member Functions

static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 

Public Attributes

const unsigned int n_components
 

Static Public Attributes

static const unsigned int dimension = dim
 

Private Attributes

Function< dim, RangeNumberType > & base
 
time_type delta_t
 
Vector< RangeNumberType > values_old
 
Threads::Mutex mutex
 

Detailed Description

template<int dim, typename RangeNumberType = double>
class Functions::IncrementalFunction< dim, RangeNumberType >

This class represents an incremental function. That is, given an arbitrary function f, this class will return f(t) - f(t - delta_t), where f(t) denotes the function evaluated at time t and, likewise, f(t - delta_t) denotes the function evaluated at time t - delta_t. The decrement delta_t is set by the method set_decrement(). The main application of this class is to transform a given Dirichlet boundary condition function into incremental form, as is required by some implementations of non-linear solution schemes.

Definition at line 52 of file incremental_function.h.

Member Typedef Documentation

◆ time_type

template<int dim, typename RangeNumberType = double>
using Functions::IncrementalFunction< dim, RangeNumberType >::time_type = typename Function<dim, RangeNumberType>::time_type

The scalar-valued real type used for representing time.

Definition at line 64 of file incremental_function.h.

Constructor & Destructor Documentation

◆ IncrementalFunction()

template<int dim, typename RangeNumberType >
Functions::IncrementalFunction< dim, RangeNumberType >::IncrementalFunction ( Function< dim, RangeNumberType > &  base)

Constructor which wraps a given function base.

Note
This class stores a non-constant reference to base and will call base.set_time() during evaluation in order to evaluate the base class at any arbitrary time. It is guaranteed that the temporal state of base is returned to its original settings after each function evaluation in this class.

Definition at line 26 of file incremental_function.cc.

Member Function Documentation

◆ value()

template<int dim, typename RangeNumberType >
RangeNumberType Functions::IncrementalFunction< dim, RangeNumberType >::value ( const Point< dim > &  p,
const unsigned int  component = 0 
) const
overridevirtual

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. By default, the value of the first component is computed.

Reimplemented from Function< dim, RangeNumberType >.

Definition at line 50 of file incremental_function.cc.

◆ vector_value()

template<int dim, typename RangeNumberType >
void Functions::IncrementalFunction< dim, RangeNumberType >::vector_value ( const Point< dim > &  p,
Vector< RangeNumberType > &  values 
) const
overridevirtual

Return all components of a vector-valued function at a given point.

It is required that the values vector have the correct size before this function is called.

Reimplemented from Function< dim, RangeNumberType >.

Definition at line 79 of file incremental_function.cc.

◆ set_decrement()

template<int dim, typename RangeNumberType = double>
void Functions::IncrementalFunction< dim, RangeNumberType >::set_decrement ( const time_type  delta_t)

Set the time decrement.

It is expected that this value be positive.

Definition at line 38 of file incremental_function.cc.

◆ 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

◆ 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::CutOffFunctionCinfty< dim >, Functions::CutOffFunctionC1< dim >, Functions::CutOffFunctionW1< dim >, VectorFunctionFromTensorFunction< dim, RangeNumberType >, Functions::CutOffFunctionLinfty< dim >, ComponentSelectFunction< dim, RangeNumberType >, Functions::SlitSingularityFunction< dim >, Functions::ConstantFunction< dim, RangeNumberType >, Functions::CosineGradFunction< dim >, Functions::FEFieldFunction< dim, VectorType, spacedim >, Functions::CosineFunction< dim >, Functions::FlowFunction< dim >, Functions::FlowFunction< 2 >, and Functions::Q1WedgeFunction< dim >.

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

Reimplemented in Functions::StokesCosine< dim >, Functions::PoisseuilleFlow< dim >, Functions::FlowFunction< dim >, and Functions::FlowFunction< 2 >.

◆ gradient()

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

◆ 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 >, 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::ConstantFunction< dim, RangeNumberType >, 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, RangeNumberType >, 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

◆ 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 >, Functions::FlowFunction< dim >, and Functions::FlowFunction< 2 >.

◆ 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< RangeNumberType >::real_type FunctionTime< numbers::NumberTraits< RangeNumberType >::real_type >::get_time ( ) const
inherited

Return the value of the time variable.

◆ set_time()

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

Set the time to new_time, overwriting the old value.

◆ advance_time()

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

Advance the time by the given time step delta_t.

◆ subscribe()

void Subscriptor::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 136 of file subscriptor.cc.

◆ unsubscribe()

void Subscriptor::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 156 of file subscriptor.cc.

◆ n_subscriptions()

unsigned int Subscriptor::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 301 of file subscriptor.h.

◆ list_subscribers() [1/2]

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

List the subscribers to the input stream.

Definition at line 318 of file subscriptor.h.

◆ list_subscribers() [2/2]

void Subscriptor::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 204 of file subscriptor.cc.

◆ serialize()

template<class Archive >
void Subscriptor::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 310 of file subscriptor.h.

Member Data Documentation

◆ dimension

template<int dim, typename RangeNumberType = double>
const unsigned int Functions::IncrementalFunction< dim, RangeNumberType >::dimension = dim
static

Export the value of the template parameter as a static member constant. This is sometimes useful in the context of template programming.

Definition at line 59 of file incremental_function.h.

◆ base

template<int dim, typename RangeNumberType = double>
Function<dim, RangeNumberType>& Functions::IncrementalFunction< dim, RangeNumberType >::base
private

A reference to the function being wrapped.

Definition at line 110 of file incremental_function.h.

◆ delta_t

template<int dim, typename RangeNumberType = double>
time_type Functions::IncrementalFunction< dim, RangeNumberType >::delta_t
private

The time decrement.

Definition at line 115 of file incremental_function.h.

◆ values_old

template<int dim, typename RangeNumberType = double>
Vector<RangeNumberType> Functions::IncrementalFunction< dim, RangeNumberType >::values_old
mutableprivate

An auxiliary vector to store values.

Definition at line 120 of file incremental_function.h.

◆ mutex

template<int dim, typename RangeNumberType = double>
Threads::Mutex Functions::IncrementalFunction< dim, RangeNumberType >::mutex
mutableprivate

Thread mutex for supporting evaluation in multi-threaded contexts.

Definition at line 125 of file incremental_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.


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