deal.II version GIT relicensing-2076-g6b43d56a25 2024-11-02 12:30:00+00:00
|
#include <deal.II/hp/mapping_collection.h>
Public Member Functions | |
MappingCollection ()=default | |
MappingCollection (const Mapping< dim, spacedim > &mapping) | |
template<class... MappingTypes> | |
MappingCollection (const MappingTypes &...mappings) | |
MappingCollection (const MappingCollection< dim, spacedim > &mapping_collection) | |
MappingCollection (MappingCollection< dim, spacedim > &&) noexcept(std::is_nothrow_move_constructible< std::vector< std::shared_ptr< const Mapping< dim, spacedim > > > >::value &&std::is_nothrow_move_constructible< std::function< unsigned int(const typename hp::MappingCollection< dim, spacedim > &, const unsigned int)> >::value)=default | |
MappingCollection< dim, spacedim > & | operator= (MappingCollection< dim, spacedim > &&)=default |
void | push_back (const Mapping< dim, spacedim > &new_mapping) |
void | push_back (const std::shared_ptr< const T > &new_entry) |
const T & | operator[] (const unsigned int index) const |
unsigned int | size () const |
bool | empty () const |
std::size_t | memory_consumption () const |
CollectionIterator< T > | begin () const |
CollectionIterator< T > | end () const |
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) |
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::vector< std::shared_ptr< const T > > | entries |
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 implements a collection of mapping objects in the same way as the hp::FECollection implements a collection of finite element classes.
It implements the concepts stated in the hp-Collections topic described in the doxygen documentation.
Although it is recommended to supply an appropriate mapping for each finite element kind used in a hp-computation, the MappingCollection class implements a conversion constructor from a single mapping. Therefore it is possible to offer only a single mapping to the hp::FEValues class instead of a hp::MappingCollection. This is for the convenience of the user, as many simple geometries do not require different mappings along the boundary to achieve optimal convergence rates. Hence providing a single mapping object will usually suffice. See the hp::FEValues class for the rules which mapping will be selected for a given cell.
Definition at line 56 of file mapping_collection.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.
|
default |
Default constructor. Leads to an empty collection that can later be filled using push_back().
|
explicit |
Conversion constructor. This constructor creates a MappingCollection from a single mapping. More mappings can be added with push_back(), if desired, though it would probably be clearer to add all mappings the same way.
Definition at line 28 of file mapping_collection.cc.
|
explicit |
Constructor. This constructor creates a MappingCollection from one or more mapping objects passed to the constructor. For this call to be valid, all arguments need to be of types derived from class Mapping<dim,spacedim>.
Definition at line 159 of file mapping_collection.h.
hp::MappingCollection< dim, spacedim >::MappingCollection | ( | const MappingCollection< dim, spacedim > & | mapping_collection | ) |
Copy constructor.
Definition at line 37 of file mapping_collection.cc.
|
defaultnoexcept |
Move constructor.
|
default |
Move assignment operator.
void hp::MappingCollection< dim, spacedim >::push_back | ( | const Mapping< dim, spacedim > & | new_mapping | ) |
Add a new mapping to the MappingCollection. Generally, you will want to use the same order for mappings as for the elements of the hp::FECollection object you use. However, the same considerations as discussed with the hp::QCollection::push_back() function also apply in the current context.
This class creates a copy of the given mapping object, i.e., you can do things like push_back(MappingQ<dim>(3));
. The internal copy is later destroyed by this object upon destruction of the entire collection.
Definition at line 48 of file mapping_collection.cc.
|
inherited |
Add a new object.
Definition at line 306 of file collection.h.
|
inlineinherited |
Return the object which was specified by the user for the active FE index which is provided as a parameter to this method.
index
must be between zero and the number of elements of the collection. Definition at line 333 of file collection.h.
|
inlineinherited |
Return the number of objects stored in this container.
Definition at line 315 of file collection.h.
|
inlineinherited |
The return value of this function is equivalent to size() == 0
Definition at line 324 of file collection.h.
|
inherited |
Determine an estimate for the memory consumption (in bytes) of this object.
Definition at line 297 of file collection.h.
|
inherited |
const
version). Definition at line 343 of file collection.h.
|
inherited |
const
version). Definition at line 352 of file collection.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 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.
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.
|
privateinherited |
The real container, which stores pointers to the different objects.
Definition at line 287 of file collection.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.