![]() |
Reference documentation for deal.II version 9.6.0
|
#include <deal.II/meshworker/local_integrator.h>
Public Member Functions | |
LocalIntegrator () | |
LocalIntegrator (bool use_cell, bool use_boundary, bool use_face) | |
virtual | ~LocalIntegrator () override=default |
virtual void | cell (DoFInfo< dim, spacedim, number > &dinfo, IntegrationInfo< dim, spacedim > &info) const |
virtual void | boundary (DoFInfo< dim, spacedim, number > &dinfo, IntegrationInfo< dim, spacedim > &info) const |
virtual void | face (DoFInfo< dim, spacedim, number > &dinfo1, DoFInfo< dim, spacedim, number > &dinfo2, IntegrationInfo< dim, spacedim > &info1, IntegrationInfo< dim, spacedim > &info2) 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 & | ExcPureFunction () |
static ::ExceptionBase & | ExcInUse (int arg1, std::string arg2, std::string arg3) |
static ::ExceptionBase & | ExcNoSubscriber (std::string arg1, std::string arg2) |
Public Attributes | |
bool | use_cell |
bool | use_boundary |
bool | use_face |
std::vector< std::string > | input_vector_names |
std::vector< std::string > | output_names |
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 local integrator object, which can be used to simplify the call of loop(). Instead of providing the three local integration functions separately, we bundle them as virtual functions in this class.
Additionally, since we cannot have a virtual null function, we provide flags, which allow us to indicate, whether we want to integrate on boundary and interior faces. These flags are true by default, but can be modified by applications to speed up the loop.
If a function is not overloaded in a derived class, but its usage flag is true, the function will cause an exception ExcPureFunction.
Definition at line 59 of file local_integrator.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.
MeshWorker::LocalIntegrator< dim, spacedim, number >::LocalIntegrator | ( | ) |
The constructor setting default values, namely all integration flags to true.
Definition at line 60 of file mesh_worker.cc.
MeshWorker::LocalIntegrator< dim, spacedim, number >::LocalIntegrator | ( | bool | use_cell, |
bool | use_boundary, | ||
bool | use_face ) |
The constructor setting integration flags to specified values.
Definition at line 68 of file mesh_worker.cc.
|
overridevirtualdefault |
The empty virtual destructor.
|
virtual |
Virtual function for integrating on cells. Throws exception PureFunctionCalled if not overloaded by a derived class.
Definition at line 80 of file mesh_worker.cc.
|
virtual |
Virtual function for integrating on boundary faces. Throws exception PureFunctionCalled if not overloaded by a derived class.
Definition at line 90 of file mesh_worker.cc.
|
virtual |
Virtual function for integrating on interior faces. Throws exception PureFunctionCalled if not overloaded by a derived class.
Definition at line 100 of file mesh_worker.cc.
|
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.
bool MeshWorker::LocalIntegrator< dim, spacedim, number >::use_cell |
The flag indicating whether the cell integrator cell() is to be used in the loop. Defaults to true
.
Definition at line 106 of file local_integrator.h.
bool MeshWorker::LocalIntegrator< dim, spacedim, number >::use_boundary |
The flag indicating whether the boundary integrator boundary() is to be used in the loop. Defaults to true
.
Definition at line 112 of file local_integrator.h.
bool MeshWorker::LocalIntegrator< dim, spacedim, number >::use_face |
The flag indicating whether the interior face integrator face() is to be used in the loop. Defaults to true
.
Definition at line 118 of file local_integrator.h.
std::vector<std::string> MeshWorker::LocalIntegrator< dim, spacedim, number >::input_vector_names |
The names of the input vectors. If this vector is nonempty, it can be used by application programs to automatically select and verify the input vectors used for integration.
Definition at line 132 of file local_integrator.h.
std::vector<std::string> MeshWorker::LocalIntegrator< dim, spacedim, number >::output_names |
The names of the results produced. If this vector is nonempty, it can be used by application programs to automatically assign names to output values and/or verify the names of vectors.
Definition at line 146 of file local_integrator.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.