Operateur_Conv.cpp

/****************************************************************************
* Copyright (c) 2025, 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 <Discretisation_base.h>
#include <Op_Conv_negligeable.h>
#include <Operateur_Conv.h>
#include <Perf_counters.h>
#include <Champ_base.h>
 
Implemente_instanciable(Operateur_Conv,"Operateur_Conv",OWN_PTR(Operateur_Conv_base));
// XD convection_deriv objet_lecture convection_deriv NO_BRACE not_set
// XD bloc_convection objet_lecture nul NO_BRACE not_set
// XD attr aco chaine(into=["{"]) aco REQ Opening curly bracket.
// XD attr operateur convection_deriv operateur REQ not_set
// XD attr acof chaine(into=["}"]) acof REQ Closing curly bracket.
 
/* Here we put the doc for all shared (VDF, VEF,...) keywords: */
 
// XD convection_negligeable convection_deriv negligeable NO_BRACE For VDF and VEF discretizations. Suppresses the
// XD_CONT convection operator.
 
// XD convection_amont convection_deriv amont NO_BRACE Keyword for upwind scheme for VDF or VEF discretizations.
 
// XD convection_centre convection_deriv centre NO_BRACE For VDF and VEF discretizations.
 
// XD convection_centre4 convection_deriv centre4 NO_BRACE For VDF and VEF discretizations.
 
 
Sortie& Operateur_Conv::printOn(Sortie& os) const
{
  return Operateur::ecrire(os);
}
 
Entree& Operateur_Conv::readOn(Entree& is)
{
  Operateur::lire(is);
  if ((mon_equation->le_nom() ==  "pb_sensibiliteNavier_Stokes_standard_sensibility")  && (valeur().que_suis_je()!="Op_Conv_sensibility_VEF_P1NC"))
    {
      Cerr<<" You should use the sensibility convection operator within Navier_Stokes_standard_sensibility equation "<<finl;
      Cerr<<" Exemple:  convection { sensibility { amont } }  "<<finl;
      exit();
    }
 
  if (!sub_type(Op_Conv_negligeable, valeur()) && mon_equation->domaine_dis().domaine().que_suis_je().contient("ALE") && !valeur().que_suis_je().contient("ALE"))
    {
      Cerr<<" You should use the ALE convection operator within the Navier_Stokes_standard_ALE/Navier_Stokes_Turbulent_ALE equation "<<finl;
      Cerr<<" Exemple:  convection { ALE amont }  "<<finl;
      Process::exit();
    }
 
  return is;
}
 
/*! @brief Types the operator: "Op_Conv" + keyword + discretisation + unknown
 *
 *      Associates the transporting velocity to the base operator
 *
 */
void Operateur_Conv::typer()
{
  if (Motcle(typ)==Motcle("negligeable"))
    OWN_PTR(Operateur_Conv_base)::typer("Op_Conv_negligeable");
  else
    {
      Equation_base& eqn=mon_equation.valeur();
      Nom nom_type=eqn.discretisation().get_name_of_type_for(que_suis_je(),typ,eqn,vitesse());
      OWN_PTR(Operateur_Conv_base)::typer(nom_type);
      valeur().associer_vitesse(vitesse());
    }
  Cerr << valeur().que_suis_je() << finl;
}
 
/*! @brief Adds the contribution of the operator to the array passed as parameter
 *
 * @param (DoubleTab& donnee) array containing the data on which the operator is applied.
 * @param (DoubleTab& resu) array to which the contribution of the operator is added
 * @return (DoubleTab&) the array containing the result
 */
DoubleTab& Operateur_Conv::ajouter(const DoubleTab& donnee,
                                   DoubleTab& resu) const
{
  statistics().begin_count(STD_COUNTERS::convection,statistics().get_last_opened_counter_level()+1);
  DoubleTab& tmp = valeur().ajouter(donnee, resu);
  statistics().end_count(STD_COUNTERS::convection);
  return tmp;
}
 
/*! @brief Initializes the array passed as parameter with the contribution of the operator.
 *
 * @param (DoubleTab& donnee) array containing the data on which the operator is applied.
 * @param (DoubleTab& resu) array in which the contribution of the operator is stored
 * @return (DoubleTab&) the array containing the result
 */
DoubleTab& Operateur_Conv::calculer(const DoubleTab& donnee,
                                    DoubleTab& resu) const
{
  statistics().begin_count(STD_COUNTERS::convection,statistics().get_last_opened_counter_level()+1);
  DoubleTab& tmp = valeur().calculer(donnee, resu);
  statistics().end_count(STD_COUNTERS::convection);
  return tmp;
}
 
void Operateur_Conv::associer_norme_vitesse(const Champ_base& norme_vitesse)
{
  assert( op_non_nul() );
  valeur().associer_norme_vitesse(norme_vitesse);
}