AbstractTimedPdeProblem.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 "pde/problem/AbstractPdeProblem.hpp"
 
class AbstractTimedPdeProblem : public AbstractPdeProblem
{
  public:
  
    explicit AbstractTimedPdeProblem(
      Geometry*        geom, 
      InputParameters* params = nullptr
    );
 
    void
    setupWithParameters(InputParameters* params) override;
 
    CepsReal
    getStartTime() const override;
 
    CepsReal
    getEndTime() const override;
 
    CepsReal
    getTimeStep() const;
 
    void
    setTimes(CepsReal tStart, CepsReal tEnd, CepsReal dt);
 
    CepsReal
    getSnapshotTime() const override;
 
    void
    setSnapshotTime(CepsReal st);
 
    // ============================================
 
    virtual void
    defineInitialCondition();
 
    virtual void
    getInitialCondition(DHVecPtr v) const;
 
    void
    initializeEquation() override;
 
    CepsArray2<CepsArray3<CepsArray3<CepsReal>>>
    getErrors() const;
 
    CepsBool
    canComputeErrorAtTime(CepsReal t) const;
 
  public:
 
    static constexpr CepsBool isStatic = false;
 
 
  protected:
 
    CepsReal m_pdeStartTime;    
    CepsReal m_pdeEndTime;      
    CepsReal m_pdeTimeStep;     
    CepsReal m_pdeSnapshotTime; 
 
    ScalarFunction* m_initialCondition;
 
    CepsArray2<CepsArray3<CepsArray3<CepsReal>>> m_errors;
 
};