Champ_Fonc_base.cpp

/****************************************************************************
* 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.
*
*****************************************************************************/
 
#include <EcritureLectureSpecial.h>
#include <Champ_Fonc_base.h>
#include <MD_Vector_tools.h>
#include <Domaine_VF.h>
#include <Domaine.h>
#include <TRUSTTrav.h>
#include <TRUST_2_PDI.h>
 
Implemente_base(Champ_Fonc_base, "Champ_Fonc_base", Champ_Don_base);
 
Sortie& Champ_Fonc_base::printOn(Sortie& s) const { return s; }
 
Entree& Champ_Fonc_base::readOn(Entree& s) { return s; }
 
void Champ_Fonc_base::associer_domaine_dis_base(const Domaine_dis_base& z_dis)
{
  le_dom_VF = ref_cast(Domaine_VF, z_dis);
}
 
const Domaine_dis_base& Champ_Fonc_base::domaine_dis_base() const
{
  return le_dom_VF ? le_dom_VF.valeur() : Champ_Don_base::domaine_dis_base() /* throw */;
}
 
const Domaine_VF& Champ_Fonc_base::domaine_vf() const
{
  assert (le_dom_VF);
  return le_dom_VF.valeur();
}
 
/*! @brief Time update of the field.
 *
 * @param (double temps) the update time
 */
void Champ_Fonc_base::mettre_a_jour(double un_temps)
{
  changer_temps(un_temps);
  valeurs().echange_espace_virtuel();
}
 
int Champ_Fonc_base::fixer_nb_valeurs_nodales(int nb_noeuds)
{
  Cerr << "Error in Champ_Fonc_base::fixer_nb_valeurs_nodales: method not reimplemented for the class " << que_suis_je() << finl;
  Process::exit();
  return nb_noeuds;
}
 
void Champ_Fonc_base::creer_tableau_distribue(const MD_Vector& md, RESIZE_OPTIONS opt)
{
  // Note B.M.: to be symmetric with Champ_Inc_base, we should test if the
  // field is scalar or multi-scalar (see Champ_Inc_base::creer_tableau_distribue())
  if (valeurs_.size_array() == 0 && (!valeurs_.get_md_vector()))
    {
      // Note B.M.: the fixer_nb_valeurs_nodales methods are called haphazardly.
      // Do nothing if the array already has the correct structure
      valeurs_.resize(0, nb_compo_);
    }
  // This will crash if we attached another parallel structure (this is intentional!)
  if (!(valeurs_.get_md_vector() == md))
    {
      if (valeurs_.get_md_vector())
        {
          Cerr << "Internal error in Champ_Fonc_base::creer_tableau_distribue:\n" << " array has already a (wrong) parallel descriptor" << finl;
          Process::exit();
        }
      MD_Vector_tools::creer_tableau_distribue(md, valeurs_, opt);
    }
}
 
 
Nom Champ_Fonc_base::get_pdi_name() const
{
  Nom name = pdi_name_ == "??" ? (Motcle)nom_ : (Motcle)pdi_name_;
  return name;
}
 
/*! @brief for PDI IO: retrieve name, type and dimensions of the field to save/restore.
 */
std::vector<YAML_data> Champ_Fonc_base::data_a_sauvegarder() const
{
  const Nom& name = get_pdi_name();
  int nb_dim = valeurs().nb_dim();
  YAML_data d(name.getString(), "double", nb_dim);
  std::vector<YAML_data> data;
  data.push_back(d);
  return data;
}
 
/*! @brief Saves the field to an output stream. Writes the name, time and values.
 *
 * @param (Sortie& fich) an output stream
 * @return (int) always returns 1
 */
int Champ_Fonc_base::sauvegarder(Sortie& fich) const
{
  // in special write mode only the master writes the header
  int a_faire, special;
  EcritureLectureSpecial::is_ecriture_special(special, a_faire);
 
  if (a_faire)
    {
      Nom mon_ident(nom_);
      mon_ident += que_suis_je();
      mon_ident += domaine_dis_base().domaine().le_nom();
      mon_ident += Nom(temps_, "%e");
      fich << mon_ident << finl;
      fich << que_suis_je() << finl;
      fich << temps_ << finl;
    }
  int bytes = 0;
  if (special)
    bytes = EcritureLectureSpecial::ecriture_special(*this, fich);
  else if (TRUST_2_PDI::is_PDI_checkpoint())
    {
      bytes = 8 * valeurs().size_array();
      const Nom& name = get_pdi_name();
      TRUST_2_PDI pdi_interface;
      pdi_interface.share_TRUSTTab_dimensions(valeurs(), name, 1 /*write mode*/);
 
      // Sharing the unknown field with PDI
      if( valeurs().dimension_tot(0) )
        pdi_interface.TRUST_start_sharing(name.getString(), valeurs().addr());
      else
        {
          // if the dimension is null in a direction - might happen in parallel - sharing an empty array
          ArrOfDouble garbage( valeurs().nb_dim() );
          pdi_interface.TRUST_start_sharing(name.getString(), garbage.addr());
        }
    }
  else
    {
      bytes = 8 * valeurs().size_array();
      valeurs().ecrit(fich);
    }
  if (a_faire)
    {
      //fich << flush ; Does not work in binary, prefer:
      fich.flush();
    }
  Cerr << "Backup of the field " << nom_ << " performed on time : " << Nom(temps_, "%e") << finl;
 
  return bytes;
}
 
/*! @brief Restart from an input stream. Reads the time and values of the field.
 *
 *     Skips a block if the field name is "anonymous".
 *
 * @param (Entree& fich) an input stream
 * @return (int) always returns 1
 */
int Champ_Fonc_base::reprendre(Entree& fich)
{
  double un_temps;
  int special = EcritureLectureSpecial::is_lecture_special();
  if (nom_ != Nom("anonyme")) // reading for restart
    {
      Cerr << "Resume of the field " << nom_;
      if(TRUST_2_PDI::is_PDI_restart())
        {
          TRUST_2_PDI pdi_interface;
          const Nom& name = get_pdi_name();
          pdi_interface.share_TRUSTTab_dimensions(valeurs(), name, 0 /*read mode*/);
          pdi_interface.read(name.getChar(), valeurs().addr());
        }
      else
        {
          fich >> un_temps;
          if (special)
            EcritureLectureSpecial::lecture_special(*this, fich);
          else
            valeurs().lit(fich);
        }
      Cerr << " performed." << finl;
    }
  else // reading to skip the block
    {
      if(TRUST_2_PDI::is_PDI_restart())
        {
          Cerr << finl << "Problem in the resumption " << finl;
          Cerr << "PDI format does not require to navigate through file..." << finl;
          Process::exit();
        }
      DoubleTab tempo;
      fich >> un_temps;
      tempo.jump(fich);
    }
  return 1;
}
 
/*! @brief Assigns a Champ_base to a Champ_Fonc_base.
 *
 * @param (Champ_base& ch) the field on the right side of the assignment
 * @return (Champ_base&) the result of the assignment (*this) (with upcast)
 */
Champ_base& Champ_Fonc_base::affecter_(const Champ_base& ch)
{
  DoubleTab noeuds;
  remplir_coord_noeuds(noeuds);
  ch.valeur_aux(noeuds, valeurs());
 
  return *this;
}
 
/*! @brief Assigns a component of a Champ_base to the same component of a Champ_Fonc_base.
 *
 * @param (Champ_base& ch) the field on the right side of the assignment
 * @param (int compo) the index of the component to assign
 * @return (Champ_base&) the result of the assignment (*this) (with upcast)
 */
Champ_base& Champ_Fonc_base::affecter_compo(const Champ_base& ch, int compo)
{
  DoubleTab noeuds;
  IntVect polys;
  if (!remplir_coord_noeuds_et_polys_compo(noeuds, polys, compo))
    {
      remplir_coord_noeuds_compo(noeuds, compo);
      ch.valeur_aux_compo(noeuds, valeurs(), compo);
    }
  else
    ch.valeur_aux_elems_compo(noeuds, polys, valeurs(), compo);
  return *this;
}
 
/*! @brief DOES NOTHING TO override in derived classes
 *
 * @param (DoubleTab&)
 * @param (IntVect&)
 * @return (int) always returns 0
 */
int Champ_Fonc_base::remplir_coord_noeuds_et_polys(DoubleTab&, IntVect&) const
{
  return 0;
}
 
/*! @brief DOES NOTHING TO override in derived classes
 *
 * @param (DoubleTab& coord)
 * @return (DoubleTab&) always returns the coord parameter
 */
DoubleTab& Champ_Fonc_base::remplir_coord_noeuds(DoubleTab& coord) const
{
  return coord;
}
 
/*! @brief DOES NOTHING TO override in derived classes
 *
 * @param (DoubleTab& coord)
 * @param (int)
 * @return (DoubleTab&) always returns the coord parameter
 */
DoubleTab& Champ_Fonc_base::remplir_coord_noeuds_compo(DoubleTab& coord, int) const
{
  return coord;
}
 
/*! @brief DOES NOTHING TO override in derived classes
 *
 * @param (DoubleTab&)
 * @param (IntVect&)
 * @param (int)
 * @return (int) always returns 0
 */
int Champ_Fonc_base::remplir_coord_noeuds_et_polys_compo(DoubleTab&, IntVect&, int) const
{
  return 0;
}
 
const Domaine& Champ_Fonc_base::domaine() const
{
  return domaine_dis_base().domaine();
}
 
DoubleTab& Champ_Fonc_base::valeur_aux(const DoubleTab& positions, DoubleTab& tab_valeurs) const
{
  const Domaine& domaine = domaine_dis_base().domaine();
  IntTrav les_polys;
  domaine.chercher_elements(positions, les_polys);
  return valeur_aux_elems(positions, les_polys, tab_valeurs);
}