BoundaryConditionManager.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/BoundaryCondition.hpp"
#include "pde/common/functions/FunctionDictionary.hpp"
 
class BoundaryConditionManager final : public CepsObject, public ceps::HoldsDimension
{
  public:
    using Manager = CepsMap<CepsString, ScalarBoundaryCondition*>;
    using Func    = ScalarSAFunc;
    explicit BoundaryConditionManager(FunctionDictionary* dico);
 
    BoundaryConditionManager(const BoundaryConditionManager& that) = delete;
 
    BoundaryConditionManager&
    operator=(const BoundaryConditionManager& that) = delete;
 
    ~BoundaryConditionManager() final;
  
    void
    setDofsInfos(DistributedInfos<DegreeOfFreedom*>* dof);
  
    void
    add(const CepsString& params);
  
    void
    add(const CepsString& key, const CepsString& params);
  
    void
    add(const CepsString& key, const CepsBoundaryConditionFlag& type, const CepsString& params);
  
    void
    add(
      const CepsString&                key,
      const CepsBoundaryConditionFlag& type,
      const CepsString&                params,
      ScalarSAFunc*                    functor 
    );
  
    void
    add(const CepsString& key, ScalarBoundaryCondition* boundaryCondition);
  
    // -------------------------------------------------- //
    // get managers inside
    // -------------------------------------------------- //
  
    ScalarBoundaryCondition*
    getBC(CepsString key, const CepsBoundaryConditionFlag& type) const;
  
    Manager*
    getBCs(const CepsBoundaryConditionFlag& type) const;
  
    Manager*
    getDirichletBCs() const;
  
    Manager*
    getNeumannBCs() const;
  
    Manager*
    getRobinBCs() const;
  
    // -------------------------------------------------- //
    // reset
    // -------------------------------------------------- //
  
    virtual void
    reset();
  
    // -------------------------------------------------- //
    // actualize
    // -------------------------------------------------- //
  
    void
    actualizeAll(CepsReal time);
  
    void
    actualizeAllDirichlet(CepsReal time);
  
    void
    actualizeAllNeumann(CepsReal time);
  
    void
    actualizeAllRobin(CepsReal time);
  
    // -------------------------------------------------- //
    // print
    // -------------------------------------------------- //
  
    friend std::ostream &
    operator<<(std::ostream &os, const BoundaryConditionManager &manager);
  
  protected:
    DistributedInfos<DegreeOfFreedom*>* m_dofs;            
    Manager*                            m_dirichlet;       
    Manager*                            m_neumann;         
    Manager*                            m_robin;           
    CepsSet<DegreeOfFreedom*>           m_rowsAlreadyUsed; 
    FunctionDictionary*                 m_dictionary;      
  
};