QSorted< dim > Class Template Reference

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

Inheritance diagram for QSorted< dim >:

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

Public Member Functions
	QSorted (const Quadrature< dim > &quad)
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

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 Member Functions
bool	compare_weights (const unsigned int a, const unsigned int b) 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
void	check_no_subscribers () const noexcept
using	map_value_type = decltype(counter_map)::value_type
using	map_iterator = decltype(counter_map)::iterator
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 std::mutex	mutex
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Detailed Description

template<int dim>
class QSorted< dim >

Sorted Quadrature. Given an arbitrary quadrature formula, this class generates a quadrature formula where the quadrature points are ordered according the weights, from those with smaller corresponding weight, to those with higher corresponding weights. This might be necessary, for example, when integrating high order polynomials, since in these cases you might sum very big numbers with very small numbers, and summation is not stable if the numbers to sum are not close to each other.

Definition at line 403 of file quadrature_lib.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 94 of file quadrature.h.

Constructor & Destructor Documentation

QSorted()

template<int dim>

QSorted< dim >::QSorted

(

const Quadrature< dim > &

quad

)

The constructor takes an arbitrary quadrature formula quad and sorts its points and weights according to ascending weights.

Definition at line 776 of file quadrature_lib.cc.

Member Function Documentation

compare_weights()

template<int dim>

bool QSorted< dim >::compare_weights ( const unsigned int  a, const unsigned int  b  ) const

private

A rule for std::sort to reorder pairs of points and weights. a and b are indices into the weights array and the result will be determined by comparing the weights.

Definition at line 808 of file quadrature_lib.cc.

operator==()

template<int dim>

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

inherited

Test for equality of two quadratures.

Definition at line 304 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 313 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 325 of file quadrature.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 290 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 296 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 305 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 311 of file quadrature.h.

---

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

• include/deal.II/base/quadrature_lib.h
• source/base/quadrature_lib.cc