Champ_Gen_de_Champs_Gen.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 Champ_Gen_de_Champs_Gen_included
#define Champ_Gen_de_Champs_Gen_included
 
#include <Liste_Champ_Generique.h>
#include <TRUST_List.h>
#include <TRUST_Ref.h>
#include <Champ_Fonc_base.h>
 
/*! @brief Base class of generic fields having other generic fields as source. The use of the class methods relies on a recursion principle
 *
 *   An instruction will generally be applied (or delegated) to a generic source
 *   field which itself will apply (or delegate) the action
 *
 */
 
// Typical syntax for instantiable derived classes
//   "field_name"  "generic_field_type" { source "generic_field_type" { source ... } }
//  or
//   "field_name"  "generic_field_type" { source_reference "source_ref_name" }
// "field_name" set by the user will be the name of the generic field
// "generic_field_type" designates the type of the selected generic field
// source_ref_name designates the name of an already defined generic field
 
class Champ_Gen_de_Champs_Gen : public Champ_Generique_base
{
  Declare_base(Champ_Gen_de_Champs_Gen);
public:
 
  void set_param(Param& param) const override;
  int lire_motcle_non_standard(const Motcle&, Entree&) override;
  void   reset() override;
  std::vector<YAML_data> data_a_sauvegarder() const override;
  int sauvegarder(Sortie& os) const override;
  int reprendre(Entree& is) override;
  void completer(const Postraitement_base& post) override;
  void   mettre_a_jour(double temps) override;
 
  virtual OWN_PTR(Champ_Fonc_base)& creer_espace_stockage(const Nature_du_champ& nature,
                                                          const int nb_comp,
                                                          OWN_PTR(Champ_Fonc_base)& es_tmp) const;
 
  virtual const Champ_Generique_base&      get_source(int i) const;
  virtual Champ_Generique_base&      set_source(int i) ;
  virtual int                      get_nb_sources() const;
  int            get_dimension() const override;
  void              get_property_names(Motcles& list) const override;
  double            get_time() const override;
 
  const Probleme_base& get_ref_pb_base() const override;
  const Discretisation_base&  get_discretisation() const override;
  const Motcle                      get_directive_pour_discr() const override;
 
  const Noms        get_property(const Motcle& query) const override;
  Entity            get_localisation(const int index = -1) const override;
 
  const DoubleTab&  get_ref_values() const override;
  void              get_copy_values(DoubleTab&) const override;
  void              get_xyz_values(const DoubleTab& coords, DoubleTab& values, ArrOfBit& validity_flag) const override;
 
  const Domaine&    get_ref_domain() const override;
  void              get_copy_domain(Domaine&) const override;
 
  const Domaine_dis_base&  get_ref_domaine_dis_base() const override;
  const Domaine_Cl_dis_base&  get_ref_zcl_dis_base() const override;
 
  const DoubleTab&  get_ref_coordinates() const override;
  void              get_copy_coordinates(DoubleTab&) const override;
  const IntTab&     get_ref_connectivity(Entity index1, Entity index2) const override;
  void              get_copy_connectivity(Entity index1, Entity index2, IntTab&) const override;
 
  void nommer_sources(const Postraitement_base& post);
  virtual void nommer_source();
  void set_parent_name(const Nom& nom) { parent_name_ = nom; }
  const Nom& get_parent_name() const { return parent_name_; }
 
  int get_info_type_post() const override;
 
  const Champ_Generique_base& get_champ_post(const Motcle& nom) const override;
  bool has_champ_post(const Motcle& nom) const override;
  int comprend_champ_post(const Motcle& identifiant) const override;
 
  //Method to change t_deb and t_fin for statistics restarts
  //or for series statistics
  virtual void fixer_serie(const double t1,const double t2);
  virtual void fixer_tstat_deb(const double t1,const double t2);
  virtual void lire_bidon(Entree& is) const;
 
protected:
  Nom parent_name_; //Name of the field for which I am the source
  LIST(OWN_PTR(Champ_Generique_base)) sources_;        //Attribute designating "first-level" sources
  LIST(Nom) noms_sources_ref_;
  LIST(OBS_PTR(Champ_Generique_base)) sources_reference_; //allows creating a source by referencing a
};
 
#endif