Reference documentation for deal.II version 9.4.0
\(\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 | Private Attributes | List of all members
FunctionFromFunctionObjects< dim, RangeNumberType > Class Template Reference

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

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

Public Types

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

Public Member Functions

 FunctionFromFunctionObjects (const unsigned int n_components=1, const double initial_time=0)
 
 FunctionFromFunctionObjects (const std::vector< std::function< RangeNumberType(const Point< dim > &)> > &values, const double initial_time=0.0)
 
 FunctionFromFunctionObjects (const std::vector< std::function< RangeNumberType(const Point< dim > &)> > &values, const std::vector< std::function< Tensor< 1, dim, RangeNumberType >(const Point< dim > &)> > &gradients, const double initial_time=0.0)
 
virtual RangeNumberType value (const Point< dim > &p, const unsigned int component=0) const override
 
virtual Tensor< 1, dim, RangeNumberType > gradient (const Point< dim > &p, const unsigned int component=0) const override
 
void set_function_values (const std::vector< std::function< RangeNumberType(const Point< dim > &)> > &values)
 
void set_function_gradients (const std::vector< std::function< Tensor< 1, dim, RangeNumberType >(const Point< dim > &)> > &gradients)
 
virtual void vector_value (const Point< dim > &p, Vector< double > &values) const
 
virtual void value_list (const std::vector< Point< dim > > &points, std::vector< double > &values, const unsigned int component=0) const
 
virtual void vector_value_list (const std::vector< Point< dim > > &points, std::vector< Vector< double > > &values) const
 
virtual void vector_values (const std::vector< Point< dim > > &points, std::vector< std::vector< double > > &values) 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
 
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 constexpr unsigned int dimension
 

Private Attributes

std::vector< std::function< RangeNumberType(const Point< dim > &)> > function_values
 
std::vector< std::function< Tensor< 1, dim, RangeNumberType >(const Point< dim > &)> > function_gradients
 
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 intcounter
 
std::map< std::string, unsigned intcounter_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, typename RangeNumberType = double>
class FunctionFromFunctionObjects< dim, RangeNumberType >

This class is similar to the ScalarFunctionFromFunctionObject and VectorFunctionFromFunctionObject classes in that it allows for the easy conversion of a vector of function objects to something that satisfies the interface of the Function base class.

The difference is that here the Function object generated may be vector valued, and you can specify the gradients of the function. The number of vector components is deduced from the size of the vector in the constructor.

To be more concrete, let us consider the following example:

RangeNumberType
first_component(const Point<2> &p)
{
return 1.0;
}
RangeNumberType
second_component(const Point<2> &p)
{
return 2.0;
}
zero_gradient(const Point<2> &) {
}
custom_function({&first_component, &second_component},
{&zero_gradient, &zero_gradient});
Definition: tensor.h:503

Definition at line 979 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

◆ FunctionFromFunctionObjects() [1/3]

template<int dim, typename RangeNumberType = double>
FunctionFromFunctionObjects< dim, RangeNumberType >::FunctionFromFunctionObjects ( const unsigned int  n_components = 1,
const double  initial_time = 0 
)
explicit

Default constructor.

This constructor does not initialize the internal methods. To have a usable function, you need to call at least the set_function_values() method. If you need also the gradients of the solution, then you must also call the set_function_gradients() method.

◆ FunctionFromFunctionObjects() [2/3]

template<int dim, typename RangeNumberType = double>
FunctionFromFunctionObjects< dim, RangeNumberType >::FunctionFromFunctionObjects ( const std::vector< std::function< RangeNumberType(const Point< dim > &)>  ,
values,
const double  initial_time = 0.0 
)
explicit

Constructor for functions of which you only know the values.

The resulting function will have a number of components equal to the size of the vector values. A call to the FunctionFromFunctionObject::gradient() method will trigger an exception, unless you first call the set_function_gradients() method.

◆ FunctionFromFunctionObjects() [3/3]

template<int dim, typename RangeNumberType = double>
FunctionFromFunctionObjects< dim, RangeNumberType >::FunctionFromFunctionObjects ( const std::vector< std::function< RangeNumberType(const Point< dim > &)>  ,
values,
const std::vector< std::function< Tensor< 1, dim, RangeNumberType >(const Point< dim > &)>  ,
gradients,
const double  initial_time = 0.0 
)

Constructor for functions of which you know both the values and the gradients.

The resulting function will have a number of components equal to the size of the vector values. If the size of values and gradients does not match, an exception is triggered.

Member Function Documentation

◆ value()

template<int dim, typename RangeNumberType = double>
virtual RangeNumberType FunctionFromFunctionObjects< 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; it defaults to zero, i.e. the first component.

Reimplemented from Function< dim, double >.

◆ gradient()

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

Return the gradient 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 >.

◆ set_function_values()

template<int dim, typename RangeNumberType = double>
void FunctionFromFunctionObjects< dim, RangeNumberType >::set_function_values ( const std::vector< std::function< RangeNumberType(const Point< dim > &)>  ,
values 
)

Reset the function values of this object. An assertion is thrown if the size of the values parameter does not match the number of components of this object.

◆ set_function_gradients()

template<int dim, typename RangeNumberType = double>
void FunctionFromFunctionObjects< dim, RangeNumberType >::set_function_gradients ( const std::vector< std::function< Tensor< 1, dim, RangeNumberType >(const Point< dim > &)>  ,
gradients 
)

Reset the function gradients of this object. An assertion is thrown if the size of the gradients parameter does not match the number of components of this object.

◆ vector_value()

virtual void Function< dim, double >::vector_value ( const Point< dim > &  p,
Vector< double > &  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, double >.

◆ value_list()

virtual void Function< dim, double >::value_list ( const std::vector< Point< dim > > &  points,
std::vector< double > &  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, double >.

◆ vector_value_list()

virtual void Function< dim, double >::vector_value_list ( const std::vector< Point< dim > > &  points,
std::vector< Vector< double > > &  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, double >.

◆ vector_values()

virtual void Function< dim, double >::vector_values ( const std::vector< Point< dim > > &  points,
std::vector< std::vector< double > > &  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()

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

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

Reimplemented in Functions::ConstantFunction< dim, double >.

◆ gradient_list()

virtual void Function< dim, double >::gradient_list ( const std::vector< Point< dim > > &  points,
std::vector< Tensor< 1, dim, double > > &  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 >.

◆ vector_gradients()

virtual void Function< dim, double >::vector_gradients ( const std::vector< Point< dim > > &  points,
std::vector< std::vector< Tensor< 1, dim, double > > > &  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()

virtual void Function< dim, double >::vector_gradient_list ( const std::vector< Point< dim > > &  points,
std::vector< std::vector< Tensor< 1, dim, double > > > &  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 >.

◆ laplacian()

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

◆ vector_laplacian()

virtual void Function< dim, double >::vector_laplacian ( const Point< dim > &  p,
Vector< double > &  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< double > &  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< double > > &  values 
) const
virtualinherited

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

◆ hessian()

virtual SymmetricTensor< 2, dim, double > Function< dim, double >::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::IdentityFunction< dim, RangeNumberType >, Functions::SymbolicFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, RangeNumberType >, and Functions::ConstantFunction< dim, double >.

◆ vector_hessian()

virtual void Function< dim, double >::vector_hessian ( const Point< dim > &  p,
std::vector< SymmetricTensor< 2, dim, double > > &  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, double > > &  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, double > > > &  values 
) const
virtualinherited

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

◆ memory_consumption()

virtual std::size_t Function< dim, double >::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::ConstantFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, double >, and ComponentSelectFunction< dim, RangeNumberType >.

◆ 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 numbers::NumberTraits< double >::real_type  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 numbers::NumberTraits< double >::real_type  delta_t)
virtualinherited

Advance the time by the given time step delta_t.

Member Data Documentation

◆ function_values

template<int dim, typename RangeNumberType = double>
std::vector<std::function<RangeNumberType(const Point<dim> &)> > FunctionFromFunctionObjects< dim, RangeNumberType >::function_values
private

The actual function values.

Definition at line 1068 of file function.h.

◆ function_gradients

template<int dim, typename RangeNumberType = double>
std::vector< std::function<Tensor<1, dim, RangeNumberType>(const Point<dim> &)> > FunctionFromFunctionObjects< dim, RangeNumberType >::function_gradients
private

The actual function gradients.

Definition at line 1075 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: