Transport_K_ou_Eps_base.h

/****************************************************************************
* Copyright (c) 2015 - 2016, 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_ou_Eps_base_included
#define Transport_K_ou_Eps_base_included
 
#include <Transport_2eq_base.h>
#include <Modele_turbulence_hyd_RANS_Bicephale_base.h>
#include <TRUST_Ref.h>
 
 
class Milieu_base;
class Champ_Inc_base;
 
/*! @brief Classe de base pour l'equation de transport des modeles k_Epsilon
 *  dans une approche ou K et Epsilon sont traites par deux equations differentes.
 *
 * Defaults to an equation on k (transporte_K_=false).
 * Must call set_K_equation() from the outside to change the class to an equation on epsilon.
 */
class Transport_K_ou_Eps_base: public Transport_2eq_base
{
 
  Declare_base(Transport_K_ou_Eps_base);
 
public:
 
  void discretiser() override;
  void set_param(Param& param) const override;
  virtual int controler_variable();
  void valider_iteration() override;
  inline const Champ_Inc_base& inconnue() const override;
  inline Champ_Inc_base& inconnue() override;
 
  const Champ_base& get_champ( const Motcle& nom ) const override;
  bool has_champ(const Motcle& nom, OBS_PTR(Champ_base) &ref_champ) const override;
  bool has_champ(const Motcle& nom) const override;
 
  bool transporte_t_il_K() const { return transporte_K_; };
  void set_K_equation() { transporte_K_=true; }
 
protected:
 
  OWN_PTR(Champ_Inc_base) le_champ_;
  OWN_PTR(Champ_Fonc_base)  residu_;
 
  bool transporte_K_=false;
};
/*! @brief Renvoie le champ inconnue de l'equation.
 *
 * Un champ vecteur contenant K ou epsilon.
 *
 * @return (Champ_Inc_base&) le champ inconnue de l'equation
 */
inline Champ_Inc_base& Transport_K_ou_Eps_base::inconnue()
{
  return le_champ_;
}
 
 
/*! @brief Renvoie le champ inconnue de l'equation.
 *
 * Un champ vecteur contenant K ou epsilon.
 *     (version const)
 *
 * @return (Champ_Inc_base&) le champ inconnue de l'equation
 */
inline const Champ_Inc_base& Transport_K_ou_Eps_base::inconnue() const
{
  return le_champ_;
}
 
 
#endif