Reference documentation for deal.II version Git fff2869c79 20200120 12:00:24 0500

#include <deal.II/numerics/error_estimator.h>
Public Types  
enum  Strategy { cell_diameter_over_24 = 0, face_diameter_over_twice_max_degree, cell_diameter } 
Static Public Member Functions  
template<typename InputVector , typename DoFHandlerType >  
static void  estimate (const Mapping< dim, spacedim > &mapping, const DoFHandlerType &dof, const Quadrature< dim  1 > &quadrature, const std::map< types::boundary_id, const Function< spacedim, typename InputVector::value_type > *> &neumann_bc, const InputVector &solution, Vector< float > &error, const ComponentMask &component_mask=ComponentMask(), const Function< spacedim > *coefficients=nullptr, const unsigned int n_threads=numbers::invalid_unsigned_int, const types::subdomain_id subdomain_id=numbers::invalid_subdomain_id, const types::material_id material_id=numbers::invalid_material_id, const Strategy strategy=cell_diameter_over_24) 
template<typename InputVector , typename DoFHandlerType >  
static void  estimate (const DoFHandlerType &dof, const Quadrature< dim  1 > &quadrature, const std::map< types::boundary_id, const Function< spacedim, typename InputVector::value_type > *> &neumann_bc, const InputVector &solution, Vector< float > &error, const ComponentMask &component_mask=ComponentMask(), const Function< spacedim > *coefficients=nullptr, const unsigned int n_threads=numbers::invalid_unsigned_int, const types::subdomain_id subdomain_id=numbers::invalid_subdomain_id, const types::material_id material_id=numbers::invalid_material_id, const Strategy strategy=cell_diameter_over_24) 
template<typename InputVector , typename DoFHandlerType >  
static void  estimate (const Mapping< dim, spacedim > &mapping, const DoFHandlerType &dof, const Quadrature< dim  1 > &quadrature, const std::map< types::boundary_id, const Function< spacedim, typename InputVector::value_type > *> &neumann_bc, const std::vector< const InputVector *> &solutions, std::vector< Vector< float > *> &errors, const ComponentMask &component_mask=ComponentMask(), const Function< spacedim > *coefficients=nullptr, const unsigned int n_threads=numbers::invalid_unsigned_int, const types::subdomain_id subdomain_id=numbers::invalid_subdomain_id, const types::material_id material_id=numbers::invalid_material_id, const Strategy strategy=cell_diameter_over_24) 
template<typename InputVector , typename DoFHandlerType >  
static void  estimate (const DoFHandlerType &dof, const Quadrature< dim  1 > &quadrature, const std::map< types::boundary_id, const Function< spacedim, typename InputVector::value_type > *> &neumann_bc, const std::vector< const InputVector *> &solutions, std::vector< Vector< float > *> &errors, const ComponentMask &component_mask=ComponentMask(), const Function< spacedim > *coefficients=nullptr, const unsigned int n_threads=numbers::invalid_unsigned_int, const types::subdomain_id subdomain_id=numbers::invalid_subdomain_id, const types::material_id material_id=numbers::invalid_material_id, const Strategy strategy=cell_diameter_over_24) 
template<typename InputVector , typename DoFHandlerType >  
static void  estimate (const Mapping< dim, spacedim > &mapping, const DoFHandlerType &dof, const hp::QCollection< dim  1 > &quadrature, const std::map< types::boundary_id, const Function< spacedim, typename InputVector::value_type > *> &neumann_bc, const InputVector &solution, Vector< float > &error, const ComponentMask &component_mask=ComponentMask(), const Function< spacedim > *coefficients=nullptr, const unsigned int n_threads=numbers::invalid_unsigned_int, const types::subdomain_id subdomain_id=numbers::invalid_subdomain_id, const types::material_id material_id=numbers::invalid_material_id, const Strategy strategy=cell_diameter_over_24) 
template<typename InputVector , typename DoFHandlerType >  
static void  estimate (const DoFHandlerType &dof, const hp::QCollection< dim  1 > &quadrature, const std::map< types::boundary_id, const Function< spacedim, typename InputVector::value_type > *> &neumann_bc, const InputVector &solution, Vector< float > &error, const ComponentMask &component_mask=ComponentMask(), const Function< spacedim > *coefficients=nullptr, const unsigned int n_threads=numbers::invalid_unsigned_int, const types::subdomain_id subdomain_id=numbers::invalid_subdomain_id, const types::material_id material_id=numbers::invalid_material_id, const Strategy strategy=cell_diameter_over_24) 
template<typename InputVector , typename DoFHandlerType >  
static void  estimate (const Mapping< dim, spacedim > &mapping, const DoFHandlerType &dof, const hp::QCollection< dim  1 > &quadrature, const std::map< types::boundary_id, const Function< spacedim, typename InputVector::value_type > *> &neumann_bc, const std::vector< const InputVector *> &solutions, std::vector< Vector< float > *> &errors, const ComponentMask &component_mask=ComponentMask(), const Function< spacedim > *coefficients=nullptr, const unsigned int n_threads=numbers::invalid_unsigned_int, const types::subdomain_id subdomain_id=numbers::invalid_subdomain_id, const types::material_id material_id=numbers::invalid_material_id, const Strategy strategy=cell_diameter_over_24) 
template<typename InputVector , typename DoFHandlerType >  
static void  estimate (const DoFHandlerType &dof, const hp::QCollection< dim  1 > &quadrature, const std::map< types::boundary_id, const Function< spacedim, typename InputVector::value_type > *> &neumann_bc, const std::vector< const InputVector *> &solutions, std::vector< Vector< float > *> &errors, const ComponentMask &component_mask=ComponentMask(), const Function< spacedim > *coefficients=nullptr, const unsigned int n_threads=numbers::invalid_unsigned_int, const types::subdomain_id subdomain_id=numbers::invalid_subdomain_id, const types::material_id material_id=numbers::invalid_material_id, const Strategy strategy=cell_diameter_over_24) 
static ::ExceptionBase &  ExcInvalidComponentMask () 
static ::ExceptionBase &  ExcInvalidCoefficient () 
static ::ExceptionBase &  ExcInvalidBoundaryFunction (types::boundary_id arg1, int arg2, int arg3) 
static ::ExceptionBase &  ExcIncompatibleNumberOfElements (int arg1, int arg2) 
static ::ExceptionBase &  ExcNoSolutions () 
Implementation of the error indicator by Kelly, De S. R. Gago, Zienkiewicz and Babuska and its modification for the hpFEM. This error indicator tries to approximate the error per cell by integration of the jump of the gradient of the solution along the faces of each cell. It can be understood as a gradient recovery estimator; see the survey of Ainsworth and Oden, "A Posteriori Error Estimation in Finite Element Analysis" (Wiley, 2000) for a complete discussion.
In the original Kelly error estimator, the contribution of each face to the cell error is scaled with the cell diagonal. In the modified version, however, we employ a scaling factor which depends on the face diagonal and polynomial degrees of the adjacent elements. The choice between the two is done by means of the enumerator, defined within the class.
The error estimator really only estimates the error for the generalized Poisson equation \(\nabla\cdot a(x) \nabla u = f\) with either Dirichlet boundary conditions or generalized Neumann boundary conditions involving the conormal derivative \(a\frac{du}{dn} = g\).
The error estimator returns a vector of estimated errors per cell which can be used to feed the GridRefinement::refine_and_coarsen_fixed_fraction(), GridRefinement::refine_and_coarsen_fixed_number(), and similar functions. This vector contains elements of data type float
, rather than double
, since accuracy is not important in the current context.
The full reference for the paper in which this error estimator is defined is as follows:
In principle, the implementation of the error estimation is simple: let
\[ \eta_K^2 = \sum_{F\in\partial K} c_F \int_{\partial K_F} \left[a \frac{\partial u_h}{\partial n}\right]^2 do \]
be the error estimator for cell \(K\). \([\cdot]\) denotes the jump of the argument at the face. In the paper of Ainsworth \( c_F=\frac {h_K}{24} \), but this factor is a bit esoteric, stemming from interpolation estimates and stability constants which may hold for the Poisson problem, but may not hold for more general situations. Alternatively, we consider the case when \( c_F=\frac {h_F}{2p_F} \), where \( h_F \) is face diagonal and \( p_F=max(p^+,p^) \) is the maximum polynomial degree of adjacent elements; or \(c_F=h_K\). The choice between these factors is done by means of the enumerator, provided as the last argument in all functions.
To perform the integration, use is made of the FEFaceValues and FESubfaceValues classes. The integration is performed by looping over all cells and integrating over faces that are not yet treated. This way we avoid integration on faces twice, once for each time we visit one of the adjacent cells. In a second loop over all cells, we sum up the contributions of the faces (which are the integrated square of the jumps times some factor) of each cell and take the square root.
The integration is done using a quadrature formula on the face provided by the caller of the estimate() functions declared by this class. For linear trial functions (FE_Q(1)), QGauss with two points or even the QMidpoint rule might actually suffice. For higher order elements, it is necessary to utilize higher order quadrature formulae with fe.degree+1
Gauss points.
We store the contribution of each face in a map
, as provided by the C++ standard library, with the iterator pointing to that face being the key into the map. When looping the second time over all cells, we have to sum up the contributions of the faces and take the square root. For the Kelly estimator, the multiplication with \(\frac {h_K}{24}\) is done in the second loop. By doing so we avoid problems to decide with which \(h_K\) to multiply, that of the cell on the one or that of the cell on the other side of the face. Whereas for the hpestimator the map
stores integrals multiplied by \(\frac {h_F}{2p_F}\), which are then summed in the second loop.
\(h_K\) ( \(h_F\)) is taken to be the greatest length of the diagonals of the cell (face). For more or less uniform cells (faces) without deformed angles, this coincides with the diameter of the cell (face).
If the finite element field for which the error is to be estimated is vectorvalued, i.e. the finite element has more than one component, then all the above can be applied to all or only some components at the same time. The main function of this class takes a list of flags denoting the components for which components the error estimator is to be applied; by default, it is a list of only trues
, meaning that all variables shall be treated.
In case the different components of a field have different physical meaning (for example velocity and pressure in the Stokes equations), it would be senseless to use the same coefficient for all components. In that case, you can pass a function with as many components as there are components in the finite element field and each component of the error estimator will then be weighted by the respective component in this coefficient function. In the other case, when all components have the same meaning (for example the displacements in Lamé's equations of elasticity), you can specify a scalar coefficient which will then be used for all components.
If the face is at the boundary, i.e. there is no neighboring cell to which the jump in the gradient could be computed, there are two possibilities:
The face belongs to a Dirichlet boundary. Then the face is not considered, which can be justified looking at a dual problem technique and should hold exactly if the boundary can be approximated exactly by the finite element used (i.e. it is a linear boundary for linear finite elements, quadratic for isoparametric quadratic elements, etc). For boundaries which can not be exactly approximated, one should consider the difference \(zz_h\) on the face, \(z\) being a dual problem's solution which is zero at the true boundary and \(z_h\) being an approximation, which in most cases will be zero on the numerical boundary. Since on the numerical boundary \(z\) will not be zero in general, we would get another term here, but this one is neglected for practical reasons, in the hope that the error made here will tend to zero faster than the energy error we wish to estimate.
Though no integration is necessary, in the list of face contributions we store a zero for this face, which makes summing up the contributions of the different faces to the cells easier.
The face belongs to a Neumann boundary. In this case, the contribution of the face \(F\in\partial K\) looks like
\[ n_F\int_F \leftga\frac{\partial u_h}{\partial n}\right^2 ds \]
where \(g\) is the Neumann boundary function, \(n_F=\frac {h_K}{24}\) and \(n_F=\frac {h_F}{p}\) for the Kelly and hpestimator, respectively. If the finite element is vector valued, then obviously the function denoting the Neumann boundary conditions needs to be vectorvalued as well.
In practice, if you have Robin boundary conditions or are too lazy to accurately describe Neumann values, then this is rarely an issue: if you don't say anything in the map about a particular part of the boundary then the Kelly indicator will simply assume that the solution is correct on that part of the boundary and not touch it. Of course, if you have a have a Neumann or Robin boundary, that isn't quite true, there is going to be a difference between the normal derivative of the numerical solution and the Neumann values these normal derivatives should equal. So if we simply ignore those parts of the boundary, we'll underestimate the error. In practice, this rarely appears to be a problem – you may not refine the cell this time around but you'll probably refine it in the next refinement step and everything is good again. After all, for all problems but the Laplace equation, the Kelly indicator is only an indicator, not an estimator, and so the values it computes are not exact error representations anyway.
The integration along faces with hanging nodes is quite tricky, since one of the elements has to be shifted one level up or down. See the documentation for the FESubFaceValues class for more information about technical issues regarding this topic.
In praxi, since we integrate over each face only once, we do this when we are on the coarser one of the two cells adjacent to a subface (a subface is defined to be the child of a face; seen from the coarse cell, it is a subface, while seen from the refined cell it is one of its faces). The reason is that finding neighborship information is a bit easier then, but that's all practical reasoning, nothing fundamental.
Since we integrate from the coarse side of the face, we have the mother face readily at hand and store the result of the integration over that mother face (being the sum of the integrals along the subfaces) in the abovementioned map of integrals as well. This consumes some memory more than needed, but makes the summing up of the face contributions to the cells easier, since then we have the information from all faces of all cells at hand and need not think about explicitly determining whether a face was refined or not. The same applies for boundary faces, see above.
In some cases, for example in timedependent problems, one would like to compute the error estimates for several solution vectors on the same grid at once, with the same coefficients, boundary condition object, etc, e.g. for the solutions on several successive time steps. One could then call the functions of this class several times for each solution. However, the largest factor in the computation of the error estimates (in terms of computing time) is initialization of FEFaceValues and FESubFaceValues objects, and iterating through all faces and subfaces. If the solution vectors live on the same grid, this effort can be reduced significantly by treating all solution vectors at the same time, initializing the FEFaceValues objects only once per cell and for all solution vectors at once, and also only looping through the triangulation only once. For this reason, besides the estimate
function in this class that takes a single input vector and returns a single output vector, there is also a function that accepts several in and output vectors at the same time.
Definition at line 262 of file error_estimator.h.
enum KellyErrorEstimator::Strategy 
The enum type given to the class functions to decide on the scaling factors of the face integrals.
Definition at line 269 of file error_estimator.h.

static 
Implementation of the error estimator described above. You may give a coefficient, but there is a default value which denotes the constant coefficient with value one. The coefficient function may either be a scalar one, in which case it is used for all components of the finite element, or a vectorvalued one with as many components as there are in the finite element; in the latter case, each component is weighted by the respective component in the coefficient.
You might give a list of components you want to evaluate, in case the finite element used by the DoFHandler object is vectorvalued. You then have to set those entries to true in the bitvector component_mask
(see GlossComponentMask ) for which the respective component is to be used in the error estimator. The default is to use all components, which is done by either providing a bitvector with allset entries, or an empty bitvector.
The subdomain_id
parameter indicates whether we shall compute indicators for all cells (in case its value is the default, numbers::invalid_unsigned_int
), or only for the cells belonging to a certain subdomain with the given indicator. The latter case is used for parallel computations where all processor nodes have the global grid stored, and could well compute all the indicators for all cells themselves, but where it is more efficient to have each process compute only indicators for the cells it owns, and have them exchange the resulting information afterwards. This is in particular true for the case where meshes are very large and computing indicators for every cell is too expensive, while computing indicators for only local cells is acceptable. Note that if you only ask for the indicators of a certain subdomain to be computed, you must nevertheless make sure that this function has access to the correct node values of all degrees of freedom. This is since the function needs to access DoF values on neighboring cells as well, even if they belong to a different subdomain.
The material_id
parameter has a similar meaning: if not set to its default value (which is numbers::invalid_material_id), it means that indicators will only be computed for cells with this particular material id.
The n_threads
parameter used to indicate the number of threads to be used to compute the error estimator. This parameter is now ignored, with the number of threads determined automatically. The parameter is retained for compatibility with old versions of the library.
The strategy
parameter is used to choose the scaling factor for the integral over cell's faces.

static 
Call the estimate
function, see above, with mapping=MappingQGeneric<dim>(1)
.

static 
Same function as above, but accepts more than one solution vector and returns one error vector for each solution vector. For the reason of existence of this function, see the general documentation of this class.
Since we do not want to force the user of this function to copy around their solution vectors, the vector of solution vectors takes pointers to the solutions, rather than being a vector of vectors. This makes it simpler to have the solution vectors somewhere in memory, rather than to have them collected somewhere special. (Note that it is not possible to construct of vector of references, so we had to use a vector of pointers.)

static 
Call the estimate
function, see above, with mapping=MappingQGeneric<dim>(1)
.

static 
Equivalent to the set of functions above, except that this one takes a quadrature collection for hp finite element dof handlers.

static 
Equivalent to the set of functions above, except that this one takes a quadrature collection for hp finite element dof handlers.

static 
Equivalent to the set of functions above, except that this one takes a quadrature collection for hp finite element dof handlers.

static 
Equivalent to the set of functions above, except that this one takes a quadrature collection for hp finite element dof handlers.