#include <deal.II/base/quadrature_selector.h>

Inheritance diagram for QuadratureSelector< dim >:

Public Types
using	SubQuadrature = Quadrature< dim==0 ? 0 :dim - 1 >

Public Member Functions
	QuadratureSelector (const std::string &s, const unsigned int order=0)

bool	operator== (const Quadrature< dim > &p) const

void	initialize (const std::vector< Point< dim > > &points, const std::vector< double > &weights)

unsigned int	size () const

const Point< dim > &	point (const unsigned int i) const

const std::vector< Point< dim > > &	get_points () const

double	weight (const unsigned int i) const

const std::vector< double > &	get_weights () const

std::size_t	memory_consumption () const

template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

bool	is_tensor_product () const

const std::array< Quadrature< 1 >, dim > &	get_tensor_basis () const

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 std::string	get_quadrature_names ()

static ::ExceptionBase &	ExcInvalidQGaussOrder (int arg1)

static ::ExceptionBase &	ExcInvalidOrder (std::string arg1, unsigned int arg2)

static ::ExceptionBase &	ExcInvalidQuadrature (std::string arg1)

static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Protected Attributes
std::vector< Point< dim > >	quadrature_points

std::vector< double >	weights

bool	is_tensor_product_flag

std::unique_ptr< std::array< Quadrature< 1 >, dim > >	tensor_basis

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

Static Private Member Functions
static Quadrature< dim >	create_quadrature (const std::string &s, const unsigned int order)

Private Attributes
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 QuadratureSelector< dim >

This class implements the quadrature rule passed to its constructor as a string. Supported quadratures are QGauss (of all orders), QMidpoint, QMilne, QSimpson, QTrapezoid and QWeddle.

This class is useful if you want to use flexible quadrature rules, that are read from a parameter file (see ParameterHandler for this).

Definition at line 41 of file quadrature_selector.h.

Member Typedef Documentation

◆ SubQuadrature

template<int dim>

using Quadrature< dim >::SubQuadrature = Quadrature<dim == 0 ? 0 : dim - 1>

inherited

Define an alias for a quadrature that acts on an object of one dimension less. For cells, this would then be a face quadrature. A sub quadrature of a 0-dimensional quadrature is defined as still being 0-dimensional.

Definition at line 130 of file quadrature.h.

◆ 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

◆ QuadratureSelector()

template<int dim>

QuadratureSelector< dim >::QuadratureSelector	(	const std::string &	s,
		const unsigned int	order = `0`
	)

Constructor. Takes the name of the quadrature rule (one of "gauss", "milne", "weddle", etc) and, if it is "gauss", the number of quadrature points in each coordinate direction.

Definition at line 68 of file quadrature_selector.cc.

Member Function Documentation

◆ get_quadrature_names()

template<int dim>

std::string QuadratureSelector< dim >::get_quadrature_names

static

This function returns all possible names for quadratures as a list separated by |, so that you can use it for the definition of parameter files (see ParameterHandler for details).

Definition at line 78 of file quadrature_selector.cc.

◆ create_quadrature()

template<int dim>

Quadrature< dim > QuadratureSelector< dim >::create_quadrature	(	const std::string &	s,
		const unsigned int	order
	)

staticprivate

This static function creates a quadrature object according to the name given as a string, and the appropriate order (if the name is "gauss"). It is called from the constructor.

Definition at line 24 of file quadrature_selector.cc.

◆ operator==()

template<int dim>

bool Quadrature< dim >::operator== ( const Quadrature< dim > & p ) const

inherited

Test for equality of two quadratures.

Definition at line 317 of file quadrature.cc.

◆ initialize()

template<int dim>

void Quadrature< dim >::initialize	(	const std::vector< Point< dim > > &	points,
		const std::vector< double > &	weights
	)

inherited

Set the quadrature points and weights to the values provided in the arguments.

Definition at line 52 of file quadrature.cc.

◆ size()

template<int dim>

unsigned int Quadrature< dim >::size ( ) const

inherited

Number of quadrature points.

◆ point()

template<int dim>

const Point< dim > & Quadrature< dim >::point ( const unsigned int i ) const

inherited

Return the ith quadrature point.

◆ get_points()

template<int dim>

const std::vector< Point< dim > > & Quadrature< dim >::get_points ( ) const

inherited

Return a reference to the whole array of quadrature points.

◆ weight()

template<int dim>

double Quadrature< dim >::weight ( const unsigned int i ) const

inherited

Return the weight of the ith quadrature point.

◆ get_weights()

template<int dim>

const std::vector< double > & Quadrature< dim >::get_weights ( ) const

inherited

Return a reference to the whole array of weights.

◆ memory_consumption()

template<int dim>

std::size_t Quadrature< dim >::memory_consumption

inherited

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

Definition at line 326 of file quadrature.cc.

◆ serialize()

template<int dim>

template<class Archive >

void Quadrature< dim >::serialize	(	Archive &	ar,
		const unsigned int	version
	)

inherited

Write or read the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

◆ is_tensor_product()

template<int dim>

bool Quadrature< dim >::is_tensor_product ( ) const

inherited

This function returns true if the quadrature object is a tensor product of one-dimensional formulas and the quadrature points are sorted lexicographically.

◆ get_tensor_basis()

template<int dim>

std::conditional< dim==1, std::array< Quadrature< 1 >, dim >, conststd::array< Quadrature< 1 >, dim > & >::type Quadrature< dim >::get_tensor_basis

inherited

In case the quadrature formula is a tensor product, this function returns the dim one-dimensional basis objects. Otherwise, calling this function is not allowed.

For dim equal to one, we can not return the std::array as a const reference and have to return it by value. In this case, the array will always contain a single element (this).

Note: The actual return type of this function is
std::conditional<dim == 1,

std::array<Quadrature<1>, dim>,

const std::array<Quadrature<1>, dim> &>::type

The type is abbreviated in the online documentation to improve readability of this page.

Definition at line 338 of file quadrature.cc.

◆ 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.

◆ 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

◆ quadrature_points

template<int dim>

std::vector<Point<dim> > Quadrature< dim >::quadrature_points

protectedinherited

List of quadrature points. To be filled by the constructors of derived classes.

Definition at line 333 of file quadrature.h.

◆ weights

template<int dim>

std::vector<double> Quadrature< dim >::weights

protectedinherited

List of weights of the quadrature points. To be filled by the constructors of derived classes.

Definition at line 339 of file quadrature.h.

◆ is_tensor_product_flag

template<int dim>

bool Quadrature< dim >::is_tensor_product_flag

protectedinherited

Indicates if this object represents quadrature formula that is a tensor product of one-dimensional formulas. This flag is set if dim==1 or the constructors taking a Quadrature<1> (and possibly a Quadrature<dim-1> object) is called. This implies that the quadrature points are sorted lexicographically.

Definition at line 348 of file quadrature.h.

◆ tensor_basis

template<int dim>

std::unique_ptr<std::array<Quadrature<1>, dim> > Quadrature< dim >::tensor_basis

protectedinherited

Stores the one-dimensional tensor basis objects in case this object can be represented by a tensor product.

Definition at line 354 of file quadrature.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 files:

include/deal.II/base/quadrature_selector.h
source/base/quadrature_selector.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ SubQuadrature

◆ map_value_type

◆ map_iterator

Constructor & Destructor Documentation

◆ QuadratureSelector()

Member Function Documentation

◆ get_quadrature_names()

◆ create_quadrature()

◆ operator==()

◆ initialize()

◆ size()

◆ point()

◆ get_points()

◆ weight()

◆ get_weights()

◆ memory_consumption()

◆ serialize()

◆ is_tensor_product()

◆ get_tensor_basis()

◆ subscribe()

◆ unsubscribe()

◆ n_subscriptions()

◆ list_subscribers() [1/2]

◆ list_subscribers() [2/2]

◆ check_no_subscribers()

Member Data Documentation

◆ quadrature_points

◆ weights

◆ is_tensor_product_flag

◆ tensor_basis

◆ counter

◆ counter_map

◆ validity_pointers

◆ object_info

◆ mutex