AbstractTimedPdeSolver.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/solver/AbstractPdeSolver.hpp"
 
// Forward declarations
class AbstractTimedPdeProblem;
 
class AbstractTimedPdeSolver : public AbstractPdeSolver
{
 
  public:
 
    explicit AbstractTimedPdeSolver(AbstractTimedPdeProblem* pb);
    
    virtual ~AbstractTimedPdeSolver();
    
    void
    solve() override;
  
    void
    setupWithParameters(InputParameters* params) override;
 
    CepsUInt 
    getExpectedNumberOfOutputs() const override;
 
    virtual void
    output(DHVecPtr solution, CepsBool immediateWriting = true);
 
    DHVecPtr
    getSolution() const;
 
    void
    enableErrorComputation();
  
    CepsArray2<CepsArray3<CepsArray3<CepsReal>>>
    getErrors() const;
 
  protected:
 
    AbstractTimedPdeProblem* 
    getTimedProblem() const;
 
    virtual void
    displayProgress() const;
 
    virtual CepsBool
    finished() const;
  
    void
    determineSolverType(CepsString s);
 
    virtual void
    allocateArrays();
 
    // Linear system building methods
    void
    updateAssemblers() override;
  
    virtual void
    fillSourceTermsVector(CepsReal tn);
 
    virtual void
    swapMultiStepPointers();
 
  protected:
    DMatPtr m_dtMat;
    DVecPtr m_timeDerEqsVec;
    DVecPtr m_noTimeDerEqsVec;
 
    DHVecPtr m_uNp1;
    CepsVector<DHVecPtr> m_uNm;
    CepsString m_type;
    CepsString m_rkType;
    CepsUInt m_nbMultiSteps;
    TimeStepper* m_timeStepper;
 
    CepsVector<DHVecPtr> m_regSourcesNm;
    CepsVector<DHVecPtr> m_lapSourcesNm;
 
    CepsVector<DHVecPtr> m_rkF;
    CepsVector<DHVecPtr> m_rkU;
  
    CepsReal m_scaleSystem;
 
    static constexpr CepsReal c_alphaSBDF[5] = {0., 1., 2. / 3., 6. / 11., 12. / 25.};
    static constexpr CepsReal c_alphaCN[3] = {0., 1., 1. / 2.};
    static constexpr CepsReal c_akSBDF[4][4] = {{1.}, {4. / 3., -1. / 3.}, {18. / 11., -9. / 11., 2. / 11.}, {48. / 25., -36. / 25., 16. / 25., -3. / 25.}};
 
    CepsBool m_cheatConvergence;
 
    CepsUInt m_nbIterSnapshot; 
};