error_vector.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_ERROR_VECTOR_H
#define LIBMESH_ERROR_VECTOR_H

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

// C++ includes
#include <cstddef>

namespace libMesh
{

// Forward Declarations
class MeshBase;
class Mesh;

class ErrorVector : public StatisticsVector<ErrorVectorReal>
{
public:

  ErrorVector(dof_id_type i=0, MeshBase * mesh = nullptr) :
    StatisticsVector<ErrorVectorReal> (i),
    _mesh(mesh)
  {}

  ErrorVector(dof_id_type i, ErrorVectorReal val) :
    StatisticsVector<ErrorVectorReal> (i,val) {}

  virtual ErrorVectorReal minimum() const override;

  virtual Real mean() const override;

  virtual Real median() override;

  virtual Real median() const override;

  virtual Real variance() const override
  { return this->variance(this->mean()); }

  virtual Real variance(const Real mean) const override;

  virtual std::vector<dof_id_type> cut_below(Real cut) const override;

  virtual std::vector<dof_id_type> cut_above(Real cut) const override;

  void plot_error(const std::string & filename,
                  const MeshBase & mesh) const;

protected:
  bool is_active_elem (dof_id_type i) const;

  MeshBase * _mesh;
};

} // namespace libMesh

#endif // LIBMESH_ERROR_VECTOR_H