Reference documentation for deal.II version Git f9e0250abc 2021-03-01 16:46:02 +0100
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>

template<class... QTypes>

template<int dim_in>

const Quadrature< dim > & operator[] (const unsigned int index) const

bool operator== (const QCollection< dim > &q_collection) const

unsigned int size () 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 ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)

## 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 44 of file q_collection.h.

## ◆ 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 161 of file q_collection.h.

## ◆ QCollection() [3/4]

template<int dim>
template<int dim_in>
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 253 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 171 of file q_collection.h.

## ◆ push_back()

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 271 of file q_collection.h.

## ◆ operator[]()

template<int dim>
 const Quadrature< dim > & hp::QCollection< dim >::operator[] ( const unsigned int index ) const
inline

Return a reference to the quadrature rule specified by the argument.

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

Definition at line 226 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 236 of file q_collection.h.

## ◆ size()

template<int dim>
 unsigned int hp::QCollection< dim >::size ( ) const
inline

Return the number of quadrature pointers stored in this object.

Definition at line 200 of file q_collection.h.

template<int dim>
 unsigned int hp::QCollection< dim >::max_n_quadrature_points ( ) const
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 209 of file q_collection.h.

## ◆ memory_consumption()

template<int dim>
 std::size_t hp::QCollection< dim >::memory_consumption ( ) const
inline

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

Definition at line 262 of file q_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 301 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 318 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 310 of file subscriptor.h.