Dissipation_type_helpers.h

/****************************************************************************
* Copyright (c) 2024, 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 Dissipation_type_helpers_included
#define Dissipation_type_helpers_included
 
#include <Echelle_temporelle_turbulente.h>
#include <Taux_dissipation_turbulent.h>
#include <Probleme_base.h>
#include <string>
 
/*! @brief Returns "tau" or "omega" depending on whether eq is an
 *         Echelle_temporelle_turbulente or Taux_dissipation_turbulent.
 *         Exits if the equation is neither.
 *
 *  Use this when the source lives in the tau/omega equation itself.
 */
inline std::string get_dissipation_type(const Equation_base& eq)
{
  if (sub_type(Echelle_temporelle_turbulente, eq))
    return "tau";
  else if (sub_type(Taux_dissipation_turbulent, eq))
    return "omega";
  Process::exit("get_dissipation_type: equation is neither tau nor omega.");
  return "";
}
 
/*! @brief Searches all equations in the problem for a tau or omega equation.
 *         Returns "tau" or "omega" accordingly. Exits if none is found.
 *
 *  Use this when the source lives in the k equation and needs to discover
 *  what type of dissipation equation the problem contains.
 */
inline std::string find_dissipation_type(const Probleme_base& pb)
{
  for (int i = 0; i < pb.nombre_d_equations(); i++)
    {
      if (sub_type(Echelle_temporelle_turbulente, pb.equation(i)))
        return "tau";
      else if (sub_type(Taux_dissipation_turbulent, pb.equation(i)))
        return "omega";
    }
  Process::exit("find_dissipation_type: neither tau nor omega equation found.");
  return "";
}
 
#endif /* Dissipation_type_helpers_included */