Transport_K_Omega_base.h

/****************************************************************************
* Copyright (c) 2023, 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 Transport_K_Omega_base_included
#define Transport_K_Omega_base_included
 
#include <Modele_turbulence_hyd_RANS_K_Omega_base.h>
#include <Transport_2eq_base.h>
#include <TRUST_Ref.h>
 
 
class Champ_Inc_base;
class Milieu_base;
 
/*! @brief Classe Transport_K_Omega_base Classe de base pour les equations
 *
 *     de transport des modeles k_Omega.
 *
 */
class Transport_K_Omega_base: public Transport_2eq_base
{
  Declare_base(Transport_K_Omega_base);
 
public:
 
  void discretiser() override;
  void mettre_a_jour(double temps) override;
  int controler_K_Omega();
  void valider_iteration() override;
  inline const Champ_Inc_base& inconnue() const override;
  inline Champ_Inc_base& inconnue() override;
 
  void raise_control_k_omega_flag() const { flag_control_k_omega_required_ = true; }
  void lower_control_k_omega_flag() const { flag_control_k_omega_required_ = false; }
 
protected:
 
  virtual void set_param(Param& ) const override;
 
  void report_on_corrected_values();
 
  OWN_PTR(Champ_Inc_base) le_champ_K_Omega;
 
private:
  bool exit_on_negative_k_omega_ = false;
  bool exit_on_big_omega_ = false;
  bool disable_report_on_corrected_values_ = false;
  mutable bool flag_control_k_omega_required_ = true; // EB: mutable to allow to raise the flag in const methods rather than use ref_cast_non_const.
};
 
/*! @brief Renvoie le champ inconnue de l'equation.
 *
 * Un champ vecteur contenant K et omega.
 *
 * @return (Champ_Inc_base&) le champ inconnue de l'equation
 */
inline Champ_Inc_base& Transport_K_Omega_base::inconnue() { return le_champ_K_Omega; }
 
 
/*! @brief Renvoie le champ inconnue de l'equation.
 *
 * Un champ vecteur contenant K et omega.
 *     (version const)
 *
 * @return (Champ_Inc_base&) le champ inconnue de l'equation
 */
inline const Champ_Inc_base& Transport_K_Omega_base::inconnue() const { return le_champ_K_Omega; }
 
#endif