libMesh
adjoint_refinement_estimator.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2017 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_ADJOINT_REFINEMENT_ESTIMATOR_H
21 #define LIBMESH_ADJOINT_REFINEMENT_ESTIMATOR_H
22 
23 // Local Includes
24 #include "libmesh/error_estimator.h"
25 #include "libmesh/libmesh.h"
26 #include "libmesh/qoi_set.h"
27 
28 // C++ includes
29 #include <cstddef>
30 #include <vector>
31 
32 // Forward declarations
33 class DifferentiablePhysics;
34 
35 #ifdef LIBMESH_ENABLE_AMR
36 
37 namespace libMesh
38 {
39 
51 {
52 public:
53 
62  _qoi_set(QoISet())
63  {
64  // We're not actually going to use error_norm; our norms are
65  // absolute values of QoI error.
67  }
68 
73 
78  QoISet & qoi_set() { return _qoi_set; }
79 
84  const QoISet & qoi_set() const { return _qoi_set; }
85 
102  virtual void estimate_error (const System & system,
103  ErrorVector & error_per_cell,
104  const NumericVector<Number> * solution_vector = libmesh_nullptr,
105  bool estimate_parent_error = false);
106 
111  Number & get_global_QoI_error_estimate(unsigned int qoi_index)
112  {
113  return computed_global_QoI_errors[qoi_index];
114  }
115 
116  virtual ErrorEstimatorType type() const
117  { return ADJOINT_REFINEMENT;}
118 
122  unsigned char number_h_refinements;
123 
127  unsigned char number_p_refinements;
128 
134  { return this->_residual_evaluation_physics; }
135 
140  { this->_residual_evaluation_physics = set_physics; }
141 
142 protected:
143 
149 
150  /* A vector to hold the computed global QoI error estimate */
151  std::vector<Number> computed_global_QoI_errors;
152 
157 };
158 
159 } // namespace libMesh
160 
161 #endif // #ifdef LIBMESH_ENABLE_AMR
162 
163 #endif // LIBMESH_ADJOINT_REFINEMENT_ESTIMATOR_H
DifferentiablePhysics * get_residual_evaluation_physics()
QoISet & qoi_set()
Access to the QoISet (default: weight all QoIs equally) to use when computing errors.
SystemNorm error_norm
When estimating the error in a single system, the error_norm is used to control the scaling and norm ...
This class implements a ``brute force&#39;&#39; goal-oriented error estimator which computes an estimate of e...
Data structure for specifying which Quantities of Interest should be calculated in an adjoint or a pa...
Definition: qoi_set.h:45
The ErrorVector is a specialization of the StatisticsVector for error data computed on a finite eleme...
Definition: error_vector.h:50
const class libmesh_nullptr_t libmesh_nullptr
The libMesh namespace provides an interface to certain functionality in the library.
QoISet _qoi_set
A QoISet to handle cases with multiple QoIs available.
const QoISet & qoi_set() const
Access to the QoISet (default: weight all QoIs equally) to use when computing errors.
This is the base class for classes which contain information related to any physical process that mig...
Definition: system.h:76
This class holds functions that will estimate the error in a finite element solution on a given mesh...
Number & get_global_QoI_error_estimate(unsigned int qoi_index)
This is an accessor function to access the computed global QoI error estimates.
DifferentiablePhysics * _residual_evaluation_physics
Pointer to object to use for physics assembly evaluations.
void set_residual_evaluation_physics(DifferentiablePhysics *set_physics)
Set the _residual_evaluation_physics member to argument.
This class provides a specific system class.
Definition: diff_physics.h:74
virtual void estimate_error(const System &system, ErrorVector &error_per_cell, const NumericVector< Number > *solution_vector=libmesh_nullptr, bool estimate_parent_error=false)
This function does uniform refinements and an adjoint solve to get an adjoint solution on each cell...
unsigned char number_h_refinements
How many h refinements to perform to get the fine grid.
unsigned char number_p_refinements
How many p refinements to perform to get the fine grid.
virtual ErrorEstimatorType type() const