adjoint_refinement_estimator.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2024 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_ADJOINT_REFINEMENT_ESTIMATOR_H
#define LIBMESH_ADJOINT_REFINEMENT_ESTIMATOR_H

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

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

#ifdef LIBMESH_ENABLE_AMR

namespace libMesh
{

// Forward declarations
class DifferentiablePhysics;

class AdjointRefinementEstimator : public ErrorEstimator
{
public:

  AdjointRefinementEstimator();

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

  QoISet & qoi_set() { return _qoi_set; }

  const QoISet & qoi_set() const { return _qoi_set; }

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

  Number & get_global_QoI_error_estimate(unsigned int qoi_index)
  {
    return computed_global_QoI_errors[qoi_index];
  }

  virtual ErrorEstimatorType type() const override;

  unsigned char number_h_refinements;

  unsigned char number_p_refinements;

  DifferentiablePhysics * get_residual_evaluation_physics()
  { return this->_residual_evaluation_physics; }

  void set_residual_evaluation_physics(DifferentiablePhysics* set_physics)
  { this->_residual_evaluation_physics = set_physics; }

  DifferentiablePhysics * get_adjoint_evaluation_physics()
  { return this->_adjoint_evaluation_physics; }

  void set_adjoint_evaluation_physics(DifferentiablePhysics* set_physics)
  { this->_adjoint_evaluation_physics = set_physics; }

protected:

  DifferentiablePhysics * _residual_evaluation_physics;

  DifferentiablePhysics * _adjoint_evaluation_physics;

  /* A vector to hold the computed global QoI error estimate */
  std::vector<Number> computed_global_QoI_errors;

  QoISet _qoi_set;
};

} // namespace libMesh

#endif // #ifdef LIBMESH_ENABLE_AMR

#endif // LIBMESH_ADJOINT_REFINEMENT_ESTIMATOR_H