Reference documentation for deal.II version GIT 891e5cc501 2022-12-03 00:25:01+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
hp::QCollection< dim > Class Template Reference

#include <deal.II/hp/q_collection.h>

Inheritance diagram for hp::QCollection< dim >:
[legend]

Public Member Functions

 QCollection ()=default
 
template<int dim_in>
 QCollection (const QCollection< dim_in > &other)
 
template<int dim_in>
 QCollection (const Quadrature< dim_in > &quadrature)
 
template<class... QTypes>
 QCollection (const QTypes &...quadrature_objects)
 
template<int dim_in>
void push_back (const Quadrature< dim_in > &new_quadrature)
 
bool operator== (const QCollection< dim > &q_collection) const
 
unsigned int max_n_quadrature_points () const
 
void push_back (const std::shared_ptr< const Quadrature< dim > > &new_entry)
 
const Quadrature< dim > & operator[] (const unsigned int index) const
 
unsigned int size () const
 
std::size_t memory_consumption () const
 
CollectionIterator< Quadrature< dim > > begin () const
 
CollectionIterator< Quadrature< dim > > end () 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 ::ExceptionBaseExcNoQuadrature ()
 
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (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 Quadrature< dim > > > 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
 

Detailed Description

template<int dim>
class hp::QCollection< dim >

This class implements a collection of quadrature 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 module described in the doxygen documentation.

Definition at line 46 of file q_collection.h.

Member Typedef Documentation

◆ map_value_type

using Subscriptor::map_value_type = decltype(counter_map)::value_type
privateinherited

The data type used in counter_map.

Definition at line 230 of file subscriptor.h.

◆ map_iterator

using Subscriptor::map_iterator = decltype(counter_map)::iterator
privateinherited

The iterator type used in counter_map.

Definition at line 235 of file subscriptor.h.

Constructor & Destructor Documentation

◆ QCollection() [1/4]

template<int dim>
hp::QCollection< dim >::QCollection ( )
default

Default constructor. Leads to an empty collection that can later be filled using push_back().

◆ QCollection() [2/4]

template<int dim>
template<int dim_in>
hp::QCollection< dim >::QCollection ( const QCollection< dim_in > &  other)

Copy constructor.

Definition at line 135 of file q_collection.h.

◆ QCollection() [3/4]

template<int dim>
template<int dim_in>
hp::QCollection< dim >::QCollection ( const Quadrature< dim_in > &  quadrature)
inlineexplicit

Conversion constructor. This constructor creates a QCollection from a single quadrature rule. More quadrature formulas can be added with push_back(), if desired, though it would probably be clearer to add all mappings the same way.

Definition at line 207 of file q_collection.h.

◆ QCollection() [4/4]

template<int dim>
template<class... QTypes>
hp::QCollection< dim >::QCollection ( const QTypes &...  quadrature_objects)
explicit

Constructor. This constructor creates a QCollection from one or more quadrature objects passed to the constructor. For this call to be valid, all arguments need to be of types derived from class Quadrature<dim>.

Definition at line 145 of file q_collection.h.

Member Function Documentation

◆ push_back() [1/2]

template<int dim>
template<int dim_in>
void hp::QCollection< dim >::push_back ( const Quadrature< dim_in > &  new_quadrature)
inline

Add a new quadrature rule to the QCollection. In most cases, you will want to add quadrature rules in the same order as the elements were added to the hp::FECollection for which this quadrature rule collection is meant. If done this way, the hp::FEValues objects with which you will use both hp::FECollection and hp::QCollection objects will automatically choose corresponding elements and quadrature formulas. On the other hand, it is possible to use arbitrary combinations of elements and quadrature formulas in hp::FECollection and hp::QCollection objects when specifically specifying appropriate indices in calls to hp::FEValues::reinit() or hp::FEFaceValues::reinit(). In those cases, there need not be a correspondence between elements of the hp::FECollection and hp::QCollection objects; they need not even be of the same size in this case.

The same arguments about the order of elements of collections can, by the way, also be made about the elements of hp::MappingCollection objects.

This class creates a copy of the given quadrature object, i.e., you can do things like push_back(QGauss<dim>(3));. The internal copy is later destroyed by this object upon destruction of the entire collection.

Definition at line 216 of file q_collection.h.

◆ operator==()

template<int dim>
bool hp::QCollection< dim >::operator== ( const QCollection< dim > &  q_collection) const
inline

Equality comparison operator. All stored Quadrature objects are compared in order.

Definition at line 190 of file q_collection.h.

◆ max_n_quadrature_points()

template<int dim>
unsigned int hp::QCollection< dim >::max_n_quadrature_points
inline

Return the maximum number of quadrature points over all the elements of the collection. This is mostly useful to initialize arrays to allocate the maximum amount of memory that may be used when re-sizing later on to a articular quadrature formula from within this collection.

Definition at line 174 of file q_collection.h.

◆ push_back() [2/2]

void hp::Collection< Quadrature< dim > >::push_back ( const std::shared_ptr< const Quadrature< dim > > &  new_entry)
inherited

Add a new object.

Definition at line 193 of file collection.h.

◆ operator[]()

const Quadrature< dim > & hp::Collection< Quadrature< dim > >::operator[] ( const unsigned int  index) const
inlineinherited

Return the object which was specified by the user for the active FE index which is provided as a parameter to this method.

Precondition
index must be between zero and the number of elements of the collection.

Definition at line 203 of file collection.h.

◆ size()

unsigned int hp::Collection< Quadrature< dim > >::size
inlineinherited

Return the number of objects stored in this container.

Definition at line 209 of file collection.h.

◆ memory_consumption()

std::size_t hp::Collection< Quadrature< dim > >::memory_consumption
inherited

Determine an estimate for the memory consumption (in bytes) of this object.

Definition at line 216 of file collection.h.

◆ begin()

CollectionIterator< Quadrature< dim > > hp::Collection< Quadrature< dim > >::begin
inherited
Returns
An iterator pointing to the beginning of the underlying data (const version).

Definition at line 223 of file collection.h.

◆ end()

CollectionIterator< Quadrature< dim > > hp::Collection< Quadrature< dim > >::end
inherited
Returns
An iterator pointing to the end of the underlying data (const version).

Definition at line 230 of file collection.h.

◆ subscribe()

void Subscriptor::subscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
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 136 of file subscriptor.cc.

◆ unsubscribe()

void Subscriptor::unsubscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
inherited

Unsubscribes a user from the object.

Note
The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 156 of file subscriptor.cc.

◆ n_subscriptions()

unsigned int Subscriptor::n_subscriptions ( ) const
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.

◆ list_subscribers() [1/2]

template<typename StreamType >
void Subscriptor::list_subscribers ( StreamType &  stream) const
inlineinherited

List the subscribers to the input stream.

Definition at line 317 of file subscriptor.h.

◆ list_subscribers() [2/2]

void Subscriptor::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 204 of file subscriptor.cc.

◆ serialize()

template<class Archive >
void Subscriptor::serialize ( Archive &  ar,
const unsigned int  version 
)
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.

◆ check_no_subscribers()

void Subscriptor::check_no_subscribers ( ) const
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.

Note
Since this function is just a consistency check it does nothing in release mode.
If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.

Definition at line 53 of file subscriptor.cc.

Member Data Documentation

◆ entries

std::vector<std::shared_ptr<const Quadrature< dim > > > hp::Collection< Quadrature< dim > >::entries
privateinherited

The real container, which stores pointers to the different objects.

Definition at line 236 of file collection.h.

◆ counter

std::atomic<unsigned int> Subscriptor::counter
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 219 of file subscriptor.h.

◆ counter_map

std::map<std::string, unsigned int> Subscriptor::counter_map
mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 225 of file subscriptor.h.

◆ validity_pointers

std::vector<std::atomic<bool> *> Subscriptor::validity_pointers
mutableprivateinherited

In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.

Definition at line 241 of file subscriptor.h.

◆ object_info

const std::type_info* Subscriptor::object_info
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 249 of file subscriptor.h.

◆ mutex

std::mutex Subscriptor::mutex
staticprivateinherited

A mutex used to ensure data consistency when printing out the list of subscribers.

Definition at line 271 of file subscriptor.h.


The documentation for this class was generated from the following file: