![]() |
Reference documentation for deal.II version 9.6.0
|
#include <deal.II/meshworker/vector_selector.h>
Public Member Functions | |
void | add (const std::string &name, const bool values=true, const bool gradients=false, const bool hessians=false) |
void | initialize (const AnyData &) |
bool | empty () const |
bool | has_values () const |
bool | has_gradients () const |
bool | has_hessians () const |
unsigned int | n_values () const |
unsigned int | n_gradients () const |
unsigned int | n_hessians () const |
unsigned int | value_index (const unsigned int i) const |
unsigned int | gradient_index (const unsigned int i) const |
unsigned int | hessian_index (const unsigned int i) const |
template<typename StreamType , typename DATA > | |
void | print (StreamType &s, const AnyData &v) const |
template<typename StreamType > | |
void | print (StreamType &s) const |
std::size_t | memory_consumption () const |
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) |
Protected Attributes | |
NamedSelection | value_selection |
NamedSelection | gradient_selection |
NamedSelection | hessian_selection |
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 | |
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 |
A class that selects vectors from a list of named vectors.
Since the number of vectors in an AnyData object may grow with every nesting of applications or loops, it is important to be able to select those, which are actually used in computing residuals etc. This class organizes the selection.
Definition at line 47 of file vector_selector.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.
|
inline |
Add a vector to the selection of finite element functions. The arguments are the name of the vector and indicators, which information is to be extracted from the vector. The name refers to an entry in a AnyData object, which will be identified by initialize(). The three bool parameters indicate, whether values, gradients and Hessians of the finite element function are to be computed on each cell or face.
Definition at line 416 of file vector_selector.h.
|
inline |
Does the same as the function above but it is possible to select a block of the global vector. Initialize the selection field with a data vector. While add() only enters the names of vectors, which will be used in the integration loop over cells and faces, this function links the names to actual vectos in a AnyData object.
Definition at line 442 of file vector_selector.h.
|
inline |
Check whether any vector is selected.
Definition at line 450 of file vector_selector.h.
|
inline |
Return true if values are selected for any vector.
Definition at line 458 of file vector_selector.h.
|
inline |
Return true if gradients are selected for any vector.
Definition at line 465 of file vector_selector.h.
|
inline |
Return true if hessians are selected for any vector.
Definition at line 472 of file vector_selector.h.
|
inline |
Number of vectors for values
Definition at line 479 of file vector_selector.h.
|
inline |
Number of vectors for gradients
Definition at line 486 of file vector_selector.h.
|
inline |
Number of vectors for Hessians
Definition at line 493 of file vector_selector.h.
The vector index for the ith value
Definition at line 500 of file vector_selector.h.
The vector index for the ith gradient
Definition at line 507 of file vector_selector.h.
The vector index for the ith Hessian
Definition at line 514 of file vector_selector.h.
|
inline |
Print the contents of the selection to the stream.
Definition at line 531 of file vector_selector.h.
|
inline |
Print the number of selections to the stream.
Definition at line 522 of file vector_selector.h.
|
inline |
The memory used by this object.
Definition at line 547 of file vector_selector.h.
|
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.
|
protected |
Selection of the vectors used to compute values.
Definition at line 170 of file vector_selector.h.
|
protected |
Selection of the vectors used to compute gradients.
Definition at line 175 of file vector_selector.h.
|
protected |
Selection of the vectors used to compute hessians.
Definition at line 180 of file vector_selector.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.