SourceTermManager.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 "pde/common/functions/FunctionDictionary.hpp"
#include "pde/common/functions/SourceTerm.hpp"
 
class SourceTermManager final: public CepsObject
{
  public:
    using Manager = CepsMap<CepsString,ScalarSourceTerm*>;
  
    explicit SourceTermManager(FunctionDictionary *dico);
 
    SourceTermManager(const SourceTermManager& that) = delete;
 
    SourceTermManager&
    operator=(const SourceTermManager& that) = delete;
 
    ~SourceTermManager() final;
  
    void
    setDofsInfos(DistributedInfos<DegreeOfFreedom*> *dofs);
  
    void
    add(const CepsString &params, CepsBool computeSupport = false);
  
    void
    add(const CepsString &key, const CepsString &params, CepsBool computeSupport = false);
  
    void
    add(const CepsString &key, CepsString &dicokey, 
        const CepsString &params, CepsBool computeSupport = false);
  
    void
    add(
      const CepsString& key,
      const CepsString& params,
      ScalarSAFunc*     functor,
      CepsBool          computeSupport = false
    );
  
    void
    add(const CepsString& key, ScalarSourceTerm* sourceTerm);
  
    void
    actualizeAll(CepsReal time);
 
    ScalarSourceTerm*
    getSourceTerm(CepsString label) const;
 
    CepsVector<ScalarSourceTerm*>
    asVector() const;
 
    Manager* const
    getManager() const;
 
    CepsUInt
    getNbOfSourceTermsOf(CepsSourceTermFlag flag) const;
 
    CepsUInt
    getNbOfSourceTermsOf(CepsEnum flag) const;
 
  protected:
    DistributedInfos<DegreeOfFreedom*>* m_dofs;        
    Manager*                            m_manager;     
    FunctionDictionary*                 m_dictionary;  
};