Reference documentation for deal.II version 9.6.0
|
#include <deal.II/base/function.h>
Public Types | |
using | time_type |
Public Member Functions | |
VectorFunctionFromTensorFunction (const TensorFunction< 1, dim, RangeNumberType > &tensor_function, const unsigned int selected_component=0, const unsigned int n_components=dim) | |
virtual | ~VectorFunctionFromTensorFunction () override=default |
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_list (const std::vector< Point< dim > > &points, std::vector< Vector< RangeNumberType > > &value_list) const override |
virtual Tensor< 1, dim, RangeNumberType > | gradient (const Point< dim > &p, const unsigned int component=0) const override |
virtual void | vector_gradient (const Point< dim > &p, std::vector< Tensor< 1, dim, RangeNumberType > > &gradients) const override |
virtual void | gradient_list (const std::vector< Point< dim > > &points, std::vector< Tensor< 1, dim, RangeNumberType > > &gradients, const unsigned int component=0) const override |
virtual void | vector_gradients (const std::vector< Point< dim > > &points, std::vector< std::vector< Tensor< 1, dim, RangeNumberType > > > &gradients) const override |
virtual void | vector_gradient_list (const std::vector< Point< dim > > &points, std::vector< std::vector< Tensor< 1, dim, RangeNumberType > > > &gradients) 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 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 ::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 |
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 TensorFunction< 1, dim, RangeNumberType > & | tensor_function |
const unsigned int | selected_component |
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 built as a means of translating the Tensor<1,dim, RangeNumberType>
values produced by objects of type TensorFunction and returning them as a multiple component version of the same thing as a Vector for use in, for example, the VectorTools::interpolate or the many other functions taking Function objects. It allows the user to place the desired components into an n_components
long vector starting at the selected_component
location in that vector and have all other components be 0.
For example: Say you created a class called
which extends the TensorFunction class and you have an object
of that class which you want to interpolate onto your mesh using the VectorTools::interpolate function, but the finite element you use for the DoFHandler object has 3 copies of a finite element with dim
components, for a total of 3*dim components. To interpolate onto that DoFHandler, you need an object of type Function that has 3*dim vector components. Creating such an object from the existing rhs
object is done using this piece of code:
where the dim
components of the tensor function are placed into the first dim
components of the function object.
Definition at line 1093 of file function.h.
|
inherited |
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 |
Given a TensorFunction object that takes a Point
and returns a Tensor<1,dim, RangeNumberType>
value, convert this into an object that matches the Function<dim> interface.
By default, create a Vector object of the same size as tensor_function
returns, i.e., with dim
components.
tensor_function | The TensorFunction that will form one component of the resulting Vector Function object. |
n_components | The total number of vector components of the resulting TensorFunction object. |
selected_component | The first component that should be filled by the first argument. This should be such that the entire tensor_function fits inside the n_component length return vector. |
|
overridevirtualdefault |
This destructor is defined as virtual so as to coincide with all other aspects of class.
|
overridevirtual |
Return a single component of a vector-valued function at a given point.
Reimplemented from Function< dim, double >.
|
overridevirtual |
Return all components of a vector-valued function at a given point.
values
shall have the right size beforehand, i.e. n_components.
|
overridevirtual |
Return all components of a vector-valued function at a list of points.
value_list
shall be the same size as points
and each element of the vector will be passed to vector_value() to evaluate the function
|
overridevirtual |
Return the gradient of the specified component of the function at the given point.
Reimplemented from Function< dim, double >.
|
overridevirtual |
Return the gradient of all components of the function at the given point.
|
overridevirtual |
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.
|
overridevirtual |
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.
|
overridevirtual |
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.
|
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 a given component at point p
.
Reimplemented in Functions::ConstantFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, double >, Functions::IdentityFunction< dim, RangeNumberType >, and Functions::SymbolicFunction< dim, RangeNumberType >.
|
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 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 >.
|
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 ComponentSelectFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, RangeNumberType >, and Functions::ConstantFunction< dim, double >.
|
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.
|
private |
The TensorFunction object which we call when this class's vector_value() or vector_value_list() functions are called.
Definition at line 1209 of file function.h.
|
private |
The first vector component whose value is to be filled by the given TensorFunction. The values will be placed in components selected_component to selected_component+dim-1 for a TensorFunction<1,dim, RangeNumberType>
object.
Definition at line 1217 of file function.h.
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.
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.