libMesh
weighted_patch_recovery_error_estimator.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2019 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
3 
4 // This library is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU Lesser General Public
6 // License as published by the Free Software Foundation; either
7 // version 2.1 of the License, or (at your option) any later version.
8 
9 // This library is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 // Lesser General Public License for more details.
13 
14 // You should have received a copy of the GNU Lesser General Public
15 // License along with this library; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 
18 
19 
20 #ifndef LIBMESH_WEIGHTED_PATCH_RECOVERY_ERROR_ESTIMATOR_H
21 #define LIBMESH_WEIGHTED_PATCH_RECOVERY_ERROR_ESTIMATOR_H
22 
23 // C++ includes
24 #include <vector>
25 
26 // Local Includes
27 #include "libmesh/elem_range.h"
28 #include "libmesh/error_estimator.h"
29 #include "libmesh/fem_function_base.h"
30 #include "libmesh/patch_recovery_error_estimator.h"
31 #include "libmesh/patch.h"
32 
33 
34 namespace libMesh
35 {
36 
37 // Forward Declarations
38 class Elem;
39 
40 
48 {
49 public:
50 
57 
66  virtual ~WeightedPatchRecoveryErrorEstimator() = default;
67 
74  virtual void estimate_error (const System & system,
75  ErrorVector & error_per_cell,
76  const NumericVector<Number> * solution_vector = nullptr,
77  bool estimate_parent_error = false) override;
78 
83  std::vector<FEMFunctionBase<Number> *> weight_functions;
84 
85  virtual ErrorEstimatorType type() const override;
86 
87 private:
88 
94  {
95  public:
96  EstimateError (const System & sys,
98  ErrorVector & epc) :
99  system(sys),
100  error_estimator(ee),
101  error_per_cell(epc)
102  {}
103 
104  void operator()(const ConstElemRange & range) const;
105 
111  private:
112 
113  const System & system;
116  };
117 
118  friend class EstimateError;
119 };
120 
121 
122 } // namespace libMesh
123 
124 
125 #endif // LIBMESH_WEIGHTED_PATCH_RECOVERY_ERROR_ESTIMATOR_H
libMesh::WeightedPatchRecoveryErrorEstimator::operator=
WeightedPatchRecoveryErrorEstimator & operator=(const WeightedPatchRecoveryErrorEstimator &)=default
libMesh::System
Manages consistently variables, degrees of freedom, and coefficient vectors.
Definition: system.h:100
libMesh::WeightedPatchRecoveryErrorEstimator::EstimateError
Class to compute the error contribution for a range of elements.
Definition: weighted_patch_recovery_error_estimator.h:93
libMesh::PatchRecoveryErrorEstimator
This class implements the Patch Recovery error indicator.
Definition: patch_recovery_error_estimator.h:55
libMesh::ErrorEstimatorType
ErrorEstimatorType
Defines an enum for the different types of error estimators which are available.
Definition: enum_error_estimator_type.h:33
libMesh
The libMesh namespace provides an interface to certain functionality in the library.
Definition: factoryfunction.C:55
libMesh::WeightedPatchRecoveryErrorEstimator::WeightedPatchRecoveryErrorEstimator
WeightedPatchRecoveryErrorEstimator()=default
Constructor.
libMesh::WeightedPatchRecoveryErrorEstimator::weight_functions
std::vector< FEMFunctionBase< Number > * > weight_functions
Vector of fem function base pointers, the user will fill this in with pointers to the appropriate wei...
Definition: weighted_patch_recovery_error_estimator.h:83
libMesh::WeightedPatchRecoveryErrorEstimator
This class implements the Patch Recovery error indicator.
Definition: weighted_patch_recovery_error_estimator.h:47
libMesh::WeightedPatchRecoveryErrorEstimator::EstimateError::error_estimator
const WeightedPatchRecoveryErrorEstimator & error_estimator
Definition: weighted_patch_recovery_error_estimator.h:114
libMesh::NumericVector< Number >
libMesh::WeightedPatchRecoveryErrorEstimator::EstimateError::error_per_cell
ErrorVector & error_per_cell
Definition: weighted_patch_recovery_error_estimator.h:115
libMesh::ErrorVector
The ErrorVector is a specialization of the StatisticsVector for error data computed on a finite eleme...
Definition: error_vector.h:50
libMesh::WeightedPatchRecoveryErrorEstimator::~WeightedPatchRecoveryErrorEstimator
virtual ~WeightedPatchRecoveryErrorEstimator()=default
libMesh::WeightedPatchRecoveryErrorEstimator::estimate_error
virtual void estimate_error(const System &system, ErrorVector &error_per_cell, const NumericVector< Number > *solution_vector=nullptr, bool estimate_parent_error=false) override
This function uses the Patch Recovery error estimate to estimate the error on each cell.
Definition: weighted_patch_recovery_error_estimator.C:55
libMesh::StoredRange
The StoredRange class defines a contiguous, divisible set of objects.
Definition: stored_range.h:52
libMesh::WeightedPatchRecoveryErrorEstimator::EstimateError::operator()
void operator()(const ConstElemRange &range) const
Definition: weighted_patch_recovery_error_estimator.C:112
libMesh::WeightedPatchRecoveryErrorEstimator::type
virtual ErrorEstimatorType type() const override
Definition: weighted_patch_recovery_error_estimator.C:48
libMesh::WeightedPatchRecoveryErrorEstimator::EstimateError::system
const System & system
Function to set the boolean patch_reuse in case the user wants to change the default behaviour of pat...
Definition: weighted_patch_recovery_error_estimator.h:113
libMesh::WeightedPatchRecoveryErrorEstimator::EstimateError::EstimateError
EstimateError(const System &sys, const WeightedPatchRecoveryErrorEstimator &ee, ErrorVector &epc)
Definition: weighted_patch_recovery_error_estimator.h:96