TrioCFD 1.9.9_beta
TrioCFD documentation
Loading...
Searching...
No Matches
Pb_Hydraulique_Concentration_Turbulent.cpp
1/****************************************************************************
2* Copyright (c) 2023, CEA
3* All rights reserved.
4*
5* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
6* 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
7* 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.
8* 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.
9*
10* 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.
11* 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;
12* 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.
13*
14*****************************************************************************/
15
16#include <Pb_Hydraulique_Concentration_Turbulent.h>
17#include <Fluide_Incompressible.h>
18#include <Constituant.h>
19
20Implemente_instanciable(Pb_Hydraulique_Concentration_Turbulent, "Pb_Hydraulique_Concentration_Turbulent", Pb_Fluide_base);
21// XD pb_hydraulique_concentration_turbulent Pb_base pb_hydraulique_concentration_turbulent INHERITS_BRACE Resolution of
22// XD_CONT Navier-Stokes/multiple constituent transport equations, with turbulence modelling.
23// XD attr fluide_incompressible fluide_incompressible fluide_incompressible REQ The fluid medium associated with the
24// XD_CONT problem.
25// XD attr constituant constituant constituant OPT Constituents.
26// XD attr navier_stokes_turbulent navier_stokes_turbulent navier_stokes_turbulent OPT Navier-Stokes equations as well
27// XD_CONT as the associated turbulence model equations.
28// XD attr convection_diffusion_concentration_turbulent convection_diffusion_concentration_turbulent convection_diffusion_concentration_turbulent OPT Constituent transport equations (concentration diffusion convection) as well as the associated turbulence model equations.
29
31
33
34/*! @brief Returns the number of equations.
35 *
36 * Returns 2 because there are 2 equations in a turbulent hydraulic
37 * problem with transport:
38 * - the turbulent Navier-Stokes equation
39 * - a convection-diffusion equation (possibly vectorial) with turbulence
40 *
41 * @return Number of equations (2).
42 */
47
49{
50 if (!(i == 0 || i == 1))
51 {
52 Cerr << "\nError in Pb_Hydraulique_Concentration_Turbulent::equation() : Wrong number of equation !" << finl;
54 }
55 if (i == 0)
56 return eq_hydraulique;
57 else
58 return eq_concentration;
59}
60
61/*! @brief Returns the hydraulic equation of type Navier_Stokes_Turbulent if i=0, returns the convection-diffusion equation of type
62 *
63 * Convection_Diffusion_Concentration_Turbulent if i=1
64 * (the convection-diffusion equation may be vectorial).
65 *
66 * @param i Index of the equation to return.
67 * @return The equation corresponding to the given index.
68 */
70{
71 if (!(i == 0 || i == 1))
72 {
73 Cerr << "\nError in Pb_Hydraulique_Concentration_Turbulent::equation() : Wrong number of equation !" << finl;
75 }
76 if (i == 0)
77 return eq_hydraulique;
78 else
79 return eq_concentration;
80}
81
82/*! @brief Associates a medium to the problem.
83 *
84 * Depending on the medium type:
85 * - Fluide_Incompressible: associated to the hydraulic equation
86 * - Constituant: associated to the convection-diffusion equation
87 * Any other medium type causes an error.
88 *
89 * @param mil Physical medium to associate with the problem.
90 * @throws If the medium is not of the correct physical type.
91 */
93{
94 if (sub_type(Fluide_Incompressible, mil))
95 eq_hydraulique.associer_milieu_base(mil);
96 else if (sub_type(Constituant, mil))
97 eq_concentration.associer_milieu_base(mil);
98 else
99 {
100 Cerr << "A medium of type " << mil.que_suis_je() << " cannot be associated with " << finl;
101 Cerr << "a problem of type Pb_Hydraulique_Concentration_Turbulent " << finl;
102 exit();
103 }
104}
Represents the constituent(s) of a fluid.
Definition Constituant.h:30
Class defining operators and methods for all reading operation in an input flow (file,...
Definition Entree.h:42
class Equation_base The role of an equation is the calculation of one or more fields....
Represents an incompressible fluid and its properties:
Milieu_base This class is the base of the (physical) medium hierarchy.
Definition Milieu_base.h:50
const Nom & que_suis_je() const
Returns the string identifying the class.
Definition Objet_U.cpp:104
virtual Entree & readOn(Entree &)
Reads an Objet_U from an input stream. Virtual method to override.
Definition Objet_U.cpp:289
virtual Sortie & printOn(Sortie &) const
Writes the object to an output stream. Virtual method to override.
Definition Objet_U.cpp:278
Pb_Fluide_base This class provides a base class for.
Turbulent hydraulics problem with species transport (one or more concentrations).
void associer_milieu_base(const Milieu_base &) override
Associates a medium to the problem.
int nombre_d_equations() const override
Returns the number of equations.
Convection_Diffusion_Concentration_Turbulent eq_concentration
static void exit(int exit_code=-1)
Exit routine for TRUST within a Kokkos region.
Definition Process.cpp:466
Base class for output streams.
Definition Sortie.h:52