Reference documentation for deal.II version GIT 90d86f7ad9 2022-05-28 14:10:02+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 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
 

Static Public Member Functions

static ::ExceptionBaseExcNoQuadrature ()
 

Private Attributes

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

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
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 
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
 
using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 
static std::mutex mutex
 
void check_no_subscribers () const noexcept
 

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.

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.

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.


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