 |
Reference documentation for deal.II version 9.3.3
|
|
Reference documentation for deal.II version 9.3.3
|
#include <deal.II/base/function.h>
Public Types | |
| using | time_type = typename FunctionTime< typename numbers::NumberTraits< double >::real_type >::time_type |
Public Member Functions | |
| IdentityFunction () | |
| 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 |
| virtual RangeNumberType | laplacian (const Point< dim > &p, const unsigned int component=0) const override |
| virtual SymmetricTensor< 2, dim, RangeNumberType > | hessian (const Point< dim > &p, const unsigned int component=0) 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 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 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 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 const unsigned int | dimension |
Private Attributes | |
| 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. | |
| 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) |
| 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 |
| using | map_value_type = decltype(counter_map)::value_type |
| using | map_iterator = decltype(counter_map)::iterator |
| static std::mutex | mutex |
| static ::ExceptionBase & | ExcInUse (int arg1, std::string arg2, std::string arg3) |
| static ::ExceptionBase & | ExcNoSubscriber (std::string arg1, std::string arg2) |
| void | check_no_subscribers () const noexcept |
A function whose output is also its input. One possible application of this function is interpolating or projecting a finite element field that represents spatial coordinates: e.g., one can set up a finite element field to interpolate the positions of a Triangulation's cells with this function (via VectorTools::interpolate()), which is useful when doing calculations in a Lagrangian reference frame.
Definition at line 530 of file function.h.
|
inherited |
The scalar-valued real type used for representing time.
Definition at line 169 of file function.h.
| Functions::IdentityFunction< dim, RangeNumberType >::IdentityFunction | ( | ) |
Constructor. The number of components is set to dim.
|
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 >.
|
overridevirtual |
Return the gradient of the specified component of the function at the given point.
Reimplemented from Function< dim, double >.
|
overridevirtual |
Compute the Laplacian of a given component at point p.
Reimplemented from Function< dim, double >.
|
overridevirtual |
Compute the Hessian of a given component at point p, that is the gradient of the gradient of the function.
Reimplemented from Function< dim, double >.
|
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 >.
|
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 >.
|
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 >.
|
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.
|
virtualinherited |
Return the gradient of all components of the function at the given point.
Reimplemented in Functions::ConstantFunction< dim, double >.
|
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 >.
|
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.
|
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 >.
|
virtualinherited |
Compute the Laplacian of all components at point p and store them in values.
|
virtualinherited |
Compute the Laplacian of one component at a set of points.
|
virtualinherited |
Compute the Laplacians of all components at a set of points.
|
virtualinherited |
Compute the Hessian of all components at point p and store them in values.
|
virtualinherited |
Compute the Hessian of one component at a set of points.
|
virtualinherited |
Compute the Hessians of all components at a set of points.
|
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 >.
|
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.
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.
Number of vector components.
Definition at line 164 of file function.h.
|
privateinherited |
Store the present time.
Definition at line 113 of file function_time.h.
1.9.3