 |
Reference documentation for deal.II version 9.6.0
|
Loading...
Searching...
No Matches
|
Reference documentation for deal.II version 9.6.0
|
#include <deal.II/base/function.h>
Public Types | |
| using | time_type |
Public Member Functions | |
| Function (const unsigned int n_components=1, const time_type initial_time=0.0) | |
| Function (const Function &f)=default | |
| virtual | ~Function () override=0 |
| Function & | operator= (const Function &f) |
| virtual RangeNumberType | value (const Point< dim > &p, const unsigned int component=0) 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 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< 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 ::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 constexpr unsigned int | dimension = dim |
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 | |
| numbers::NumberTraits< double >::real_type | 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 |
This class is a model for a general function that, given a point at which to evaluate the function, returns a vector of values with one or more components.
The class serves the purpose of representing both scalar and vector valued functions. To this end, we consider scalar functions as a special case of vector valued functions, in the former case only having a single component return vector. Since handling vectors is comparatively expensive, the interface of this class has functions which only ask for a single component of the vector-valued results (this is what you will usually need in case you know that your function is scalar-valued) as well as functions you can ask for an entire vector of results with as many components as the function object represents. Access to function objects therefore is through the following methods:
For more efficiency, there are other functions returning one or all components at a list of points at once:
Furthermore, there are functions returning the gradient of the function or even higher derivatives at one or several points.
You will usually only overload those functions you need; the functions returning several values at a time (value_list(), vector_value_list(), and gradient analogs) will call those returning only one value (value(), vector_value(), and gradient analogs), while those ones will throw an exception when called but not overloaded.
Conversely, the functions returning all components of the function at one or several points (i.e. vector_value(), vector_value_list()), will not call the function returning one component at one point repeatedly, once for each point and component. The reason is efficiency: this would amount to too many virtual function calls. If you have vector-valued functions, you should therefore also provide overloads of the virtual functions for all components at a time.
Also note, that unless only called a very small number of times, you should overload all sets of functions (returning only one value, as well as those returning a whole array), since the cost of evaluation of a point value is often less than the virtual function call itself.
Support for time dependent functions can be found in the base class FunctionTime.
If the functions you are dealing with have a number of components that are a priori known (for example, dim elements), you might consider using the TensorFunction class instead. This is, in particular, true if the objects you return have the properties of a tensor, i.e., they are for example dim-dimensional vectors or dim-by-dim matrices. On the other hand, functions like VectorTools::interpolate or VectorTools::interpolate_boundary_values definitely only want objects of the current type. You can use the VectorFunctionFromTensorFunction class to convert the former to the latter.
Most of the time, your functions will have the form \(f : \Omega \rightarrow
{\mathbb R}^{n_\text{components}}\). However, there are occasions where you want the function to return vectors (or scalars) over a different number field, for example functions that return complex numbers or vectors of complex numbers: \(f : \Omega \rightarrow {\mathbb
C}^{n_\text{components}}\). In such cases, you can choose a value different than the default double for the second template argument of this class: it describes the scalar type to be used for each component of your return values. It defaults to double, but in the example above, it could be set to std::complex<double>. step-58 is an example of this.
| dim | The space dimension of the range space within which the domain \(\Omega\) of the function lies. Consequently, the function will be evaluated at objects of type Point<dim>. |
| RangeNumberType | The scalar type of the vector space that is the range (or image) of this function. As discussed above, objects of the current type represent functions from \({\mathbb
R}^\text{dim}\) to \(S^{n_\text{components}}\) where \(S\) is the underlying scalar type of the vector space. The type of \(S\) is given by the RangeNumberType template argument. |
Definition at line 149 of file function.h.
| using Function< dim, RangeNumberType >::time_type |
The scalar-valued real type used for representing time.
Definition at line 168 of file function.h.
|
privateinherited |
The data type used in counter_map.
Definition at line 229 of file subscriptor.h.
|
privateinherited |
The iterator type used in counter_map.
Definition at line 234 of file subscriptor.h.
|
explicit |
Constructor. May take an initial value for the number of components (which defaults to one, i.e. a scalar function), and the time variable, which defaults to zero.
|
default |
Copy constructor.
|
overridepure virtual |
Virtual destructor; absolutely necessary in this case.
This destructor is declared pure virtual, such that objects of this class cannot be created. Since all the other virtual functions have a pseudo-implementation to avoid overhead in derived classes, they can not be abstract. As a consequence, we could generate an object of this class because none of this class's functions are abstract.
We circumvent this problem by making the destructor of this class abstract virtual. This ensures that at least one member function is abstract, and consequently, no objects of type Function can be created. However, there is no need for derived classes to explicitly implement a destructor: every class has a destructor, either explicitly implemented or implicitly generated by the compiler, and this resolves the abstractness of any derived class even if they do not have an explicitly declared destructor.
Nonetheless, since derived classes want to call the destructor of a base class, this destructor is implemented (despite it being pure virtual).
| Function & Function< dim, RangeNumberType >::operator= | ( | const Function< dim, RangeNumberType > & | f | ) |
Assignment operator. This is here only so that you can have objects of derived classes in containers, or assign them otherwise. It will raise an exception if the object from which you assign has a different number of components than the one being assigned to.
|
virtual |
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 in FunctionDerivative< dim >, FunctionFromFunctionObjects< dim, RangeNumberType >, FunctionParser< dim >, Functions::Bessel1< dim >, Functions::ConstantFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, double >, Functions::CoordinateRestriction< dim >, Functions::CosineFunction< dim >, Functions::CosineGradFunction< dim >, Functions::CSpline< dim >, Functions::CutOffFunctionC1< dim >, Functions::CutOffFunctionCinfty< dim >, Functions::CutOffFunctionLinfty< dim >, Functions::CutOffFunctionTensorProduct< dim >, Functions::CutOffFunctionW1< dim >, Functions::ExpFunction< dim >, Functions::FEFieldFunction< dim, VectorType, spacedim >, Functions::FlowFunction< dim >, Functions::FlowFunction< 2 >, Functions::FourierCosineFunction< dim >, Functions::FourierCosineSum< dim >, Functions::FourierSineFunction< dim >, Functions::FourierSineSum< dim >, Functions::IdentityFunction< dim, RangeNumberType >, Functions::IncrementalFunction< dim, RangeNumberType >, Functions::InterpolatedTensorProductGridData< dim >, Functions::InterpolatedUniformGridData< dim >, Functions::JumpFunction< dim >, Functions::Monomial< dim, Number >, Functions::ParsedFunction< dim >, Functions::PillowFunction< dim >, Functions::Polynomial< dim >, Functions::Q1WedgeFunction< dim >, Functions::SignedDistance::Ellipsoid< dim >, Functions::SignedDistance::Plane< dim >, Functions::SignedDistance::Rectangle< dim >, Functions::SignedDistance::Sphere< dim >, Functions::SignedDistance::ZalesakDisk< dim >, Functions::SlitSingularityFunction< dim >, Functions::Spherical< dim >, Functions::SquareFunction< dim >, Functions::SymbolicFunction< dim, RangeNumberType >, NonMatching::internal::DiscreteQuadratureGeneratorImplementation::RefSpaceFEFieldFunction< dim, VectorType >, ScalarFunctionFromFunctionObject< dim, RangeNumberType >, VectorFunctionFromScalarFunctionObject< dim, RangeNumberType >, and VectorFunctionFromTensorFunction< dim, RangeNumberType >.
|
virtual |
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 >.
|
virtual |
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 >.
|
virtual |
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 >.
|
virtual |
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.
|
virtual |
Return the gradient of the specified component of the function at the given point.
Reimplemented in AutoDerivativeFunction< dim >, FunctionFromFunctionObjects< dim, RangeNumberType >, Functions::Bessel1< dim >, Functions::ConstantFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, double >, Functions::CoordinateRestriction< dim >, Functions::CosineFunction< dim >, Functions::CosineGradFunction< dim >, Functions::CSpline< dim >, Functions::CutOffFunctionC1< dim >, Functions::CutOffFunctionCinfty< dim >, Functions::CutOffFunctionTensorProduct< dim >, Functions::ExpFunction< dim >, Functions::FEFieldFunction< dim, VectorType, spacedim >, Functions::FourierCosineFunction< dim >, Functions::FourierCosineSum< dim >, Functions::FourierSineFunction< dim >, Functions::FourierSineSum< dim >, Functions::IdentityFunction< dim, RangeNumberType >, Functions::InterpolatedTensorProductGridData< dim >, Functions::InterpolatedUniformGridData< dim >, Functions::JumpFunction< dim >, Functions::Monomial< dim, Number >, Functions::PillowFunction< dim >, Functions::Polynomial< dim >, Functions::Q1WedgeFunction< dim >, Functions::SignedDistance::Ellipsoid< dim >, Functions::SignedDistance::Plane< dim >, Functions::SignedDistance::Sphere< dim >, Functions::SlitSingularityFunction< dim >, Functions::Spherical< dim >, Functions::SquareFunction< dim >, Functions::SymbolicFunction< dim, RangeNumberType >, NonMatching::internal::DiscreteQuadratureGeneratorImplementation::RefSpaceFEFieldFunction< dim, VectorType >, and VectorFunctionFromTensorFunction< dim, RangeNumberType >.
|
virtual |
Return the gradient of all components of the function at the given point.
Reimplemented in Functions::ConstantFunction< dim, double >.
|
virtual |
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 >.
|
virtual |
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.
|
virtual |
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 >.
|
virtual |
Compute the Laplacian of a given component at point p.
Reimplemented in Functions::ConstantFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, double >, Functions::CosineFunction< dim >, Functions::CosineGradFunction< dim >, Functions::CSpline< dim >, Functions::ExpFunction< dim >, Functions::FEFieldFunction< dim, VectorType, spacedim >, Functions::FourierCosineFunction< dim >, Functions::FourierCosineSum< dim >, Functions::FourierSineFunction< dim >, Functions::FourierSineSum< dim >, Functions::IdentityFunction< dim, RangeNumberType >, Functions::JumpFunction< dim >, Functions::PillowFunction< dim >, Functions::Q1WedgeFunction< dim >, Functions::SlitSingularityFunction< dim >, Functions::SquareFunction< dim >, and Functions::SymbolicFunction< dim, RangeNumberType >.
|
virtual |
Compute the Laplacian of all components at point p and store them in values.
|
virtual |
Compute the Laplacian of one component at a set of points.
|
virtual |
Compute the Laplacians of all components at a set of points.
|
virtual |
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::CoordinateRestriction< dim >, Functions::CosineFunction< dim >, Functions::CSpline< dim >, Functions::IdentityFunction< dim, RangeNumberType >, Functions::SignedDistance::Plane< dim >, Functions::SignedDistance::Sphere< dim >, Functions::Spherical< dim >, Functions::SymbolicFunction< dim, RangeNumberType >, and NonMatching::internal::DiscreteQuadratureGeneratorImplementation::RefSpaceFEFieldFunction< dim, VectorType >.
|
virtual |
Compute the Hessian of all components at point p and store them in values.
|
virtual |
Compute the Hessian of one component at a set of points.
|
virtual |
Compute the Hessians of all components at a set of points.
|
virtual |
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 >, FunctionDerivative< dim >, Functions::ConstantFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, double >, Functions::CSpline< dim >, Functions::FlowFunction< dim >, Functions::FlowFunction< 2 >, Functions::InterpolatedTensorProductGridData< dim >, Functions::InterpolatedUniformGridData< dim >, Functions::JumpFunction< dim >, Functions::Polynomial< dim >, and Functions::Spherical< dim >.
|
inherited |
Return the value of the time variable.
|
virtualinherited |
Set the time to new_time, overwriting the old value.
|
virtualinherited |
Advance the time by the given time step delta_t.
|
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.
|
inherited |
Unsubscribes a user from the object.
identifier and the validity pointer must be the same as the one supplied to subscribe(). Definition at line 155 of file subscriptor.cc.
|
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.
|
inlineinherited |
List the subscribers to the input stream.
Definition at line 317 of file subscriptor.h.
|
inherited |
List the subscribers to deallog.
Definition at line 203 of file subscriptor.cc.
|
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.
|
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.
Definition at line 52 of file subscriptor.cc.
|
staticconstexpr |
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.
| const unsigned int Function< dim, RangeNumberType >::n_components |
Number of vector components.
Definition at line 163 of file function.h.
|
privateinherited |
Store the present time.
Definition at line 112 of file function_time.h.
|
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.
|
mutableprivateinherited |
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 224 of file subscriptor.h.
|
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.
|
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.
|
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.
1.11.0