Source_Transport_proto.cpp

/****************************************************************************
* Copyright (c) 2022, 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 <Pb_Thermohydraulique_Concentration_Turbulent.h>
#include <Pb_Hydraulique_Concentration_Turbulent.h>
#include <Pb_Thermohydraulique_Turbulent_QC.h>
#include <Pb_Thermohydraulique_Turbulent.h>
#include <Pb_Hydraulique_Turbulent.h>
#include <Source_Transport_proto.h>
#include <Fluide_Dilatable_base.h>
#include <Param.h>
 
// Source-transport keyword blocks. They are declared here, next to the readOn_*
// helpers that actually read their parameters, rather than in TRAD2_turbulence.xd.
// Each block uses the param fragment matching the readOn_* variant it calls.
// XD source_transport_eps source_base source_transport_eps INHERITS_BRACE Keyword to alter the source term constants
// XD_CONT for eps in the bicephale k-eps model epsilon transport equation. By default, these constants are set to:
// XD_CONT C1_eps=1.44 C2_eps=1.92
// XD_USE_PARAM_FRAGMENT source_transport_proto
// XD source_transport_k source_base source_transport_k INHERITS_BRACE Keyword to alter the source term constants for k
// XD_CONT in the bicephale k-eps model epsilon transport equation.
// XD source_transport_k_eps source_base source_transport_k_eps INHERITS_BRACE Keyword to alter the source term
// XD_CONT constants in the standard k-eps model epsilon transport equation. By default, these constants are set to:
// XD_CONT C1_eps=1.44 C2_eps=1.92
// XD_USE_PARAM_FRAGMENT source_transport_proto
// XD source_transport_k_eps_realisable source_base source_transport_k_eps_realisable INHERITS_BRACE Keyword to alter
// XD_CONT the source term constants in the standard k-eps model epsilon transport equation. By default, these constants
// XD_CONT are set to: C1_eps=1.44 C2_eps=1.92
// XD_USE_PARAM_FRAGMENT source_transport_realisable
// XD Source_Transport_K_Eps_anisotherme source_transport_k_eps Source_Transport_K_Eps_anisotherme INHERITS_BRACE
// XD_CONT Keywords to modify the source term constants in the anisotherm standard k-eps model epsilon transport
// XD_CONT equation. By default, these constants are set to: C1_eps=1.44 C2_eps=1.92 C3_eps=1.0
// XD_USE_PARAM_FRAGMENT source_transport_anisotherme
// XD source_transport_k_eps_aniso_concen source_transport_k_eps source_transport_k_eps_aniso_concen INHERITS_BRACE
// XD_CONT Keywords to modify the source term constants in the anisotherm standard k-eps model epsilon transport
// XD_CONT equation. By default, these constants are set to: C1_eps=1.44 C2_eps=1.92 C3_eps=1.0
// XD_USE_PARAM_FRAGMENT source_transport_anisotherme
// XD source_transport_k_eps_aniso_therm_concen source_transport_k_eps source_transport_k_eps_aniso_therm_concen INHERITS_BRACE Keywords to modify the source term constants in the anisotherm standard k-eps model epsilon transport equation. By default, these constants are set to: C1_eps=1.44 C2_eps=1.92 C3_eps=1.0
// XD_USE_PARAM_FRAGMENT source_transport_anisotherme
 
// XD_DECLARE_PARAM_FRAGMENT source_transport_proto Source term constants for the standard k-eps model epsilon equation.
Entree& Source_Transport_proto::readOn_proto( Entree& is, const Nom& nom)
{
  Param param(nom);
  param.ajouter("C1_eps", &C1); // XD_ADD_P double
  // XD_CONT Constant for the epsilon equation (default = 1.44)
  param.ajouter("C2_eps", &C2); // XD_ADD_P double
  // XD_CONT Constant for the epsilon equation (default = 1.92)
  param.lire_avec_accolades(is);
  Cerr << "C1_eps = " << C1 << finl;
  Cerr << "C2_eps = " << C2 << finl;
  return is;
}
 
Entree& Source_Transport_proto::readOn_nothing(Entree& is, const Nom& nom)
{
  Param param(nom);
  param.lire_avec_accolades(is);
  return is ;
}
 
// XD_DECLARE_PARAM_FRAGMENT source_transport_anisotherme Additional source term constant for the anisothermal model.
Entree& Source_Transport_proto::readOn_anisotherme(Entree& is, const Nom& nom)
{
  Param param(nom);
  param.ajouter("C1_eps", &C1); // provided by the source_transport_proto fragment (inherited)
  param.ajouter("C2_eps", &C2); // provided by the source_transport_proto fragment (inherited)
  param.ajouter("C3_eps", &C3); // XD_ADD_P double
  // XD_CONT Constant for the epsilon equation (default = 1.0)
  param.lire_avec_accolades(is);
  Cerr << "C1_eps = " << C1 << finl;
  Cerr << "C2_eps = " << C2 << finl;
  Cerr << "C3_eps = " << C3 << finl;
  return is ;
}
 
Entree& Source_Transport_proto::readOn_concen(Entree& is, const Nom& nom) { return readOn_anisotherme(is,nom); }
 
Entree& Source_Transport_proto::readOn_anisotherme_concen(Entree& is, const Nom& nom) { return readOn_anisotherme(is,nom); }
 
// XD_DECLARE_PARAM_FRAGMENT source_transport_realisable Source term constants for the realisable k-eps model.
Entree& Source_Transport_proto::readOn_real(Entree& is, const Nom& nom)
{
  Param param(nom);
  param.ajouter("C2_eps", &C2); // XD_ADD_P double
  // XD_CONT Constant for the epsilon equation (default = 1.92)
  param.ajouter("interpolation_viscosite_turbulente", &_interpolation_viscosite_turbulente); // XD_ADD_P entier
  // XD_CONT Method to interpolation the turbulent viscosity (0 for arithmetic, 1 for harmonic, 2 for volume-weighted
  // XD_CONT harmonic, 3 for size-weighted harmonic)
  param.ajouter("coefficient_limiteur", &_coefficient_limiteur); // XD_ADD_P double
  // XD_CONT Clipping coefficient, never used (default = 1)
  param.lire_avec_accolades(is);
  Cerr << "C2_eps = " << C2 << finl;
 
  // Checking of the value given in the data deck for "interpolation_viscosite_turbulente"
  if ( _interpolation_viscosite_turbulente == 0 )
    Cerr << "Interpolation arithmetique de la viscosite turbulente aux faces (si VEF) = " << finl;
  else if ( _interpolation_viscosite_turbulente == 1 )
    Cerr << "Interpolation harmonique de la viscosite turbulente aux faces (si VEF) = " << finl;
  else if ( _interpolation_viscosite_turbulente == 2 )
    Cerr << "Interpolation harmonique ponderee par les volumes de maille de la viscosite turbulente aux faces (si VEF) = " << finl;
  else if ( _interpolation_viscosite_turbulente == 3 )
    Cerr << "Interpolation harmonique ponderee par les tailles de maille de la viscosite turbulente aux faces (si VEF) = " << finl;
  else
    {
      Cerr << "Error in 'interpolation_viscosite_turbulente' input value :" << _interpolation_viscosite_turbulente << finl;
      Process::exit();
    }
 
  return is;
}
 
Entree& Source_Transport_proto::readOn_anisotherme_real(Entree& is, const Nom& nom)
{
  Param param(nom);
  param.ajouter("C2_eps", &C2); // documented via the source_transport_* fragments
  param.ajouter("C3_eps", &C3); // documented via the source_transport_anisotherme fragment
  param.lire_avec_accolades(is);
  Cerr << "C2_eps = " << C2 << finl;
  Cerr << "C3_eps = " << C3 << finl;
  return is;
}
 
Entree& Source_Transport_proto::readOn_concen_real(Entree& is, const Nom& nom) { return readOn_anisotherme_real(is,nom); }
 
Entree& Source_Transport_proto::readOn_anisotherme_concen_real(Entree& is, const Nom& nom) { return readOn_anisotherme_real(is, nom); }
 
void Source_Transport_proto::verifier_pb_keps(const Probleme_base& pb, const Nom& nom)
{
  if (!sub_type(Pb_Hydraulique_Turbulent, pb) && !sub_type(Pb_Thermohydraulique_Turbulent_QC, pb))
    error_model(nom, pb.que_suis_je());
}
 
void Source_Transport_proto::verifier_pb_keps_anisotherme(const Probleme_base& pb, const Nom& nom)
{
  if (!sub_type(Pb_Thermohydraulique_Turbulent, pb))
    error_model(nom, pb.que_suis_je());
}
 
void Source_Transport_proto::verifier_pb_keps_concen(const Probleme_base& pb, const Nom& nom)
{
  if (!sub_type(Pb_Hydraulique_Concentration_Turbulent, pb))
    error_model(nom, pb.que_suis_je());
}
 
void Source_Transport_proto::verifier_pb_keps_anisotherme_concen(const Probleme_base& pb, const Nom& nom)
{
  if (!sub_type(Pb_Thermohydraulique_Concentration_Turbulent, pb))
    error_model(nom, pb.que_suis_je());
}
 
void Source_Transport_proto::verifier_pb_komega(const Probleme_base& pb, const Nom& nom)
{
  if (sub_type(Pb_Thermohydraulique_Turbulent_QC, pb))
    Cerr << "You are using the k-omega model in quasi-compressible. It might not be well validated. Use with caution." << finl;
}
 
void Source_Transport_proto::verifier_milieu_anisotherme(const Probleme_base& pb, const Nom& nom)
{
  const Milieu_base& milieu = pb.equation(1).milieu(); // eq thermique
  if (pb.nombre_d_equations() < 2)
    error_model(nom, pb.que_suis_je());
 
  if (sub_type(Fluide_Dilatable_base, ref_cast(Fluide_base, milieu)))
    error_model(nom, milieu.que_suis_je());
}
 
void Source_Transport_proto::verifier_milieu_concen(const Probleme_base& pb, const Nom& nom)
{
  const Milieu_base& milieu = pb.equation(0).milieu(); // XXX : Attention pas eq 1 car Constituant derive pas de Fluide_base ! donc eq hydro
  if (pb.nombre_d_equations() < 2)
    error_model(nom, pb.que_suis_je());
 
  if (sub_type(Fluide_Dilatable_base, ref_cast(Fluide_base, milieu)))
    error_model(nom, milieu.que_suis_je());
}
 
void Source_Transport_proto::verifier_milieu_anisotherme_concen(const Probleme_base& pb, const Nom& nom)
{
  const Milieu_base& milieu = pb.equation(1).milieu(); // eq thermique
  if (pb.nombre_d_equations() < 3)
    error_model(nom, pb.que_suis_je());
 
  if (sub_type(Fluide_Dilatable_base, ref_cast(Fluide_base, milieu)))
    error_model(nom, milieu.que_suis_je());
}
 
void Source_Transport_proto::verifier_beta_concen(const Fluide_base& fluide)
{
  if (!fluide.has_beta_c())
    {
      Cerr << "You forgot to define beta_co field in the fluid. It is mandatory when using the K-Eps model (buoyancy effects)." << finl;
      Cerr << "If you don't want buoyancy effects, then specify: beta_co champ_uniforme 1 0." << finl;
      Process::exit();
    }
}
 
void Source_Transport_proto::associer_pb_proto(const Probleme_base& pb)
{
  eq_hydraulique = pb.equation(0);
}
 
void Source_Transport_proto::associer_pb_anisotherme(const Probleme_base& pb)
{
  const Fluide_base& fluide = ref_cast(Fluide_base, pb.equation(1).milieu());
  beta_t = fluide.beta_t();
  gravite = fluide.gravite();
  eq_thermique = ref_cast(Convection_Diffusion_Temperature, pb.equation(1));
}
 
void Source_Transport_proto::associer_pb_concen(const Probleme_base& pb)
{
  const Fluide_base& fluide = ref_cast(Fluide_base, pb.equation(0).milieu()); // XXX : Attention pas eq 1 car Constituant derive pas de Fluide_base !
  verifier_beta_concen(fluide);
  beta_c = fluide.beta_c();
  gravite = fluide.gravite();
  eq_concentration = ref_cast(Convection_Diffusion_Concentration, pb.equation(1));
}
 
void Source_Transport_proto::associer_pb_anisotherme_concen(const Probleme_base& pb)
{
  const Fluide_base& fluide = ref_cast(Fluide_base,pb.equation(1).milieu()); // a partir de l'eq thermique
  verifier_beta_concen(fluide);
  beta_t = fluide.beta_t();
  beta_c = fluide.beta_c();
  gravite = fluide.gravite();
  eq_thermique = ref_cast(Convection_Diffusion_Temperature, pb.equation(1));
  eq_concentration = ref_cast(Convection_Diffusion_Concentration, pb.equation(2));
}