ALE_CheckpointManager.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 <ALE_CheckpointManager.h>
#include <Domaine_ALE.h>
#include <EcritureLectureSpecial.h>
#include <Probleme_base.h>
#include <Process.h>
#include <TRUST_2_PDI.h>
#include <Schema_Temps_base.h>
#include <Avanc.h>
#include <Objet_U.h>
#include <algorithm>
 
int ALE_CheckpointManager::save(Sortie& os, const Probleme_base& pb,
                                const Domaine_ALE& dom) const
{
  int bytes = 0, a_faire, special;
  EcritureLectureSpecial::is_ecriture_special(special, a_faire);
 
  // Helper lambda: allocate a temporary discretized field.
  auto make_champ = [&](const std::string& name, int nbComp, const std::string& directive)
  {
    OWN_PTR(Champ_Inc_base) champ;
    Noms noms(1), unit(1);
    noms[0] = name;
    unit[0] = "none";
    pb.discretisation().discretiser_champ(directive.c_str(), pb.domaine_dis(),
                                          vectoriel, noms, unit, nbComp, 1,
                                          pb.schema_temps().temps_courant(), champ);
    champ->associer_eqn(dom.getEquation());
    return champ;
  };
 
  int dimension=Objet_U::dimension;
 
  if (a_faire)
    {
      // Standard binary / xyz save path
      OWN_PTR(Champ_Inc_base) meshCoords = make_champ("meshCoords", dimension, "champ_sommets");
      meshCoords->valeurs() = pb.domaine_dis().domaine().les_sommets();
 
      if (special && Process::nproc() > 1)
        Cerr << "ATTENTION : parallel calculation, meshCoords not saved in xyz format" << finl;
      else
        bytes += meshCoords->sauvegarder(os);
 
      if (dom.getMeshMotionModel() == 1)
        {
          // Node-wise kinematic fields
          OWN_PTR(Champ_Inc_base) meshDisplacement = make_champ("meshDisplacement", dimension, "champ_sommets");
          meshDisplacement->valeurs() = dom.getMeshDisplacement();
 
          OWN_PTR(Champ_Inc_base) meshVelocity = make_champ("meshVelocity", dimension, "champ_sommets");
          meshVelocity->valeurs() = dom.getMeshVelocity();
 
          OWN_PTR(Champ_Inc_base) meshAcceleration = make_champ("meshAcceleration", dimension, "champ_sommets");
          meshAcceleration->valeurs() = dom.getMeshAcceleration();
 
          OWN_PTR(Champ_Inc_base) meshPosition = make_champ("meshPosition", dimension, "champ_sommets");
          meshPosition->valeurs() = dom.getMeshPosition();
 
          // Element-wise mechanical state fields
          OWN_PTR(Champ_Inc_base) meshRefConfig = make_champ("meshReferenceConfiguration",
                                                             dom.getMeshReferenceConfigurationNbComp(), "champ_elem");
          meshRefConfig->valeurs() = dom.getMeshReferenceConfiguration();
 
          OWN_PTR(Champ_Inc_base) meshTransGrad = make_champ("meshTransformationGradient",
                                                             dom.getMeshTransformationGradientNbComp(), "champ_elem");
          meshTransGrad->valeurs() = dom.getMeshTransformationGradient();
 
          OWN_PTR(Champ_Inc_base) meshStress = make_champ("meshStress", dom.getMeshStressNbComp(), "champ_elem");
          meshStress->valeurs() = dom.getMeshStress();
 
          if (special && Process::nproc() > 1)
            Cerr << "ATTENTION : parallel calculation, mesh fields not saved in xyz format" << finl;
          else
            {
              bytes += meshDisplacement->sauvegarder(os);
              bytes += meshVelocity->sauvegarder(os);
              bytes += meshAcceleration->sauvegarder(os);
              bytes += meshPosition->sauvegarder(os);
              bytes += meshRefConfig->sauvegarder(os);
              bytes += meshTransGrad->sauvegarder(os);
              bytes += meshStress->sauvegarder(os);
            }
        }
    }
  else if (TRUST_2_PDI::is_PDI_checkpoint())
    {
      //PDI / HDF5 parallel save path
      bytes += write_pdi(pb.domaine_dis().domaine().les_sommets(),
                         (pb.le_nom() + "_MeshCoords").majuscule());
 
      if (dom.getMeshMotionModel() == 1)
        {
          bytes += write_pdi(dom.getMeshDisplacement(),          (pb.le_nom() + "_MeshDisplacement").majuscule());
          bytes += write_pdi(dom.getMeshVelocity(),              (pb.le_nom() + "_MeshVelocity").majuscule());
          bytes += write_pdi(dom.getMeshAcceleration(),          (pb.le_nom() + "_MeshAcceleration").majuscule());
          bytes += write_pdi(dom.getMeshPosition(),              (pb.le_nom() + "_MeshPosition").majuscule());
          bytes += write_pdi(dom.getMeshReferenceConfiguration(),(pb.le_nom() + "_MeshReferenceConfiguration").majuscule());
          bytes += write_pdi(dom.getMeshTransformationGradient(),(pb.le_nom() + "_MeshTransformationGradient").majuscule());
          bytes += write_pdi(dom.getMeshStress(),                (pb.le_nom() + "_MeshStress").majuscule());
        }
    }
 
  return bytes;
}
 
int ALE_CheckpointManager::restore(Entree& is, Probleme_base& pb, Domaine_ALE& dom)
{
  const bool pdi_restart = static_cast<bool>(TRUST_2_PDI::is_PDI_restart());
  int dimension=Objet_U::dimension;
 
  if (EcritureLectureSpecial::is_lecture_special() && Process::nproc() > 1)
    {
      Cerr << "Error in ALE_CheckpointManager::restore !" << finl;
      Cerr << "Use serial checkpoint for parallel calculation." << finl;
      Process::exit();
    }
 
  // Helper lambda: allocate a temporary discretized field
  auto make_champ = [&](const std::string& name, int nbComp, const std::string& directive)
  {
    OWN_PTR(Champ_Inc_base) champ;
    Noms noms(1), unit(1);
    noms[0] = name;
    unit[0] = "none";
    pb.discretisation().discretiser_champ(directive.c_str(), pb.domaine_dis(),
                                          vectoriel, noms, unit, nbComp, 1,
                                          pb.schema_temps().temps_courant(), champ);
    champ->associer_eqn(dom.getEquation()); // non-const overload, dom is non-const here
    return champ;
  };
 
  // Step 1: mesh coordinates
  OWN_PTR(Champ_Inc_base) meshCoords = make_champ("meshCoords", dimension, "champ_sommets");
 
  if (!pdi_restart)
    {
      avancer_fichier(is, generate_field_tag(meshCoords.valeur(), pb));
      meshCoords->reprendre(is);
    }
  else
    read_pdi(meshCoords, "_MeshCoords", pb);
 
  dom.resumptionCoords(meshCoords->valeurs());
  dom.updateMetrics(pb.domaine_dis(), pb);
 
  // Step 2: structural dynamics fields (model == 1 only)
  if (dom.getMeshMotionModel() == 1)
    {
      OWN_PTR(Champ_Inc_base) meshDisplacement = make_champ("meshDisplacement", dimension, "champ_sommets");
      OWN_PTR(Champ_Inc_base) meshVelocity     = make_champ("meshVelocity",     dimension, "champ_sommets");
      OWN_PTR(Champ_Inc_base) meshAcceleration = make_champ("meshAcceleration", dimension, "champ_sommets");
      OWN_PTR(Champ_Inc_base) meshPosition     = make_champ("meshPosition",     dimension, "champ_sommets");
      OWN_PTR(Champ_Inc_base) meshRefConfig    = make_champ("meshReferenceConfiguration",
                                                            dom.getMeshReferenceConfigurationNbComp(), "champ_elem");
      OWN_PTR(Champ_Inc_base) meshTransGrad    = make_champ("meshTransformationGradient",
                                                            dom.getMeshTransformationGradientNbComp(), "champ_elem");
      OWN_PTR(Champ_Inc_base) meshStress       = make_champ("meshStress", dom.getMeshStressNbComp(), "champ_elem");
 
      if (!pdi_restart)
        {
          // Standard binary: fields must be read in the exact order they were written
          avancer_fichier(is, generate_field_tag(meshDisplacement.valeur(), pb));
          meshDisplacement->reprendre(is);
          avancer_fichier(is, generate_field_tag(meshVelocity.valeur(),     pb));
          meshVelocity->reprendre(is);
          avancer_fichier(is, generate_field_tag(meshAcceleration.valeur(), pb));
          meshAcceleration->reprendre(is);
          avancer_fichier(is, generate_field_tag(meshPosition.valeur(),     pb));
          meshPosition->reprendre(is);
          avancer_fichier(is, generate_field_tag(meshRefConfig.valeur(),    pb));
          meshRefConfig->reprendre(is);
          avancer_fichier(is, generate_field_tag(meshTransGrad.valeur(),    pb));
          meshTransGrad->reprendre(is);
          avancer_fichier(is, generate_field_tag(meshStress.valeur(),       pb));
          meshStress->reprendre(is);
        }
      else
        {
          // PDI: fields accessed by name, order is irrelevant
          read_pdi(meshDisplacement, "_MeshDisplacement",          pb);
          read_pdi(meshVelocity,     "_MeshVelocity",              pb);
          read_pdi(meshAcceleration, "_MeshAcceleration",          pb);
          read_pdi(meshPosition,     "_MeshPosition",              pb);
          read_pdi(meshRefConfig,    "_MeshReferenceConfiguration",pb);
          read_pdi(meshTransGrad,    "_MeshTransformationGradient",pb);
          read_pdi(meshStress,       "_MeshStress",                pb);
        }
 
      dom.resumptionStructuralDynamicsMesh(
        pb.schema_temps().temps_courant(),
        meshDisplacement->valeurs(), meshVelocity->valeurs(),
        meshAcceleration->valeurs(), meshPosition->valeurs(),
        meshRefConfig->valeurs(),    meshTransGrad->valeurs(),
        meshStress->valeurs());
    }
 
  return 1;
}
 
int ALE_CheckpointManager::write_pdi(const DoubleTab& d, const Nom& pdi_name) const
{
  TRUST_2_PDI pdi_interface;
  pdi_interface.share_TRUSTTab_dimensions(d, pdi_name, 1);
  if (d.dimension_tot(0))
    pdi_interface.TRUST_start_sharing(pdi_name.getString(), d.addr());
  else
    {
      ArrOfDouble garbage(d.nb_dim()); // PDI requires non-null pointer on empty MPI ranks
      pdi_interface.TRUST_start_sharing(pdi_name.getString(), garbage.addr());
    }
  return 8 * d.size_array();
}
 
void ALE_CheckpointManager::read_pdi(OWN_PTR(Champ_Inc_base)& champ,
                                     const std::string& suffix,
                                     const Probleme_base& pb) const
{
  TRUST_2_PDI pdi_interface;
  Nom pdi_name = (pb.le_nom() + Nom(suffix.c_str())).majuscule();
  pdi_interface.share_TRUSTTab_dimensions(champ->valeurs(), pdi_name, 0);
  if (champ->valeurs().dimension_tot(0))
    pdi_interface.read(pdi_name.getChar(), champ->valeurs().addr());
  else
    {
      ArrOfDouble garbage(champ->valeurs().nb_dim());
      pdi_interface.read(pdi_name.getChar(), garbage.addr());
    }
}
 
Nom ALE_CheckpointManager::generate_field_tag(const Champ_Inc_base& champ,
                                              const Probleme_base& pb) const
{
  Nom tag = champ.le_nom();
  tag += champ.que_suis_je();
  tag += pb.domaine().le_nom();
  tag += Nom(pb.schema_temps().temps_courant(), pb.reprise_format_temps());
  return tag;
}
 
YAML_data ALE_CheckpointManager::make_yaml(const std::string& suffix, int nb_dim,
                                           const Probleme_base& pb) const
{
  std::string name = pb.le_nom().getString() + suffix;
  std::transform(name.begin(), name.end(), name.begin(), ::toupper);
  return YAML_data(name, "double", nb_dim);
}
 
std::vector<YAML_data> ALE_CheckpointManager::data_a_sauvegarder(const Probleme_base& pb,
                                                                 const Domaine_ALE& dom) const
{
  constexpr int nb_dim = 2;
  std::vector<YAML_data> data;
  data.push_back(make_yaml("_MeshCoords", nb_dim, pb));
  if (dom.getMeshMotionModel() == 1)
    {
      data.push_back(make_yaml("_MeshDisplacement",          nb_dim, pb));
      data.push_back(make_yaml("_MeshVelocity",              nb_dim, pb));
      data.push_back(make_yaml("_MeshAcceleration",          nb_dim, pb));
      data.push_back(make_yaml("_MeshPosition",              nb_dim, pb));
      data.push_back(make_yaml("_MeshReferenceConfiguration",nb_dim, pb));
      data.push_back(make_yaml("_MeshTransformationGradient",nb_dim, pb));
      data.push_back(make_yaml("_MeshStress",                nb_dim, pb));
    }
  return data;
}
 
void ALE_CheckpointManager::create_field(OWN_PTR(Champ_Inc_base)& champ,
                                         const std::string& name, int nbComp,
                                         const Motcle& directive,
                                         const Probleme_base& pb,
                                         Domaine_ALE& dom) const
{
  double temps = pb.schema_temps().temps_courant();
  Noms noms(1), unit(1);
  unit[0] = "none";
  noms[0] = name;
  pb.discretisation().discretiser_champ(directive, pb.domaine_dis(),
                                        vectoriel, noms, unit, nbComp, 1, temps, champ);
  dom.get_champs_compris().ajoute_champ(champ); // via public accessor, no friend needed
  champ->add_synonymous(name);
}