BoundaryCondition.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 BoundaryCondition;
 
using ScalarBoundaryCondition = BoundaryCondition<CepsMathScalar>;
using VectorBoundaryCondition = BoundaryCondition<CepsMathVertex>;
using TensorBoundaryCondition = BoundaryCondition<CepsMathTensor>;
 
template <class _Result>
class BoundaryCondition : public Field<_Result,DegreeOfFreedom>,
                          public SAFunc<_Result>,
                          public ceps::HoldsDimension,
                          public ceps::HoldsAttributes
{
 
  public:
 
    using CoeffFunc = ScalarSAFunc*;
    BoundaryCondition(
      CoeffFunc                           functor,
      const CepsVector<DegreeOfFreedom*>* domain,
      CepsUnknownIndex                    unknown
    );
  
    ~BoundaryCondition() override;
  
    void
    setBoundaryConditionType(CepsBoundaryConditionFlag type);
  
    CepsBoundaryConditionFlag
    getBoundaryConditionType() const;
 
    CepsUnknownIndex
    getUnknownId() const;
 
    void
    setAlpha(CoeffFunc alpha);
  
    CoeffFunc
    getAlpha() const;
 
    typename std::remove_pointer_t<CoeffFunc>::ReturnType
    getAlpha(CepsStandardArgs args) const;
  
    void
    setBeta(CoeffFunc beta);
  
    CoeffFunc
    getBeta() const;
  
    typename std::remove_pointer_t<CoeffFunc>::ReturnType
    getBeta(CepsStandardArgs args) const;
 
    void
    applyAsDirichlet(DMatPtr mat, DVecPtr sec, CepsReal t=0., CepsReal scalingFactor = 1.0);
  
    _Result
    eval(CepsStandardArgs args) override;
 
    CepsEnum 
    getFlags() const override;
 
    friend class BoundaryConditionManager;
 
    // template <class _R>
    // friend std::ostream& operator<<(std::ostream &, const BoundaryCondition<_R>&);
 
  protected:
    CepsBoundaryConditionFlag m_type;    
    CoeffFunc                 m_alpha;   
    CoeffFunc                 m_beta;    
    CepsUnknownIndex          m_unknown; 
};
 
#include "pde/common/functions/BoundaryCondition.tpp"