Domaine_base.h

/****************************************************************************
* Copyright (c) 2026, 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_base_included
#define Domaine_base_included
 
#include <Champs_compris_interface.h>
#include <Bords_Internes.h>
#include <Champs_compris.h>
#include <Groupes_Faces.h>
#include <Sous_Domaine.h>
 
#include <TRUSTArrays.h>
#include <TRUST_Deriv.h>
#include <TRUSTList.h>
#include <Elem_geom.h>
#include <TRUSTTabs.h>
#include <TRUST_Ref.h>
#include <Raccords.h>
#include <Joints.h>
#include <Bords.h>
#include <Noms.h>
#include <YAML_data.h>
 
class Probleme_base;
class Domaine_dis_base;
 
/*! @brief Base class for domains description.
 * This class holds all the data shared by all domains **and** not sensitive to the 32/64 bits configuration.
 *
 * @sa Domaine class which inherits from Domaine_base and is templatized on entity index size (32 / 64b)
 */
class Domaine_base : public Champs_compris_interface, public Objet_U
{
  Declare_base_sans_constructeur(Domaine_base);
 
public:
  //
  // General
  //
  inline const Nom& le_nom() const override   {   return nom_; }
  inline void nommer(const Nom& nom) override {  nom_ = nom; }
  inline double epsilon() const { return epsilon_; }
  void creer_champ(const Motcle& motlu) override { Process::exit("No, call creer_champ(const Motcle&, const Probleme_base&)"); };
  virtual void creer_champ(const Motcle&, const Probleme_base&) {}
  void get_noms_champs_postraitables(Noms& nom,Option opt=NONE) const override {}
  const Champ_base& get_champ(const Motcle&) const override { throw; }
  bool has_champ(const Motcle& nom, OBS_PTR(Champ_base) &ref_champ) const override { return false; }
  bool has_champ(const Motcle& nom) const override { return false; }
 
  //
  // Time-dependency
  //
  virtual void initialiser (double temps, Domaine_dis_base&, Probleme_base&) {}
  virtual void set_dt(double& dt_) {}
  virtual void mettre_a_jour(double temps, Domaine_dis_base&, Probleme_base&) {}
  virtual void update_after_post(double temps) {}
  virtual bool getUpdateTheGrid() {return true;}
  virtual void setUpdateTheGrid(bool) {}
  virtual bool getCouplingMethod() const {return false;}
  int mesh_update_required() const { return mesh_update_required_; }
  virtual void validateTimeStep() { }
 
  //
  // Printing/export stuff
  //
  inline void associer_bords_a_imprimer(LIST(Nom) liste)     { bords_a_imprimer_=liste; }
  inline void associer_bords_a_imprimer_sum(LIST(Nom) liste) { bords_a_imprimer_sum_=liste; }
  Entree& lire_bords_a_imprimer(Entree& s) ;
  Entree& lire_bords_a_imprimer_sum(Entree& s) ;
  inline const LIST(Nom)& bords_a_imprimer() const { return bords_a_imprimer_; }
  inline const LIST(Nom)& bords_a_imprimer_sum() const { return bords_a_imprimer_sum_; }
  inline int  moments_a_imprimer() const  {  return moments_a_imprimer_;  }
  inline int& moments_a_imprimer() {  return moments_a_imprimer_;  }
 
  //
  // Various
  //
  inline bool axi1d() const { return que_suis_je()=="DomaineAxi1d"; }
  inline void fixer_epsilon(double eps)  { epsilon_=eps; }
  inline bool deformable() const  {   return deformable_;  }
  inline bool& deformable() {   return deformable_;  }
  inline void set_fichier_lu(Nom& nom)  {    fichier_lu_=nom;   }
  inline const Nom& get_fichier_lu() const  {   return fichier_lu_;  }
  virtual const DoubleVect& old_volumes_entrelaces() const { throw; }
  virtual const DoubleVect& old_volumes() const { throw; }
  virtual void apply_old_to_new_volume_scaling(DoubleTab& tab, const Domaine_dis_base& dvf) const { }
  virtual void ajouter_correctif_volumique(const DoubleTab&, const DoubleTab&, double, DoubleTab&) const {}
  // save additional information not handled by the default save mechanism.
  virtual int save_additional_state(Sortie&, const Probleme_base&) const { return 0; }
  // restore additional information during restart
  virtual int restore_additional_state(Entree&, Probleme_base&) { return 0; }
 
  virtual std::vector<YAML_data> data_a_sauvegarder(const Probleme_base& pb) const { return std::vector<YAML_data>(); }
protected:
  /// Domaine name
  Nom nom_;
 
  int moments_a_imprimer_;
  LIST(Nom) bords_a_imprimer_;
  LIST(Nom) bords_a_imprimer_sum_;
 
  double epsilon_;
  bool deformable_ = false;
  Nom fichier_lu_;
 
  void duplique_bords_internes();
 
  /// Total volume of the domain (sum over all processors)
  double volume_total_;
  Champs_compris champs_compris_;
  bool mesh_update_required_ = false;
};
 
 
#endif