Solveur_Masse_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 <Solveur_Masse_base.h>
#include <TRUSTTab_parts.h>
#include <Equation_base.h>
#include <Champ_Uniforme.h>
#include <Matrice_Morse.h>
#include <TRUSTTrav.h>
#include <Debog.h>
#include <Device.h>
 
Implemente_base_sans_constructeur(Solveur_Masse_base,"Solveur_Masse_base",Objet_U);
 
Solveur_Masse_base::Solveur_Masse_base() : has_coefficient_temporel_(0), penalisation_flag_(1), penalisation_(0)  {}
 
Sortie& Solveur_Masse_base::printOn(Sortie& os) const { return os; }
Entree& Solveur_Masse_base::readOn(Entree& is) { return is; }
 
/*! @brief DOES NOTHING - to override in derived classes.
 *
 * Time update of the mass solver.
 *
 * @param (double) the time step for the update
 */
void Solveur_Masse_base::mettre_a_jour(double )
{
}
 
/*! @brief DOES NOTHING - to override in derived classes.
 *
 * Reset current time.
 * @param (double) new current time.
 */
void Solveur_Masse_base::resetTime(double )
{
}
 
/*! @brief DOES NOTHING
 *
 * May be overridden in derived classes
 * if the mass matrix requires assembly.
 * Assembles the mass solver (generally the mass matrix)
 */
void Solveur_Masse_base::assembler()
{
}
 
/*! @brief Allows choosing the name of the temporal coefficient to use for apply
 *
 *  Verifies that the field exists
 *
 */
void Solveur_Masse_base::set_name_of_coefficient_temporel(const Nom& name)
{
  name_of_coefficient_temporel_ = name;
  has_coefficient_temporel_ = 1;
  if (name == "no_coeff")
    {
      has_coefficient_temporel_ = 0;
      return;
    }
 
  if (equation().has_champ(name_of_coefficient_temporel_))
    {
      /* Do nothing */
    }
  else
    {
      Cerr << name_of_coefficient_temporel_ << " not understood by " << equation().que_suis_je() << finl;
      Process::exit();
    }
}
 
/*! @brief Returns appliquer_impl(x/temporal_coefficient) if a temporal coefficient is set, otherwise returns appliquer_impl(x)
 *
 *  Return M-1.x
 */
DoubleTab& Solveur_Masse_base::appliquer(DoubleTab& x) const
{
  if (has_coefficient_temporel_)
    {
      OBS_PTR(Champ_base) ref_coeff;
      ref_coeff = equation().get_champ(name_of_coefficient_temporel_);
 
      DoubleTab values;
      if (sub_type(Champ_Uniforme, ref_coeff.valeur()))
        {
          const Champ_Uniforme& coeff = ref_cast(Champ_Uniforme,ref_coeff.valeur());
          values = coeff.valeurs();
        }
      else if (sub_type(Champ_Inc_base,ref_coeff.valeur()))
        {
          const Champ_Inc_base& coeff = ref_cast(Champ_Inc_base,ref_coeff.valeur());
          values.ref(coeff.valeurs());
 
        }
      else if (sub_type(Champ_Fonc_base,ref_coeff.valeur()))
        {
          const Champ_Fonc_base& coeff = ref_cast(Champ_Fonc_base,ref_coeff.valeur());
          values.ref(coeff.valeurs());
 
        }
      else if (sub_type(Champ_Don_base,ref_coeff.valeur()))
        {
          DoubleTab nodes;
          equation().inconnue().remplir_coord_noeuds(nodes);
          ref_coeff->valeur_aux(nodes,values);
        }
 
      Debog::verifier("Solveur_Masse_base::appliquer coeffs",values);
      //tab_divide_any_shape(x, values, VECT_REAL_ITEMS);
      DoubleTab_parts values_parts(values);
      tab_divide_any_shape(x, values_parts[0], VECT_REAL_ITEMS);
    }
  return appliquer_impl(x); // M-1.x
}
 
// Add M/dt into matrix
Matrice_Base& Solveur_Masse_base::ajouter_masse(double dt, Matrice_Base& matrice, int penalisation_flag) const
{
  Matrice_Morse& matmo=ref_cast(Matrice_Morse, matrice);
  if (has_interface_blocs())
    {
      penalisation_flag_ = penalisation_flag;
      DoubleTrav inco(equation().inconnue().valeurs());
      ajouter_blocs({{ equation().inconnue().le_nom().getString(), &matmo }}, inco, dt, {}, 0); //on tente ajouter_blocs()
      return matrice;
    }
 
  DoubleTrav tab_diag(equation().inconnue().valeurs());
  const int sz = equation().inconnue().valeurs().dimension_tot(0) * tab_diag.line_size();
  tab_diag=1.;
  appliquer(tab_diag); // M-1
  int prems=0;
  if(penalisation_flag)
    {
      ToDo_Kokkos("critical");
      if (penalisation_==0)
        {
          double penal=0;
          for(int i=0; i<sz; i++)
            penal=std::max(penal, matmo(i,i));
          penal=mp_max(penal);
          penalisation_=(mp_max_vect(tab_diag)/dt + penal)*1.e3;
          prems=1;
        }
      for(int i=0; i<sz; i++)
        {
          if (tab_diag.addr()[i]==0)
            {
              if(prems)
                {
                  matmo(i,i)+=penalisation_;
                  prems=0;
                }
              matmo(i,i)+=penalisation_/dt;
            }
          else
            matmo(i,i)+=1./(tab_diag.addr()[i]*dt); // M/dt
        }
    }
  else
    {
      CDoubleArrView diag = static_cast<const ArrOfDouble&>(tab_diag).view_ro();
      Matrice_Morse_View mat;
      mat.set(matmo);
      Kokkos::parallel_for(start_gpu_timer(__KERNEL_NAME__), sz, KOKKOS_LAMBDA(
                             const int i)
      {
        if (diag(i) != 0)
          mat.add(i, i, 1. / (diag(i) * dt)); // M/dt
      });
      end_gpu_timer(__KERNEL_NAME__);
    }
  return matrice;
}
 
// Add M*y/dt to x
DoubleTab& Solveur_Masse_base::ajouter_masse(double dt, DoubleTab& tab_x, const DoubleTab& tab_y, int penalisation_flag, bool use_old_volumes) const
{
  if (has_interface_blocs())
    {
      penalisation_flag_ = penalisation_flag;
      const std::string& nom_inco = equation().inconnue().le_nom().getString();
      ajouter_blocs({}, tab_x, dt, {{nom_inco,tab_y}}, 0); //on tente ajouter_blocs()
      return tab_x;
    }
 
  // Optional ALE RHS pre-scaling: y_scaled = (V_old/V_new) ⊙ y
  const DoubleTab* py = &tab_y;
  DoubleTrav y_scaled;
  if (use_old_volumes)
    {
      y_scaled = tab_y;
      equation().domaine_dis().domaine().apply_old_to_new_volume_scaling(y_scaled, equation().domaine_dis());
      py = &y_scaled;
    }
 
  int sz = py->size();
  DoubleTrav tab_diag;
  tab_diag.copy(equation().inconnue().valeurs(), RESIZE_OPTIONS::NOCOPY_NOINIT);
  tab_diag=1.;
  appliquer(tab_diag); // M-1
  if (penalisation_flag)
    {
      if (penalisation_==0)
        penalisation_ = mp_max_vect(tab_diag)*1.e3;
    }
  else
    penalisation_=1;
 
  double penalisation = penalisation_;
  CDoubleArrView diag = static_cast<const ArrOfDouble&>(tab_diag).view_ro();
  CDoubleArrView y = static_cast<const ArrOfDouble&>(*py).view_ro();
  DoubleArrView x = static_cast<ArrOfDouble&>(tab_x).view_rw();
  Kokkos::parallel_for(start_gpu_timer(__KERNEL_NAME__), sz, KOKKOS_LAMBDA(const int i)
  {
    if (diag(i)==0)
      x(i)=penalisation*y(i);
    else
      x(i)+=1./(diag(i)*dt)*y(i);
  });
  end_gpu_timer(__KERNEL_NAME__);
  //x.echange_espace_virtuel();Debog::verifier("Solveur_Masse::ajouter_masse",x);
  return tab_x;
}
 
Matrice_Base& Solveur_Masse_base::ajouter_masse_dt_local(DoubleVect& dt_locaux, Matrice_Base& matrice, int penalisation) const
{
  Matrice_Morse& matmo=ref_cast(Matrice_Morse, matrice);
  int sz=matmo.nb_lignes();;
  DoubleTrav diag(equation().inconnue().valeurs());
  diag=1.;
  appliquer(diag); // M-1
  int prems=0;
  if(penalisation)
    {
      if (penalisation_==0)
        {
          double penal=0;
          for(int i=0; i<sz; i++)
            penal=std::max(penal, matmo(i,i));
          penal=mp_max(penal);
          penalisation_=(mp_max_vect(diag)/dt_locaux.local_max_vect() + penal)*1.e3;
          prems=1;
        }
    }
  else
    penalisation_=0;
  ToDo_Kokkos("critical");
  for(int i=0; i<sz; i++)
    {
      if (diag.addr()[i]==0)
        {
          if(prems)
            {
              matmo(i,i)+=penalisation_;
              prems=0;
            }
          matmo(i,i)+=penalisation_/dt_locaux[i];
        }
      else
        matmo(i,i)+=1./(diag.addr()[i]*dt_locaux[i]);
    }
  return matrice;
}
 
DoubleTab& Solveur_Masse_base::ajouter_masse_dt_local(DoubleVect& dt_locaux, DoubleTab& x, const DoubleTab& y, int penalisation) const
{
  int sz=y.size();
  DoubleTrav diag;
  diag.copy(equation().inconnue().valeurs(), RESIZE_OPTIONS::NOCOPY_NOINIT);
  diag=1.;
  appliquer(diag);
  if (penalisation)
    {
      if (penalisation_==0)
        penalisation_ = mp_max_vect(diag)*1.e3;
    }
  else
    penalisation_=1;
  ToDo_Kokkos("critical");
  for(int i=0; i<sz; i++)
    {
      if (diag.addr()[i]==0)
        x.addr()[i]=penalisation_*y.addr()[i];
      else
        x.addr()[i]+=1./(diag.addr()[i]*dt_locaux[i])*y.addr()[i];
 
    }
  return x;
}
 
void Solveur_Masse_base::get_masse_dt_local(DoubleVect& m_dt_locaux, DoubleVect& dt_locaux, int penalisation)
{
  int sz=dt_locaux.size();
  DoubleTab diag;
  diag.copy(equation().inconnue().valeurs(), RESIZE_OPTIONS::NOCOPY_NOINIT);
  diag=1.;
  appliquer(diag);
  if (penalisation)
    {
      if (penalisation_==0)
        penalisation_ = mp_max_vect(diag)*1.e3;
    }
  else
    penalisation_=1;
  ToDo_Kokkos("critical");
  for(int i=0; i<sz; i++)
    {
      if (diag.addr()[i]==0)
        m_dt_locaux[i]=0.;
      else
        m_dt_locaux[i]=(1./diag.addr()[i])*dt_locaux[i];
 
    }
  m_dt_locaux.echange_espace_virtuel();
 
  //Debog::verifier("Solveur_Masse::ajouter_masse",x);
}
 
 
void Solveur_Masse_base::get_masse_divide_by_local_dt(DoubleVect& m_dt_locaux, DoubleVect& dt_locaux, int penalisation)
{
  int sz=dt_locaux.size();
  DoubleTab diag;
  diag.copy(equation().inconnue().valeurs(), RESIZE_OPTIONS::NOCOPY_NOINIT);
  diag=1.;
  appliquer(diag);
  if (penalisation)
    {
      if (penalisation_==0)
        penalisation_ = mp_max_vect(diag)*1.e3;
    }
  else
    penalisation_=1;
  ToDo_Kokkos("critical");
  for(int i=0; i<sz; i++)
    {
      if (diag.addr()[i]==0)
        m_dt_locaux[i]=0.;
      else
        m_dt_locaux[i]=(1./diag.addr()[i])/dt_locaux[i];
 
    }
  m_dt_locaux.echange_espace_virtuel();
 
  //Debog::verifier("Solveur_Masse::ajouter_masse",x);
 
}
 
DoubleTab& Solveur_Masse_base::corriger_solution(DoubleTab& tab_x, const DoubleTab& tab_y, int incr) const
{
  int sz = tab_y.dimension_tot(0) * tab_y.line_size();
  DoubleTrav tab_diag(equation().inconnue().valeurs());
  tab_diag=1.;
  appliquer(tab_diag); // M-1
  // If x and y are on the device, offload execution to the device:
  bool kernelOnDevice = tab_x.checkDataOnDevice(tab_y);
  if (kernelOnDevice)
    {
      CDoubleArrView diag = static_cast<const ArrOfDouble&>(tab_diag).view_ro();
      CDoubleArrView y    = static_cast<const ArrOfDouble&>(tab_y).view_ro();
      DoubleArrView  x    = static_cast<ArrOfDouble&>(tab_x).view_wo();
      Kokkos::parallel_for(start_gpu_timer(__KERNEL_NAME__), sz, KOKKOS_LAMBDA(const int i)
      {
        if (diag[i]<1.e-12)
          x[i] = y[i];
      });
      end_gpu_timer(__KERNEL_NAME__, kernelOnDevice);
    }
  else
    {
      for(int i=0; i<sz; i++)
        if (tab_diag.addr()[i]<1.e-12)
          tab_x.addr()[i] = tab_y.addr()[i];
    }
  return tab_x;
}
 
// Added method dimensionner()
// which sizes the matrix to the diagonal when
// all operators are negligible.
// The code is the one used in the Noyau version of Equation_base::dimensionner_matrice()
void Solveur_Masse_base::dimensionner(Matrice_Morse& matrix) const
{
  if (has_interface_blocs())
    {
      dimensionner_blocs({{ equation().inconnue().le_nom().getString(), &matrix }}, {}); //on tente dimensionner_blocs
      return;
    }
  const DoubleTab& champ_inconnue = equation().inconnue().valeurs();
  int size = champ_inconnue.dimension_tot(0) * champ_inconnue.line_size();
 
  IntTab indice(size, 2);
  for(int i=0; i<size; ++i)
    {
      indice(i,0) = indice(i,1) = i;
    }
  matrix.dimensionner(indice);
}
 
void Solveur_Masse_base::dimensionner_blocs(matrices_t matrices, const tabs_t& semi_impl) const
{
  Process::exit(que_suis_je() + " : dimensionner_blocs not coded!");
}
 
void Solveur_Masse_base::ajouter_blocs(matrices_t matrices, DoubleTab& secmem, double dt, const tabs_t& semi_impl, int resoudre_en_increments) const
{
  Process::exit(que_suis_je() + " : ajouter_blocs not coded!");
}
 
// Added method completer
// Does nothing by default
void Solveur_Masse_base::completer() { }
 
// Added method preparer_calcul
// Does nothing by default
void Solveur_Masse_base::preparer_calcul() { }