patch_recovery_error_estimator.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2025 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_PATCH_RECOVERY_ERROR_ESTIMATOR_H
#define LIBMESH_PATCH_RECOVERY_ERROR_ESTIMATOR_H

// Local Includes
#include "libmesh/error_estimator.h"
#include "libmesh/patch.h"
#include "libmesh/point.h"
#include "libmesh/elem_range.h"

// C++ includes
#include <cstddef>
#include <vector>

namespace libMesh
{

// Forward Declarations
class Elem;
enum Order : int;

class PatchRecoveryErrorEstimator : public ErrorEstimator
{
public:

  PatchRecoveryErrorEstimator();

  PatchRecoveryErrorEstimator (const PatchRecoveryErrorEstimator &) = default;
  PatchRecoveryErrorEstimator (PatchRecoveryErrorEstimator &&) = default;
  PatchRecoveryErrorEstimator & operator= (const PatchRecoveryErrorEstimator &) = default;
  PatchRecoveryErrorEstimator & operator= (PatchRecoveryErrorEstimator &&) = default;
  virtual ~PatchRecoveryErrorEstimator() = default;

  virtual void estimate_error (const System & system,
                               ErrorVector & error_per_cell,
                               const NumericVector<Number> * solution_vector = nullptr,
                               bool estimate_parent_error = false) override;

  unsigned int target_patch_size;

  Patch::PMF patch_growth_strategy;

  void set_patch_reuse (bool);

  void extra_quadrature_order (const int extraorder)
  { _extra_order = extraorder; }

  virtual ErrorEstimatorType type() const override;

protected:

  static std::vector<Real> specpoly(const unsigned int dim,
                                    const Order order,
                                    const Point p,
                                    const unsigned int matsize);

  bool patch_reuse;

  int _extra_order;

private:

  class EstimateError
  {
  public:
    EstimateError (const System & sys,
                   const PatchRecoveryErrorEstimator & ee,
                   ErrorVector & epc) :
      system(sys),
      error_estimator(ee),
      error_per_cell(epc)
    {}

    void operator()(const ConstElemRange & range) const;

  private:
    const System & system;
    const PatchRecoveryErrorEstimator & error_estimator;
    ErrorVector & error_per_cell;
  };

  friend class EstimateError;
};


} // namespace libMesh


#endif // LIBMESH_PATCH_RECOVERY_ERROR_ESTIMATOR_H