SourceTerm.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/common/functions/Field.hpp"
 
template <class _Result>
class SourceTerm;
 
using ScalarSourceTerm = SourceTerm<CepsMathScalar>;
using VectorSourceTerm = SourceTerm<CepsMathVertex>;
using TensorSourceTerm = SourceTerm<CepsMathTensor>;
 
template <class _Result>
class SourceTerm : public Field<_Result,DegreeOfFreedom>
{
  public:
  
    SourceTerm(
      SAFunc<_Result>*                    functor,
      const CepsVector<DegreeOfFreedom*>* domain,
      CepsUnknownIndex                    unknown,
      CepsBool                            isStim          = false, 
      CepsBool                            isLaplaceMatrix = false,
      CepsBool                            bufferize       = false
    );
  
    ~SourceTerm() override;
  
    void
    setFlag(const CepsSourceTermFlag &flag);
  
    CepsSourceTermFlag
    getFlag() const;
  
    CepsUnknownIndex
    getUnknownId() const;
  
    CepsBool
    hasOption(CepsSourceTermFlag flag) const;
  
    friend class SourceTermManager;
  
  protected:
    CepsSourceTermFlag m_sourceFlag;  
    CepsUnknownIndex   m_unknown;     
};
 
#include "pde/common/functions/SourceTerm.tpp"