deal.II version GIT relicensing-2206-gaa53ff9447 2024-12-02 09:10:00+00:00
|
#include <deal.II/base/function.h>
Public Types | |
using | time_type = typename FunctionTime< typename numbers::NumberTraits< RangeNumberType >::real_type >::time_type |
Public Member Functions | |
ComponentSelectFunction (const unsigned int selected, const RangeNumberType value, const unsigned int n_components) | |
ComponentSelectFunction (const unsigned int selected, const unsigned int n_components) | |
ComponentSelectFunction (const std::pair< unsigned int, unsigned int > &selected, const unsigned int n_components) | |
virtual void | substitute_function_value_with (const Functions::ConstantFunction< dim, RangeNumberType > &f) |
virtual void | vector_value (const Point< dim > &p, Vector< RangeNumberType > &return_value) const override |
virtual void | vector_value_list (const std::vector< Point< dim > > &points, std::vector< Vector< RangeNumberType > > &values) const override |
virtual std::size_t | memory_consumption () const override |
virtual RangeNumberType | value (const Point< dim > &p, const unsigned int component=0) const override |
virtual void | value_list (const std::vector< Point< dim > > &points, std::vector< RangeNumberType > &return_values, 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 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_gradient_list (const std::vector< Point< dim > > &points, std::vector< std::vector< Tensor< 1, dim, RangeNumberType > > > &gradients) const override |
virtual SymmetricTensor< 2, dim, RangeNumberType > | hessian (const Point< dim > &point, const unsigned int component=0) const override |
virtual RangeNumberType | laplacian (const Point< dim > &point, const unsigned int component=0) const override |
virtual void | vector_values (const std::vector< Point< dim > > &points, std::vector< std::vector< RangeNumberType > > &values) const |
virtual void | vector_gradients (const std::vector< Point< dim > > &points, std::vector< std::vector< Tensor< 1, dim, RangeNumberType > > > &gradients) 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 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 |
Number | get_time () const |
virtual void | set_time (const Number new_time) |
virtual void | advance_time (const Number delta_t) |
template<class Archive > | |
void | serialize (Archive &ar, const unsigned int version) |
EnableObserverPointer functionality | |
Classes derived from EnableObserverPointer provide a facility to subscribe to this object. This is mostly used by the ObserverPointer 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 |
Protected Attributes | |
const std::pair< unsigned int, unsigned int > | selected_components |
std::vector< RangeNumberType > | function_value_vector |
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 | |
Number | 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 is a constant vector-valued function, in which one or more components of the vector have a constant value and all other components are zero. It is especially useful as a weight function for VectorTools::integrate_difference, where it allows to integrate only one or a few vector components, rather than the entire vector-valued solution. In other words, it acts as a component mask with a single component selected (see the the glossary entry on component masks). See the step-20 tutorial program for a detailed explanation and a use case.
Definition at line 580 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 238 of file enable_observer_pointer.h.
|
privateinherited |
The iterator type used in counter_map.
Definition at line 243 of file enable_observer_pointer.h.
ComponentSelectFunction< dim, RangeNumberType >::ComponentSelectFunction | ( | const unsigned int | selected, |
const RangeNumberType | value, | ||
const unsigned int | n_components | ||
) |
Constructor if only a single component shall be non-zero. Arguments denote the component selected, the value for that component and the total number of vector components.
ComponentSelectFunction< dim, RangeNumberType >::ComponentSelectFunction | ( | const unsigned int | selected, |
const unsigned int | n_components | ||
) |
Constructor. As before, but the value for the selected component is assumed to be one. In essence, this function then works as a mask.
ComponentSelectFunction< dim, RangeNumberType >::ComponentSelectFunction | ( | const std::pair< unsigned int, unsigned int > & | selected, |
const unsigned int | n_components | ||
) |
Constructor if multiple components shall have non-zero, unit values (i.e. this should be a mask for multiple components). The first argument denotes a half-open interval of components (for example std::pair(0,dim) for the first dim components), and the second argument is the total number of vector components.
|
virtual |
Substitute function value with value of a ConstantFunction<dim, RangeNumberType>
object and keep the current selection pattern.
This is useful if you want to have different values in different components since the provided constructors of ComponentSelectFunction<dim, RangeNumberType>
class can only have same value for all components.
f
from its beginning. So the number of components of f
cannot be less than the calling object.
|
overridevirtual |
Return the value of the function at the given point for all components.
Reimplemented from Functions::ConstantFunction< dim, RangeNumberType >.
|
overridevirtual |
Set values
to the point values of the function at the points
, for all components. It is assumed that values
already has the right size, i.e. the same size as the points
array.
Reimplemented from Functions::ConstantFunction< dim, RangeNumberType >.
|
overridevirtual |
Return an estimate for the memory consumption, in bytes, of this object.
Reimplemented from Functions::ConstantFunction< dim, RangeNumberType >.
|
overridevirtualinherited |
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, RangeNumberType >.
|
overridevirtualinherited |
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 from Function< dim, RangeNumberType >.
|
overridevirtualinherited |
Return the gradient of the specified component of the function at the given point.
Reimplemented from Function< dim, RangeNumberType >.
|
overridevirtualinherited |
Return the gradient of all components of the function at the given point.
Reimplemented from Function< dim, RangeNumberType >.
|
overridevirtualinherited |
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 from Function< dim, RangeNumberType >.
|
overridevirtualinherited |
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 from Function< dim, RangeNumberType >.
|
overridevirtualinherited |
Compute the Hessian of a given component at point p
, that is the gradient of the gradient of the function.
Reimplemented from Function< dim, RangeNumberType >.
|
overridevirtualinherited |
Compute the Laplacian of a given component at point p
.
Reimplemented from Function< dim, RangeNumberType >.
|
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 |
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.
Reimplemented in VectorFunctionFromTensorFunction< dim, RangeNumberType >.
|
virtualinherited |
Compute the Laplacian of all components at point p
and store them in values
.
Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >.
|
virtualinherited |
Compute the Laplacian of one component at a set of points.
Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >.
|
virtualinherited |
Compute the Laplacians of all components at a set of points.
Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >.
|
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.
|
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 131 of file enable_observer_pointer.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 151 of file enable_observer_pointer.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 322 of file enable_observer_pointer.h.
|
inlineinherited |
List the subscribers to the input stream
.
Definition at line 339 of file enable_observer_pointer.h.
|
inherited |
List the subscribers to deallog
.
Definition at line 199 of file enable_observer_pointer.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 331 of file enable_observer_pointer.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 53 of file enable_observer_pointer.cc.
|
protected |
Half-open interval of the indices of selected components.
Definition at line 656 of file function.h.
|
protectedinherited |
Store the constant function value vector.
Definition at line 492 of file function.h.
|
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.
|
inherited |
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 227 of file enable_observer_pointer.h.
|
mutableprivateinherited |
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 233 of file enable_observer_pointer.h.
|
mutableprivateinherited |
In this vector, we store pointers to the validity bool in the ObserverPointer objects that subscribe to this class.
Definition at line 249 of file enable_observer_pointer.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 257 of file enable_observer_pointer.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 280 of file enable_observer_pointer.h.