Reference documentation for deal.II version 9.4.1
\(\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\}}\)
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
QIterated< dim > Class Template Reference

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

Inheritance diagram for QIterated< dim >:
[legend]

Public Types

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

Public Member Functions

 QIterated (const Quadrature< 1 > &base_quadrature, const unsigned int n_copies)
 
 QIterated (const Quadrature< 1 > &base_quadrature, const std::vector< Point< 1 > > &intervals)
 
 QIterated (const Quadrature< 1 > &, const std::vector< Point< 1 > > &)
 
 QIterated (const Quadrature< 1 > &, const unsigned int)
 
 QIterated (const Quadrature< 1 > &base_quadrature, const std::vector< Point< 1 > > &intervals)
 
 QIterated (const Quadrature< 1 > &base_quadrature, const unsigned int n_copies)
 
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
 

Static Public Member Functions

static ::ExceptionBaseExcInvalidQuadratureFormula ()
 

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
 

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 ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 
using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 
std::atomic< unsigned intcounter
 
std::map< std::string, unsigned intcounter_map
 
std::vector< std::atomic< bool > * > validity_pointers
 
const std::type_info * object_info
 
static std::mutex mutex
 
void check_no_subscribers () const noexcept
 

Detailed Description

template<int dim>
class QIterated< dim >

Quadrature formula constructed by iteration of another quadrature formula in each direction. In more than one space dimension, the resulting quadrature formula is constructed in the usual way by building the tensor product of the respective iterated quadrature formula in one space dimension.

In one space dimension, the given base formula is copied and scaled onto a given number of subintervals of length 1/n_copies. If the quadrature formula uses both end points of the unit interval, then in the interior of the iterated quadrature formula there would be quadrature points which are used twice; we merge them into one with a weight which is the sum of the weights of the left- and the rightmost quadrature point.

Since all dimensions higher than one are built up by tensor products of one dimensional and dim-1 dimensional quadrature formulae, the argument given to the constructor needs to be a quadrature formula in one space dimension, rather than in dim dimensions.

The aim of this class is to provide a low order formula, where the error constant can be tuned by increasing the number of quadrature points. This is useful in integrating non-differentiable functions on cells.

Definition at line 371 of file quadrature.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

◆ QIterated() [1/6]

template<int dim>
QIterated< dim >::QIterated ( const Quadrature< 1 > &  base_quadrature,
const unsigned int  n_copies 
)

Constructor. Iterate the given quadrature formula n_copies times in each direction. The result is a tensor product quadrature formula defined on the unit hypercube (i.e., the line segment, unit square, or unit cube in 1d, 2d, and 3d respectively).

Definition at line 630 of file quadrature.cc.

◆ QIterated() [2/6]

template<int dim>
QIterated< dim >::QIterated ( const Quadrature< 1 > &  base_quadrature,
const std::vector< Point< 1 > > &  intervals 
)

Constructor. Iterate the given quadrature formula on the given subintervals defined by adjacent points in intervals in each direction. The resulting quadrature rule will have base_quadrature.size() * (intervals.size() - 1) quadrature points if no quadrature point of base_quadrature is positioned on the boundaries. The result is a tensor product quadrature formula defined on the unit hypercube (i.e., the line segment, unit square, or unit cube in 1d, 2d, and 3d respectively).

Note
We require that intervals.front() == 0 and interval.back() == 1.

Definition at line 621 of file quadrature.cc.

◆ QIterated() [3/6]

QIterated< 0 >::QIterated ( const Quadrature< 1 > &  ,
const std::vector< Point< 1 > > &   
)

Definition at line 476 of file quadrature.cc.

◆ QIterated() [4/6]

QIterated< 0 >::QIterated ( const Quadrature< 1 > &  ,
const unsigned int   
)

Definition at line 485 of file quadrature.cc.

◆ QIterated() [5/6]

QIterated< 1 >::QIterated ( const Quadrature< 1 > &  base_quadrature,
const std::vector< Point< 1 > > &  intervals 
)

Definition at line 494 of file quadrature.cc.

◆ QIterated() [6/6]

QIterated< 1 >::QIterated ( const Quadrature< 1 > &  base_quadrature,
const unsigned int  n_copies 
)

Definition at line 605 of file quadrature.cc.

Member Function Documentation

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