Domaine_dis_base.h

/****************************************************************************
* Copyright (c) 2025, CEA
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*****************************************************************************/
 
#ifndef Domaine_dis_base_included
#define Domaine_dis_base_included
 
#include <Champs_compris_interface.h>
#include <Sous_domaine_dis_base.h>
#include <Champ_Fonc_base.h>
#include <Champs_compris.h>
#include <Domaine.h>
 
class Domaine_Cl_dis_base;
class Frontiere_dis_base;
class Probleme_base;
class Conds_lim;
class Reorder_Mesh;
class Discretisation_base;
 
/*! @brief class Domaine_dis_base This class is the base of the hierarchy of discretized domains.
 *
 *      A Domaine object is associated with the discretized domain.
 *      Each spatial discretization (VDF, VEF, PolyMAC_HFV, ...) in TRUST corresponds to a class deriving
 *      from Domaine_dis_base that implements the tools required by the method.
 */
class Domaine_dis_base : public Champs_compris_interface, public Objet_U
{
  Declare_base(Domaine_dis_base);
 
public :
  ///
  /// Accessors and shortcuts
  ///
  inline const Domaine& domaine() const { return le_dom_.valeur(); }
  inline Domaine& domaine() { return le_dom_.valeur(); }
 
  inline int nb_elem() const { return domaine().nb_elem(); }
  inline int nb_elem_tot() const { return domaine().nb_elem_tot(); }
  inline int nb_som() const { return domaine().nb_som(); }
  inline int nb_som_tot() const { return domaine().nb_som_tot(); }
  inline int nb_front_Cl() const { return domaine().nb_front_Cl(); }
 
  ///
  /// Sous_domaines_dis
  ///
  int nombre_de_sous_domaines_dis() const;
  const Sous_domaine_dis_base& sous_domaine_dis(int i) const;
  Sous_domaine_dis_base& sous_domaine_dis(int i);
 
  ///
  /// Bord and Frontiere
  ///
  void ecrire_noms_bords(Sortie&) const;
  int rang_frontiere(const Nom& );
  int rang_frontiere(const Nom& ) const;
  const Frontiere_dis_base& frontiere_dis(const Nom& ) const;
  Frontiere_dis_base& frontiere_dis(const Nom& );
  virtual Frontiere_dis_base& frontiere_dis(int ) =0;
  virtual const Frontiere_dis_base& frontiere_dis(int ) const =0;
 
  ///
  /// Mappings
  ///
  virtual IntTab& face_sommets();
  virtual const IntTab& face_sommets() const;
  virtual IntTab& face_aretes();
  virtual const IntTab& face_aretes() const;
  virtual IntTab& face_voisins();
  virtual const IntTab& face_voisins() const;
 
  ///
  /// Various
  ///
  void associer_domaine(const Domaine&);
  void discretiser_root(const Nom& typ);
  void completer(const Discretisation_base& disc) ;
  virtual void discretiser() { }
  virtual void build_map_mc_Cmesh(const bool with_faces) { /* Do nothing */ }
  virtual void discretiser_no_face() = 0;
  virtual void typer_discretiser_ss_domaine(int i) = 0;
  virtual void modifier_pour_Cl(const Conds_lim&) =0;
  virtual void creer_elements_fictifs(const Domaine_Cl_dis_base&);
 
  // Methods for computing and calling the distance to the nearest solid wall
  // the input is the array of BCs of the momentum equation
  virtual const DoubleTab& y_elem()  const {return y_elem_;}
  virtual const DoubleTab& y_faces() const {return y_faces_;}
  virtual inline void init_dist_paroi_globale(const Conds_lim& conds_lim)
  {
    Cerr << "Domaine_dis_base::init_dist_paroi_globale() does nothing ! " << que_suis_je() << "Needs to overload it !" << finl;
    Process::exit();
  }
 
  // Post-processing of fields:
  const Champ_Fonc_base& volume_maille() const { return volume_maille_; }
  const Champ_Fonc_base& mesh_numbering() const { return mesh_numbering_; }
  void get_noms_champs_postraitables(Noms& nom,Option opt=NONE) const override;
  void creer_champ(const Motcle& motlu) override { Process::exit("No, call creer_champ(const Motcle&, const Probleme_base&)"); };
  void creer_champ(const Motcle&, const Probleme_base&);
  const Champ_base& get_champ(const Motcle&) const override;
  bool has_champ(const Motcle& nom, OBS_PTR(Champ_base) &ref_champ) const override;
  bool has_champ(const Motcle& nom) const override;
 
  // Mesh reordering (Morton/Hilbert)
  void set_reorder(const Reorder_Mesh& r) { reorder_ = r; }
 
protected :
  OBS_PTR(Domaine) le_dom_;
  OBS_PTR(Reorder_Mesh) reorder_;  ///< An observer to the Reorder_Mesh option filled in the discretisation itself.
 
  TRUST_Vector<OWN_PTR(Sous_domaine_dis_base)> les_sous_domaines_dis_;
  int dist_paroi_initialisee_ = 0;
  DoubleTab y_elem_, y_faces_;
  Champs_compris champs_compris_;
  OWN_PTR(Champ_Fonc_base)  volume_maille_;
  OWN_PTR(Champ_Fonc_base)  mesh_numbering_;
};
 
#endif /* Domaine_dis_base_included */