PdeErrorCalculator.hpp

Go to the documentation of this file.

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   This file is part of CEPS.
 
   CEPS is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
 
   CEPS 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 General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with CEPS (see file LICENSE at root of project).
   If not, see <https://www.gnu.org/licenses/>.
 
 
   Copyright 2019-2024 Inria, Universite de Bordeaux
 
   Authors, in alphabetical order:
 
     Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC, 
     Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*), 
     Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
     * : currently active authors
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#pragma once
 
#include "common/CepsCommon.hpp"
#include "linearAlgebra/LinearAlgebra.hpp"
#include "pde/common/functions/SAFunc.hpp"
 
// Forward declarations
class AbstractPdeProblem;
class AbstractStaticPdeProblem;
class AbstractTimedPdeProblem;
 
class PdeErrorCalculator 
{
 
  public:
    
    explicit PdeErrorCalculator(
      AbstractPdeProblem* pb, 
      CepsReal            dt = 1.
    );
 
    ~PdeErrorCalculator();
 
    void
    compute(DHVecPtr num, CepsReal time=0.);
 
    CepsReal
    getReferenceNormNow(CepsInt px) const;
 
    CepsReal
    getReferenceNormCumulative(CepsInt px, CepsInt pt) const;
 
    CepsReal
    getAbsoluteErrorNow(CepsInt px)const;
 
    CepsReal
    getAbsoluteErrorCumulative(CepsInt px, CepsInt pt)const;
 
    CepsReal
    getRelativeErrorNow(CepsInt px) const;
 
    CepsReal
    getRelativeErrorCumulative(CepsInt px, CepsInt pt) const;
 
    void
    setAnalyticSolution(ceps::Function<CepsReal(CepsStandardArgs)>* func);
 
    void
    reset();
 
  protected:
 
    void
    checkPxPt(CepsInt px, CepsInt pt) const;
 
    AbstractPdeProblem* m_problem;
 
    ScalarSAFunc* m_solution;
 
    CepsReal m_dt;
 
    CepsArray3<CepsReal> m_refNow;
 
    CepsArray3<CepsReal> m_errNow;
 
    CepsArray3<CepsReal> m_mxTNormsRef;
 
    CepsArray3<CepsReal> m_mxTNormsErr;
 
    CepsArray3<TimeIntegrator*> m_l1TNormsRef;
 
    CepsArray3<TimeIntegrator*> m_l1TNormsErr;
 
    CepsBool m_ignoreZeroD;
 
};