AbstractOdeSolver.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/DistributedVector.hpp"
// #include "ode/ionicModels/AbstractIonicModel.hpp"
 
// class IonicSolver;
 
class AbstractOdeSolver
{
 
  public:
 
    using RateFunction = ceps::Function<void(CepsReal,CepsReal*,CepsReal*,CepsUInt)>;
 
  public:
 
    AbstractOdeSolver();
  
    virtual ~AbstractOdeSolver();
  
    // Methods for out of class evolution functions
  
    virtual void
    initialize(
      CepsReal*     y0, 
      CepsUInt      n, 
      RateFunction* nonlinearFunc,
      RateFunction* linearFunc = nullptr,
      CepsBool      copy       = false
    );
 
    CepsUInt
    getNbMultiSteps() const;
  
    CepsUInt
    getNbSubSteps() const;
  
    CepsReal*
    getSolution() const;
  
    virtual void
    takeOneStep(CepsReal t, CepsReal dt) = 0;
 
    virtual void
    takeOneSubStep(CepsReal t, CepsReal dt);
 
  protected:
 
    virtual void
    shiftDataArraysForNextStep();
 
    void
    evaluateDerivative(CepsReal t, CepsReal *y, CepsReal *dty, CepsUInt n, CepsBool nLinPart = true);
  
    CepsReal
    phi1(CepsReal x) const;
  
    // CepsVector<CepsReal>
    // phis(CepsInt n, CepsReal x) const;
  
 
  protected:
 
    CepsUInt              m_ySize;  
    CepsReal*             m_yNp1;   
    CepsVector<CepsReal*> m_yNm;    
  
    CepsUInt  m_nbMultiSteps; 
    CepsUInt  m_nbSubSteps;   
    CepsUInt  m_currentStep;  
 
    RateFunction* m_fL;   
    RateFunction* m_fNL;  
  
    CepsBool m_ownedSolData; 
    CepsBool m_initialized;  
 
 
    // CepsBool          m_isForGateVars;     ///< True to select specific solving method for ionic gate variables
    // IonicSolver *m_ionSolver;         ///< If needed, link to other coupled solver through IonicSolver
  
};