AbstractPdeSolver.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 "common/toolbox/TimeStepper.hpp"
#include "pde/common/PdeErrorCalculator.hpp"
#include "pde/common/writers/MeditSolutionWriter.hpp"
#include "pde/common/writers/TimeWriter.hpp"
#include "pde/common/writers/VtkWriter.hpp"
 
// Forward declarations
class AbstractPdeProblem;
class AbstractAssembler;
 
class AbstractPdeSolver : public CepsObject
{
 
  public:
 
    AbstractPdeSolver() = delete;
  
    AbstractPdeSolver(AbstractPdeProblem* pb);
 
    AbstractPdeSolver(const AbstractPdeSolver &that) = delete;
 
    AbstractPdeSolver &
    operator=(const AbstractPdeSolver &that) = delete;
  
    ~AbstractPdeSolver() override;
 
    virtual void
    setupWithParameters(InputParameters* params);
 
    // ---------------------------------------------------------------------------------------------
    // Solving
 
    virtual void
    solve() = 0;
 
    // ---------------------------------------------------------------------------------------------
    // Output
 
    void
    disableOutput();
 
    void
    enableOutput();
 
    virtual CepsUInt
    getExpectedNumberOfOutputs() const = 0;
 
    TimeWriter*
    getTimeWriter() const;
 
    // ---------------------------------------------------------------------------------------------
    // Error
 
    void
    disableErrorComputation();
  
 
  protected:
 
    virtual void
    updateAssemblers() = 0;
 
    virtual void
    assembleAndSolve() = 0;
 
    virtual void
    initializeWriter();
 
    virtual void
    initializeAssemblers() = 0;
 
 
  protected:
    // ---------------------------------------------------------------------
    // Links to structures
 
    AbstractPdeProblem*     m_problem;        
    AbstractDiscretization* m_discretization; 
 
    // ---------------------------------------------------------------------
    // Matrices and system
 
    LinearSystem* m_linearSystem;    
    DMatPtr       m_lhs;             
    DVecPtr       m_rhs;             
 
    AbstractAssembler* m_opAsb;      
    DMatPtr            m_opMat;      
 
    AbstractAssembler* m_bcAsb;      
    DMatPtr            m_bcMat;      
    DVecPtr            m_bcVec;      
 
    AbstractAssembler* m_lapSrcAsb;  
    DMatPtr            m_lapSrcMat;  
 
    CepsBool m_hasRegSrc;            
    CepsBool m_hasLapSrc;            
 
    CepsBool m_useMassLumping;       
 
    // ---------------------------------------------------------------------
    // Output
 
    CepsBool m_doOutput;  
  
    VtkWriter* m_writer;  
    // MeditSolutionWriter *m_writer; ///< Writer for the regular solution
    TimeWriter* m_timeWriter;  
 
    // ---------------------------------------------------------------------
    // Error
 
    CepsBool            m_doError; 
    PdeErrorCalculator* m_errors;  
 
};