9.2
general documentation
cs_ctwr_source_terms.h
Go to the documentation of this file.
1#ifndef CS_CTWR_SOURCE_TERMS_H
2#define CS_CTWR_SOURCE_TERMS_H
3
4/*============================================================================
5 * Cooling towers related functions
6 *============================================================================*/
7
8/*
9 This file is part of code_saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2026 EDF S.A.
12
13 This program is free software; you can redistribute it and/or modify it under
14 the terms of the GNU General Public License as published by the Free Software
15 Foundation; either version 2 of the License, or (at your option) any later
16 version.
17
18 This program is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21 details.
22
23 You should have received a copy of the GNU General Public License along with
24 this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
25 Street, Fifth Floor, Boston, MA 02110-1301, USA.
26*/
27
28/*----------------------------------------------------------------------------*/
29
30/*----------------------------------------------------------------------------
31 * Local headers
32 *----------------------------------------------------------------------------*/
33
34#include "base/cs_defs.h"
35
36/*----------------------------------------------------------------------------*/
37/*
38 * \brief Phase change source terms - Exchange terms between the injected
39 * liquid and the water vapor phase in the bulk, humid air
40 *
41 * \param[in] f_id field id
42 * \param[in,out] exp_st Explicit source term
43 * \param[in,out] imp_st Implicit source term
44 */
45/*----------------------------------------------------------------------------*/
46
47void
48cs_ctwr_source_term(int f_id,
49 cs_real_t exp_st[],
50 cs_real_t imp_st[]);
51
52/*----------------------------------------------------------------------------*/
53/*
54 * \brief cs_dof_func_t function to compute volume mass injection for
55 * pressure (mass) equation resulting from water evaporatin in the
56 * packing zones.
57 *
58 * \param[in] n_elts number of elements to consider
59 * \param[in] elt_ids list of elements ids
60 * \param[in] dense_output perform an indirection in retval or not
61 * \param[in] input null or pointer to a structure cast on-the-fly
62 * \param[in, out] retval resulting value(s). Must be allocated.
63 */
64/*----------------------------------------------------------------------------*/
65
66void
68 const cs_lnum_t *elt_ids,
69 bool dense_output,
70 void *input,
71 cs_real_t *retval);
72
73/*----------------------------------------------------------------------------*/
74/*
75 * \brief cs_dof_func_t function to compute volume mass injection for
76 * pressure (mass) equation resulting from evaporation of the rain.
77 *
78 * \param[in] n_elts number of elements to consider
79 * \param[in] elt_ids list of elements ids
80 * \param[in] dense_output perform an indirection in retval or not
81 * \param[in] input null or pointer to a structure cast on-the-fly
82 * \param[in, out] retval resulting value(s). Must be allocated.
83 */
84/*----------------------------------------------------------------------------*/
85
86void
88 const cs_lnum_t *elt_ids,
89 bool dense_output,
90 void *input,
91 cs_real_t *retval);
92
93/*----------------------------------------------------------------------------*/
94/*
95 * \brief cs_dof_func_t function to compute volume mass injection for
96 * pressure (mass) equation for the rain.
97 *
98 * \param[in] n_elts number of elements to consider
99 * \param[in] elt_ids list of elements ids
100 * \param[in] dense_output perform an indirection in retval or not
101 * \param[in] input null or pointer to a structure cast on-the-fly
102 * \param[in, out] retval resulting value(s). Must be allocated.
103 */
104/*----------------------------------------------------------------------------*/
105
106void
108 const cs_lnum_t *elt_ids,
109 bool dense_output,
110 void *input,
111 cs_real_t *retval);
112
113/*----------------------------------------------------------------------------*/
114/*
115 * \brief cs_dof_func_t function to compute volume mass injection for
116 * yphp rain equation (enthalpy).
117 *
118 * \param[in] n_elts number of elements to consider
119 * \param[in] elt_ids list of elements ids
120 * \param[in] dense_output perform an indirection in retval or not
121 * \param[in] input null or pointer to a structure cast on-the-fly
122 * \param[in, out] retval resulting value(s). Must be allocated.
123 */
124/*----------------------------------------------------------------------------*/
125
126void
128 const cs_lnum_t *elt_ids,
129 bool dense_output,
130 void *input,
131 cs_real_t *retval);
132
133/*----------------------------------------------------------------------------*/
134
135#endif /* CS_CTWR_SOURCE_TERMS_H */
void cs_ctwr_volume_mass_injection_evap_rain_dof_func(cs_lnum_t n_elts, const cs_lnum_t *elt_ids, bool dense_output, void *input, cs_real_t *retval)
cs_dof_func_t function to compute volume mass injection for pressure (mass) equation resulting from w...
Definition: cs_ctwr_source_terms.cpp:484
void cs_ctwr_volume_mass_injection_yh_rain_dof_func(cs_lnum_t n_elts, const cs_lnum_t *elt_ids, bool dense_output, void *input, cs_real_t *retval)
cs_dof_func_t function to compute volume mass injection for yphp rain equation (enthalpy) if mixture ...
Definition: cs_ctwr_source_terms.cpp:721
void cs_ctwr_source_term(int f_id, cs_real_t exp_st[], cs_real_t imp_st[])
Phase change source terms - Exchange terms between the injected liquid and the water vapor phase in t...
Definition: cs_ctwr_source_terms.cpp:816
void cs_ctwr_volume_mass_injection_packing_dof_func(cs_lnum_t n_elts, const cs_lnum_t *elt_ids, bool dense_output, void *input, cs_real_t *retval)
cs_dof_func_t function to compute volume mass injection for pressure (mass) equation resulting from w...
Definition: cs_ctwr_source_terms.cpp:332
void cs_ctwr_volume_mass_injection_rain_dof_func(cs_lnum_t n_elts, const cs_lnum_t *elt_ids, bool dense_output, void *input, cs_real_t *retval)
cs_dof_func_t function to compute volume mass injection for pressure (mass) equation for the leaking ...
Definition: cs_ctwr_source_terms.cpp:616
double cs_real_t
Floating-point value.
Definition: cs_defs.h:332
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:325