VEF_discretisation.h

/****************************************************************************
* 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.
*
*****************************************************************************/
 
#ifndef VEF_discretisation_included
#define VEF_discretisation_included
 
/*! @brief class VEF_discretisation (base scheme)
 *
 * @brief Class that manages the VEF discretization of the problem.
 *     This is where:
 *     * the physical properties of the fluid are discretized, in particular those of the
 *        Ostwald fluid (K, N, Mu, ...)
 *     * the Ostwald field and the hydraulic equation, the fluid and the
 *     domaine_dis_base are associated
 *     ** ( new procedures:
 *   void proprietes_physiques_fluide_Ostwald(Domaine_dis_base& ,Fluide_Ostwald& ,
 *            const Navier_Stokes_std& , const Champ_Inc_base& ) const;
 *    needs the Fluide_Ostwald class to access the fluid being studied
 *                          Navier_Stokes_Std to access the hydraulic equation
 *
 * @sa Discret_Thyd_Turb
 */
 
#include <Discret_Thyd.h>
 
class Fluide_Incompressible;
class Navier_Stokes_std;
class Fluide_Ostwald;
 
class VEF_discretisation : public Discret_Thyd
{
  Declare_instanciable(VEF_discretisation);
public :
  void set_param(Param& param) const override;
  void check_param() override;
 
  void discretiser_champ(const Motcle& directive, const Domaine_dis_base& z, Nature_du_champ nature, const Noms& nom, const Noms& unite, int nb_comp, int nb_pas_dt, double temps, OWN_PTR(Champ_Inc_base)& champ,
                         const Nom& sous_type = NOM_VIDE) const override;
  void discretiser_champ(const Motcle& directive, const Domaine_dis_base& z, Nature_du_champ nature, const Noms& nom, const Noms& unite, int nb_comp, double temps, OWN_PTR(Champ_Fonc_base)& champ) const override;
  void discretiser_champ(const Motcle& directive, const Domaine_dis_base& z, Nature_du_champ nature, const Noms& nom, const Noms& unite, int nb_comp, double temps, OWN_PTR(Champ_Don_base)& champ) const override;
  void distance_paroi(const Schema_Temps_base&, Domaine_dis_base&, OWN_PTR(Champ_Fonc_base)&) const;
  void distance_paroi_globale(const Schema_Temps_base&, Domaine_dis_base&, OWN_PTR(Champ_Fonc_base)&) const override; // Wall distance defined over the entire domain
  void proprietes_physiques_fluide_Ostwald(const Domaine_dis_base&, Fluide_Ostwald&, const Navier_Stokes_std&, const Champ_Inc_base&) const override;
  Nom domaine_cl_dis_type() const override { return "Domaine_Cl_VEF"; }
 
  void vorticite(Domaine_dis_base&, const Champ_Inc_base&, OWN_PTR(Champ_Fonc_base)&) const;
  void creer_champ_vorticite(const Schema_Temps_base& ,const Champ_Inc_base&, OWN_PTR(Champ_Fonc_base)& ) const override;
  void critere_Q(const Domaine_dis_base& z,const Domaine_Cl_dis_base&,const Champ_Inc_base& vitesse, OWN_PTR(Champ_Fonc_base)& ch) const override;
  void y_plus(const Domaine_dis_base& z,const Domaine_Cl_dis_base&,const Champ_Inc_base& vitesse, OWN_PTR(Champ_Fonc_base)& ch) const override;
  void grad_T(const Domaine_dis_base& z,const Domaine_Cl_dis_base&,const Champ_Inc_base& temperature, OWN_PTR(Champ_Fonc_base)& ch) const override;
  void grad_u(const Domaine_dis_base& z,const Domaine_Cl_dis_base&,const Champ_Inc_base& temperature, OWN_PTR(Champ_Fonc_base)& ch) const override;
  void h_conv(const Domaine_dis_base& z,const Domaine_Cl_dis_base&,const Champ_Inc_base& temperature, OWN_PTR(Champ_Fonc_base)& ch, Motcle& nom, int temp_ref) const override;
  void taux_cisaillement(const Domaine_dis_base&, const Domaine_Cl_dis_base&,const Champ_Inc_base&, OWN_PTR(Champ_Fonc_base)&) const override;
  void residu(const Domaine_dis_base& , const Champ_Inc_base&, OWN_PTR(Champ_Fonc_base)& ) const override;
  void t_paroi(const Domaine_dis_base& z,const Domaine_Cl_dis_base& zcl, const Champ_Inc_base& , OWN_PTR(Champ_Fonc_base)& ch) const override;
  bool is_vef() const override { return true; }
 
  inline int get_P1Bulle() const { return P1Bulle_; }
  inline int get_alphaE() const  { return alphaE_;  }
  inline int get_alphaS() const  { return alphaS_;  }
  inline int get_alphaA() const  { return alphaA_;  }
  inline int get_alphaRT() const { return alphaRT_;  }
  inline int get_modif_div_face_dirichlet() const  { return modif_div_face_dirichlet_;  }
  inline int get_cl_pression_sommet_faible() const { return cl_pression_sommet_faible_; }
 
private:
  bool alphaE_ = true;
  bool alphaS_ = true;
  bool alphaA_ = false;
  bool alphaRT_ = false;
  int P1Bulle_ = 1;
  int modif_div_face_dirichlet_ = 0;
  int cl_pression_sommet_faible_ = 0; ///< determines whether pressure boundary conditions are imposed weakly or strongly -> see divergence and assembler, zcl
 
  void discretiser_champ_(const Motcle& directive, const Domaine_dis_base& z, Nature_du_champ nature, const Noms& nom, const Noms& unite, int nb_comp, int nb_pas_dt, double temps, OWN_PTR(Champ_Inc_base)& champ,
                          const Nom& sous_type = NOM_VIDE) const;
 
  void discretiser_champ_fonc_don(const Motcle& directive, const Domaine_dis_base& z, Nature_du_champ nature, const Noms& nom, const Noms& unite, int nb_comp, double temps, Objet_U& champ) const;
 
  void discretiser_champ_fonc_don_(const Motcle& directive, const Domaine_dis_base& z, Nature_du_champ nature, const Noms& nom, const Noms& unite, int nb_comp, double temps, Objet_U& champ) const;
 
  void modifier_champ_tabule(const Domaine_dis_base& domaine_dis,Champ_Fonc_Tabule& ch_tab,const VECT(OBS_PTR(Champ_base))& ch_inc) const override;
 
  Domaine_dis_base& discretiser() const override;
};
 
#endif /* VEF_discretisation_included */