1/*============================================================================ 2 * Code_Saturne documentation page 3 *============================================================================*/ 4 5/* 6 This file is part of Code_Saturne, a general-purpose CFD tool. 7 8 Copyright (C) 1998-2021 EDF S.A. 9 10 This program is free software; you can redistribute it and/or modify it under 11 the terms of the GNU General Public License as published by the Free Software 12 Foundation; either version 2 of the License, or (at your option) any later 13 version. 14 15 This program is distributed in the hope that it will be useful, but WITHOUT 16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 17 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 18 details. 19 20 You should have received a copy of the GNU General Public License along with 21 this program; if not, write to the Free Software Foundation, Inc., 51 Franklin 22 Street, Fifth Floor, Boston, MA 02110-1301, USA. 23*/ 24 25/*-----------------------------------------------------------------------------*/ 26 27/*! 28 \page les_inflow Generation of synthetic turbulence at LES inlets 29 30 \section cs_user_les_infow_intro Introduction 31 32 Generation of synthetic turbulence at LES inlets can be defined using 33 the \ref cs_user_les_inflow_define user function, and possibly 34 updated using \ref cs_user_les_inflow_update, with 35 \ref cs_user_les_inflow_advanced allowing for finer definition of 36 target statistics the inlet if needed. 37 38 \section cs_user_les_inflow_init Global caracteristics of synthetic turbulence inlets 39 40 \subsection user_les_inflow_general General settings 41 42 The \ref cs_user_les_inflow_define function is the main entry point 43 for LES inflow definitions. 44 45 It can be used to set general options, such as the specific 46 checkpoint/restart behavior, as in the following example: 47 48 \snippet cs_user_les_inflow-base.c set_restart 49 50 \subsection user_les_inflow_define_inlets Defining inlet properties 51 52 For each LES inlet, the \ref cs_les_inflow_add_inlet 53 must be used. 54 55 For example, to use the Batten Method for boundary faces of 56 a zone named INLET_1: 57 58 \snippet cs_user_les_inflow-base.c init_1 59 60 And to use the Synthetic Eddy Method for boundary faces of 61 a zone named INLET_2: 62 63 \section cs_user_les_inflow_modify Modifying synthetic turbulence inlets 64 65 \subsection user_les_inflow_update Updating base characteristics 66 67 To update reference velocity, turbulent kinetic energy, or dissipation 68 rate for a given turbulence inlet, 69 the \ref cs_user_les_inflow_update function may be used. 70 It is called automatically for each LES inlet defined previously. 71 72 The following example illustrates modifying values for the example 73 zone named INLET_1: 74 75 \snippet cs_user_les_inflow-base.c update_1 76 77 \subsection cs_user_les_inflow_example_1 Advanced LES inlet Example 1 78 79 Mean velocity, Reynolds stresses an dissipation are deduced from a wall law 80 for the zone named INLET_1 (no modification of 81 the statistics of the flow is provided for the other synthetic 82 turbulence inlets). 83 84 \snippet cs_user_les_inflow-base.c example_1 85 86 \subsection cs_user_les_inflow_example_2 Advanced LES Example 2 87 88 Reynolds stresses and dissipation at the inlet are computed 89 using the turbulence intensity and standard laws for 90 a circular pipe for for the zone named INLET_1 (no modification of 91 the statistics of the flow is provided for the other synthetic 92 turbulence inlets). 93 94 \snippet cs_user_les_inflow-base.c example_2 95 96*/ 97