Champ_Generique_Moyenne.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 <Champ_Generique_Moyenne.h>
#include <Discretisation_base.h>
#include <Schema_Temps_base.h>
#include <Champs_compris.h>
#include <Synonyme_info.h>
#include <Postraitement.h>
#include <Param.h>
 
Implemente_instanciable(Champ_Generique_Moyenne,"Champ_Post_Statistiques_Moyenne|Moyenne",Champ_Generique_Statistiques_base);
// XD moyenne champ_post_statistiques_base moyenne INHERITS_BRACE to calculate the average of the field over time
 
Sortie& Champ_Generique_Moyenne::printOn(Sortie& s ) const
{
  return s << que_suis_je() << " " << le_nom();
}
 
Entree& Champ_Generique_Moyenne::readOn(Entree& s )
{
  return Champ_Generique_Statistiques_base::readOn(s);
}
 
//condition_initiale : to set the value of the integral
//of the mean operator using Champ_Fonc_reprise
//to read the mean recovered from a .xyz file
void Champ_Generique_Moyenne::set_param(Param& param) const
{
  Champ_Generique_Statistiques_base::set_param(param);
  param.ajouter_non_std("moyenne_convergee",(this)); // XD attr moyenne_convergee field_base moyenne_convergee OPT This
  // XD_CONT option allows to read a converged time averaged field in a .xyz file in order to calculate, when resuming
  // XD_CONT the calculation, the statistics fields (rms, correlation) which depend on this average. In that case, the
  // XD_CONT time averaged field is not updated during the resume of calculation. In this case, the time averaged field
  // XD_CONT must be fully converged to avoid errors when calculating high order statistics.
}
 
int Champ_Generique_Moyenne::lire_motcle_non_standard(const Motcle& mot, Entree& is)
{
  if (mot=="moyenne_convergee")
    {
      ref_cast(Op_Moyenne,Operateur_Statistique()).lire_ch_moyenne(is);
      return 1;
    }
  else
    return Champ_Generique_Statistiques_base::lire_motcle_non_standard(mot,is);
}
 
void Champ_Generique_Moyenne::completer(const Postraitement_base& post)
{
  Champ_Gen_de_Champs_Gen::completer(post);
 
  const Probleme_base& Pb = get_ref_pb_base();
  const Champ_Generique_base& ch_integre = get_source(0);
  const Domaine_dis_base& zdis = get_ref_domaine_dis_base();
 
  Op_Moyenne_.associer(zdis,ch_integre,tstat_deb_,tstat_fin_);
 
  Nom prefix = Pb.le_nom() + "_";
  if(post.le_nom() != "??" && post.le_nom() != "neant")
    prefix += post.le_nom() +"_";
  if(parent_name_ != "??" && !use_source_name_only_)
    prefix += parent_name_ + "_";
  Op_Moyenne_.completer(Pb, prefix);
}
 
const Champ_base& Champ_Generique_Moyenne::get_champ_without_evaluation(OWN_PTR(Champ_base)& espace_stockage) const
{
  const OBS_PTR(Champ_Generique_base)& mon_champ = integrale().le_champ();
  OWN_PTR(Champ_base) espace_stockage_source;
  const Champ_base& source = mon_champ->get_champ(espace_stockage_source);
  Nature_du_champ nature_source = source.nature_du_champ();
  int nb_comp = source.nb_comp();
  OWN_PTR(Champ_Fonc_base) es_tmp;
  espace_stockage = creer_espace_stockage(nature_source,nb_comp,es_tmp);
  return espace_stockage;
}
 
const Champ_base& Champ_Generique_Moyenne::get_champ(OWN_PTR(Champ_base)&) const
{
  // Creation of the storage space
  const OBS_PTR(Champ_Generique_base)& mon_champ = integrale().le_champ();
  OWN_PTR(Champ_base) espace_stockage_source;
  const Champ_base& source = mon_champ->get_champ(espace_stockage_source);
  Nature_du_champ nature_source = source.nature_du_champ();
  int nb_comp = source.nb_comp();
  if (!espace_stockage_)
    creer_espace_stockage(nature_source,nb_comp,espace_stockage_);
  else
    espace_stockage_->changer_temps(temps());
  DoubleTab& tab_moy = espace_stockage_->valeurs();
  tab_moy = Op_Moyenne_.calculer_valeurs();
  tab_moy.echange_espace_virtuel();
  return espace_stockage_;
}
 
const Noms Champ_Generique_Moyenne::get_property(const Motcle& query) const
{
 
  //Component creation should be done dynamically (Moyenne_...)
 
  Motcles motcles(1);
  motcles[0] = "composantes";
 
  int rang = motcles.search(query);
  switch(rang)
    {
 
    case 0:
      {
        //We set the specific components for Champ_Generique_Moyenne
        //because in Format_Post_Lml::ecrire_champ_lml() in the case of ELEM localisation
        //they are used
 
        //Currently the choice is simply to add the component number
        /*
          const Noms compo_cibles = get_source(0).get_property("composantes");
          int size = compo_cibles.size();
          Noms mots(size);
          for (int i=0; i<size; i++) {
          mots[i] = "Moyenne_";
          mots[i] += compo_cibles[i];
          }
 
          return mots;
 
          break;
        */
 
        const Noms source_compos = get_source(0).get_property("composantes");
        int nb_comp = source_compos.size();
        Noms compo(nb_comp);
 
        for (int i=0; i<nb_comp; i++)
          {
            Nom nume(i);
            compo[i] = nom_post_+nume;
          }
 
        return compo;
      }
    }
  return Champ_Gen_de_Champs_Gen::get_property(query);
}
 
//Name the field as a source by default
//"Moyenne_"+nom_champ_source
void Champ_Generique_Moyenne::nommer_source()
{
  if (nom_post_=="??")
    {
      Nom nom_post_source, nom_champ_source;
      const Noms nom = get_source(0).get_property("nom");
      nom_champ_source = nom[0];
      nom_post_source =  "Moyenne_";
      nom_post_source +=  nom_champ_source;
      nommer(nom_post_source);
    }
}
 
bool Champ_Generique_Moyenne::has_champ_post(const Motcle& nom) const
{
  if (Champ_Gen_de_Champs_Gen::has_champ_post(nom))
    return true;
 
  Noms nom_source = get_source(0).get_property("nom");
  Motcle nom_champ = nom_source[0];
  Motcle nom_champ_moyenne("Moyenne_");
  nom_champ_moyenne += nom_champ;
  nom_champ_moyenne += "_";
  nom_champ_moyenne += Nom(tstat_deb_, "%e");
  nom_champ_moyenne += "_";
  nom_champ_moyenne += Nom(tstat_fin_, "%e");
 
  if (nom_champ_moyenne == nom)
    return true;
 
  return false; /* nothing found */
}
 
const Champ_Generique_base& Champ_Generique_Moyenne::get_champ_post(const Motcle& nom) const
{
  if (Champ_Gen_de_Champs_Gen::has_champ_post(nom))
    return Champ_Gen_de_Champs_Gen::get_champ_post(nom);
 
  OBS_PTR(Champ_Generique_base) ref_champ;
 
  Noms nom_source = get_source(0).get_property("nom");
  Motcle nom_champ = nom_source[0];
  Motcle nom_champ_moyenne("Moyenne_");
  nom_champ_moyenne += nom_champ;
  nom_champ_moyenne += "_";
  nom_champ_moyenne += Nom(tstat_deb_, "%e");
  nom_champ_moyenne += "_";
  nom_champ_moyenne += Nom(tstat_fin_, "%e");
 
  if (nom_champ_moyenne == nom)
    {
      ref_champ = *this;
      ref_champ->fixer_identifiant_appel(nom);
      return ref_champ;
    }
 
  throw std::runtime_error(std::string("Field ") + nom.getString() + std::string(" not found !"));
}
 
int Champ_Generique_Moyenne::comprend_champ_post(const Motcle& identifiant) const
{
  if (Champ_Gen_de_Champs_Gen::comprend_champ_post(identifiant))
    return 1;
 
  //Additional name tested because it is the name used by:
  //Champ_Generique_Ecart_Type::completer()
  //Champ_Generique_Correlation::completer()
  Noms nom_source = get_source(0).get_property("nom");
  Motcle nom_champ = nom_source[0];
  Motcle nom_champ_moyenne("Moyenne_");
  nom_champ_moyenne += nom_champ;
  nom_champ_moyenne += "_";
  nom_champ_moyenne += Nom(tstat_deb_,"%e");
  nom_champ_moyenne += "_";
  nom_champ_moyenne += Nom(tstat_fin_,"%e");
 
  if (nom_champ_moyenne==identifiant)
    return 1;
 
  return 0;
}