adjoint_residual_error_estimator.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2018 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_RESIDUAL_ERROR_ESTIMATOR_H
#define LIBMESH_ADJOINT_RESIDUAL_ERROR_ESTIMATOR_H

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

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

namespace libMesh
{
class AdjointResidualErrorEstimator : public ErrorEstimator
{
public:

  AdjointResidualErrorEstimator();

  AdjointResidualErrorEstimator (const AdjointResidualErrorEstimator &) = delete;
  AdjointResidualErrorEstimator & operator= (const AdjointResidualErrorEstimator &) = delete;

  AdjointResidualErrorEstimator (AdjointResidualErrorEstimator &&) = default;
  AdjointResidualErrorEstimator & operator= (AdjointResidualErrorEstimator &&) = default;
  virtual ~AdjointResidualErrorEstimator() = default;

  std::unique_ptr<ErrorEstimator> & primal_error_estimator() { return _primal_error_estimator; }

  std::unique_ptr<ErrorEstimator> & dual_error_estimator() { return _dual_error_estimator; }

  QoISet & qoi_set() { return _qoi_set; }

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

  std::string error_plot_suffix;

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

  virtual ErrorEstimatorType type() const override;

protected:

  std::unique_ptr<ErrorEstimator> _primal_error_estimator;

  std::unique_ptr<ErrorEstimator> _dual_error_estimator;

  QoISet _qoi_set;
};


} // namespace libMesh

#endif // LIBMESH_ADJOINT_RESIDUAL_ERROR_ESTIMATOR_H