Reference documentation for deal.II version 9.2.0
\(\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 Attributes | List of all members
hp::QCollection< dim > Class Template Reference

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

Inheritance diagram for hp::QCollection< dim >:

Public Member Functions

 QCollection ()=default
 QCollection (const Quadrature< dim > &quadrature)
template<class... QTypes>
 QCollection (const QTypes &... quadrature_objects)
void push_back (const Quadrature< dim > &new_quadrature)
const Quadrature< dim > & operator[] (const unsigned int index) const
bool operator== (const QCollection< dim > &q_collection) const
unsigned int size () const
unsigned int max_n_quadrature_points () const
std::size_t memory_consumption () const
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 Subscriptor (const Subscriptor &)
 Subscriptor (Subscriptor &&) noexcept
virtual ~Subscriptor ()
Subscriptoroperator= (const Subscriptor &)
Subscriptoroperator= (Subscriptor &&) noexcept
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
template<class Archive >
void serialize (Archive &ar, const unsigned int version)

Static Public Member Functions

static ::ExceptionBaseExcNoQuadrature ()
- Static Public Member Functions inherited from Subscriptor
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)

Private Attributes

std::vector< std::shared_ptr< const Quadrature< dim > > > quadratures

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.

Oliver Kayser-Herold, 2005

Definition at line 48 of file q_collection.h.

Constructor & Destructor Documentation

◆ QCollection() [1/3]

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

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

◆ QCollection() [2/3]

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

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

◆ QCollection() [3/3]

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

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

Member Function Documentation

◆ push_back()

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

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

◆ operator[]()

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

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

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

Definition at line 202 of file q_collection.h.

◆ operator==()

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

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

Definition at line 212 of file q_collection.h.

◆ size()

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

Return the number of quadrature pointers stored in this object.

Definition at line 176 of file q_collection.h.

◆ max_n_quadrature_points()

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

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

◆ memory_consumption()

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

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

Definition at line 237 of file q_collection.h.

Member Data Documentation

◆ quadratures

template<int dim>
std::vector<std::shared_ptr<const Quadrature<dim> > > hp::QCollection< dim >::quadratures

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

Definition at line 148 of file q_collection.h.

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