uniform_refinement_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_UNIFORM_REFINEMENT_ESTIMATOR_H
#define LIBMESH_UNIFORM_REFINEMENT_ESTIMATOR_H

// Local Includes
#include "libmesh/error_estimator.h"
#include "libmesh/libmesh.h"

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

#ifdef LIBMESH_ENABLE_AMR

namespace libMesh
{

class UniformRefinementEstimator : public ErrorEstimator
{
public:

  UniformRefinementEstimator();

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

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

  virtual void estimate_errors (const EquationSystems & equation_systems,
                                ErrorVector & error_per_cell,
                                const std::map<const System *, SystemNorm> & error_norms,
                                const std::map<const System *, const NumericVector<Number> *> * solution_vectors = nullptr,
                                bool estimate_parent_error = false) override;

  virtual void estimate_errors (const EquationSystems & equation_systems,
                                ErrorMap & errors_per_cell,
                                const std::map<const System *, const NumericVector<Number> *> * solution_vectors = nullptr,
                                bool estimate_parent_error = false) override;

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

  virtual ErrorEstimatorType type() const override;

  unsigned char number_h_refinements;

  unsigned char number_p_refinements;

protected:

  int _extra_order;

  virtual void _estimate_error (const EquationSystems * equation_systems,
                                const System * system,
                                ErrorVector * error_per_cell,
                                ErrorMap * errors_per_cell,
                                const std::map<const System *, SystemNorm > * error_norms,
                                const std::map<const System *, const NumericVector<Number> *> * solution_vectors = nullptr,
                                bool estimate_parent_error = false);
};

} // namespace libMesh

#endif // #ifdef LIBMESH_ENABLE_AMR

#endif // LIBMESH_UNIFORM_REFINEMENT_ESTIMATOR_H