Reference documentation for deal.II version GIT relicensing43g3fc2fae7c3 20240303 21:10:02+00:00

#include <deal.II/base/quadrature_lib.h>
Public Types  
using  SubQuadrature = Quadrature< dim==0 ? 0 :dim  1 > 
Public Member Functions  
QWitherdenVincentSimplex (const unsigned int n_points_1D, const bool use_odd_order=true)  
template<int spacedim = dim>  
Quadrature< spacedim >  compute_affine_transformation (const std::array< Point< spacedim >, dim+1 > &vertices) const 
template<int spacedim = dim>  
Quadrature< spacedim >  mapped_quadrature (const std::vector< std::array< Point< spacedim >, dim+1 > > &simplices) const 
bool  operator== (const Quadrature< dim > &p) const 
void  initialize (const std::vector< Point< dim > > &points, const std::vector< double > &weights) 
unsigned int  size () const 
bool  empty () 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 ::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 
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 
WitherdenVincent rules for simplex entities.
Like QGauss, users should specify a number n_points_1d
as an indication of what polynomial degree to be integrated exactly (e.g., for \(n\) points, the rule can integrate polynomials of degree \(2 n  1\) exactly). Additionally, since these rules were derived for simplices, there are also evenordered rules (i.e., they integrate polynomials of degree \(2 n\)) available which do not have analogous 1d rules.
The given value for n_points_1d = 1, 2, 3, 4, 5, 6, 7 (where the last two are only implemented in 2d) results in the following number of quadrature points in 2d and 3d:
For 1d, the quadrature rule degenerates to a QGauss<1>(n_points_1d)
and use_odd_order
is ignored.
These rules match the ones listed for WitherdenVincent in the quadpy [172] library and were first described in [190].
Also see Simplex support.
Definition at line 946 of file quadrature_lib.h.

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 0dimensional quadrature is defined as still being 0dimensional.
Definition at line 129 of file quadrature.h.

privateinherited 
The data type used in counter_map.
Definition at line 229 of file subscriptor.h.

privateinherited 
The iterator type used in counter_map.
Definition at line 234 of file subscriptor.h.

explicit 
Constructor taking the equivalent number of quadrature points in 1d n_points_1d
and boolean indicating whether the rule should be order \(2 n  1\) or \(2 n\): see the general documentation of this class for more information.
Definition at line 1806 of file quadrature_lib.cc.

inherited 
Return an affine transformation of this quadrature, that can be used to integrate on the simplex identified by vertices
.
Both the quadrature point locations and the weights are transformed, so that you can effectively use the resulting quadrature to integrate on the simplex.
The transformation is defined as
\[ x = v_0 + B \hat x \]
where the matrix \(B\) is given by \(B_{ij} = v[j][i]v[0][i]\).
The weights are scaled with the absolute value of the determinant of \(B\), that is \(J \dealcoloneq \text{det}(B)\). If \(J\) is zero, an empty quadrature is returned. This may happen, in two dimensions, if the three vertices are aligned, or in three dimensions if the four vertices are on the same plane. The present function works also in the codimension one and codimension two case. For instance, when dim=2
and spacedim=3
, we can map the quadrature points so that they live on the physical triangle embedded in the three dimensional space. In such a case, the matrix \(B\) is not square anymore.
[in]  vertices  The vertices of the simplex you wish to integrate on 
Definition at line 1473 of file quadrature_lib.cc.

inherited 
Given a collection of simplices, this function creates a global quadrature rule on the area covered by the simplices, by mapping the current quadrature on each simplex. A simplex is identified by its vertices, which are stored into an array of Points. Hence, this function can provide quadrature rules on polygons (or polyhedra), as they can be split into simplices.
simplices  A std::vector where each entry is an array of dim+1 points, which identifies the vertices of a simplex. 
Definition at line 1507 of file quadrature_lib.cc.

inherited 
Test for equality of two quadratures.
Definition at line 316 of file quadrature.cc.

inherited 
Set the quadrature points and weights to the values provided in the arguments.
Definition at line 51 of file quadrature.cc.

inherited 
Number of quadrature points.

inherited 
Return if quadrature is empty.

inherited 
Return the i
th quadrature point.

inherited 
Return a reference to the whole array of quadrature points.

inherited 
Return the weight of the i
th quadrature point.

inherited 
Return a reference to the whole array of weights.

inherited 
Determine an estimate for the memory consumption (in bytes) of this object.
Definition at line 325 of file quadrature.cc.

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

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

inherited 
In case the quadrature formula is a tensor product, this function returns the dim
onedimensional 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
).
Definition at line 337 of file quadrature.cc.

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 135 of file subscriptor.cc.

inherited 
Unsubscribes a user from the object.
identifier
and the validity
pointer must be the same as the one supplied to subscribe(). Definition at line 155 of file subscriptor.cc.

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.

inlineinherited 
List the subscribers to the input stream
.
Definition at line 317 of file subscriptor.h.

inherited 
List the subscribers to deallog
.
Definition at line 203 of file subscriptor.cc.

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.
Definition at line 52 of file subscriptor.cc.

protectedinherited 
List of quadrature points. To be filled by the constructors of derived classes.
Definition at line 338 of file quadrature.h.

protectedinherited 
List of weights of the quadrature points. To be filled by the constructors of derived classes.
Definition at line 344 of file quadrature.h.

protectedinherited 
Indicates if this object represents quadrature formula that is a tensor product of onedimensional formulas. This flag is set if dim==1 or the constructors taking a Quadrature<1> (and possibly a Quadrature<dim1> object) is called. This implies that the quadrature points are sorted lexicographically.
Definition at line 353 of file quadrature.h.

protectedinherited 
Stores the onedimensional tensor basis objects in case this object can be represented by a tensor product.
Definition at line 359 of file quadrature.h.

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 218 of file subscriptor.h.

mutableprivateinherited 
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 224 of file subscriptor.h.

mutableprivateinherited 
In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.
Definition at line 240 of file subscriptor.h.

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 248 of file subscriptor.h.

staticprivateinherited 
A mutex used to ensure data consistency when accessing the mutable
members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers()
.
Definition at line 271 of file subscriptor.h.