Reference documentation for deal.II version 9.6.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\}}\)
Loading...
Searching...
No Matches
VectorFunctionFromScalarFunctionObject< dim, RangeNumberType > Class Template Reference

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

Inheritance diagram for VectorFunctionFromScalarFunctionObject< dim, RangeNumberType >:

Public Types

using time_type
 

Public Member Functions

 VectorFunctionFromScalarFunctionObject (const std::function< RangeNumberType(const Point< dim > &)> &function_object, const unsigned int selected_component, const unsigned int n_components)
 
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
 
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 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
 
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)
 
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 constexpr unsigned int dimension
 

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

const std::function< RangeNumberType(const Point< dim > &)> function_object
 
const unsigned int selected_component
 
numbers::NumberTraits< double >::real_type time
 
std::atomic< unsigned intcounter
 
std::map< std::string, unsigned intcounter_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, typename RangeNumberType = double>
class VectorFunctionFromScalarFunctionObject< dim, RangeNumberType >

This class is similar to the ScalarFunctionFromFunctionObject class in that it allows for the easy conversion of a function object to something that satisfies the interface of the Function base class. The difference is that here, the given function object is still a scalar function (i.e. it has a single value at each space point) but that the Function object generated is vector valued. The number of vector components is specified in the constructor, where one also selects a single one of these vector components that should be filled by the passed object. The result is a vector Function object that returns zero in each component except the single selected one where it returns the value returned by the given as the first argument to the constructor.

Note
In the above discussion, note the difference between the (scalar) "function object" (i.e., a C++ object x that can be called as in x(p)) and the capitalized (vector valued) "Function object" (i.e., an object of a class that is derived from the Function base class).

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

RangeNumberType
one(const Point<2> &p)
{
return 1.0;
}
component_mask(&one, 1, 3);
Definition point.h:111

Here, component_mask then represents a Function object that for every point returns the vector \((0, 1, 0)^T\), i.e. a mask function that could, for example, be passed to VectorTools::integrate_difference(). This effect can also be achieved using the ComponentSelectFunction class but is obviously easily extended to functions that are non-constant in their one component.

Definition at line 869 of file function.h.

Member Typedef Documentation

◆ time_type

using Function< dim, double >::time_type
inherited

The scalar-valued real type used for representing time.

Definition at line 168 of file function.h.

◆ map_value_type

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

The data type used in counter_map.

Definition at line 229 of file subscriptor.h.

◆ map_iterator

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

The iterator type used in counter_map.

Definition at line 234 of file subscriptor.h.

Constructor & Destructor Documentation

◆ VectorFunctionFromScalarFunctionObject()

template<int dim, typename RangeNumberType = double>
VectorFunctionFromScalarFunctionObject< dim, RangeNumberType >::VectorFunctionFromScalarFunctionObject ( const std::function< RangeNumberType(const Point< dim > &)> & function_object,
const unsigned int selected_component,
const unsigned int n_components )

Given a function object that takes a Point and returns a RangeNumberType value, convert this into an object that matches the Function<dim> interface.

Parameters
function_objectThe scalar function that will form one component of the resulting Function object.
n_componentsThe total number of vector components of the resulting Function object.
selected_componentThe single component that should be filled by the first argument.

Member Function Documentation

◆ value()

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

Return the value of the function at the given point. Returns the value the function given to the constructor produces for this point.

Reimplemented from Function< dim, double >.

◆ vector_value() [1/2]

template<int dim, typename RangeNumberType = double>
virtual void VectorFunctionFromScalarFunctionObject< 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.

values shall have the right size beforehand, i.e. n_components.

◆ vector_value() [2/2]

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.

◆ gradient()

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

◆ 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::ConstantFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, double >, Functions::IdentityFunction< dim, RangeNumberType >, and Functions::SymbolicFunction< dim, RangeNumberType >.

◆ 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 ComponentSelectFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, RangeNumberType >, and Functions::ConstantFunction< dim, double >.

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

◆ 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 135 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 155 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 300 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 317 of file subscriptor.h.

◆ list_subscribers() [2/2]

void Subscriptor::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 203 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 309 of file subscriptor.h.

◆ check_no_subscribers()

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

Member Data Documentation

◆ function_object

template<int dim, typename RangeNumberType = double>
const std::function<RangeNumberType(const Point<dim> &)> VectorFunctionFromScalarFunctionObject< dim, RangeNumberType >::function_object
private

The function object which we call when this class's value() or value_list() functions are called.

Definition at line 911 of file function.h.

◆ selected_component

template<int dim, typename RangeNumberType = double>
const unsigned int VectorFunctionFromScalarFunctionObject< dim, RangeNumberType >::selected_component
private

The vector component whose value is to be filled by the given scalar function.

Definition at line 917 of file function.h.

◆ dimension

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 158 of file function.h.

◆ n_components

const unsigned int Function< dim, double >::n_components
inherited

Number of vector components.

Definition at line 163 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 112 of file function_time.h.

◆ counter

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

◆ counter_map

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

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

Definition at line 224 of file subscriptor.h.

◆ validity_pointers

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

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

Definition at line 240 of file subscriptor.h.

◆ object_info

const std::type_info* Subscriptor::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 248 of file subscriptor.h.

◆ mutex

std::mutex Subscriptor::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 271 of file subscriptor.h.


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