8.3
general documentation
cs_volume_mass_injection.h
Go to the documentation of this file.
1#ifndef __CS_VOLUME_MASS_INJECTION_H__
2#define __CS_VOLUME_MASS_INJECTION_H__
3
4/*============================================================================
5 * Mass source terms computation.
6 *============================================================================*/
7
8/*
9 This file is part of code_saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2024 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 * Local headers
30 *----------------------------------------------------------------------------*/
31
32#include "cs_base.h"
33
34/*----------------------------------------------------------------------------*/
35
36BEGIN_C_DECLS
37
38/*============================================================================
39 * Type definitions
40 *============================================================================*/
41
42/*=============================================================================
43 * Public function prototypes
44 *============================================================================*/
45
46/*----------------------------------------------------------------------------*/
56/*----------------------------------------------------------------------------*/
57
58void
59cs_volume_mass_injection_flag_zones(void);
60
61/*----------------------------------------------------------------------------*/
65/*----------------------------------------------------------------------------*/
66
67void
68cs_volume_mass_injection_build_lists(void);
69
70/*----------------------------------------------------------------------------*/
75/*----------------------------------------------------------------------------*/
76
77void
78cs_volume_mass_injection_eval(void);
79
80/*----------------------------------------------------------------------------*/
92/*----------------------------------------------------------------------------*/
93
94void
95cs_volume_mass_injection_get_arrays(const cs_field_t *f,
96 cs_lnum_t *ncesmp,
97 const cs_lnum_t **icetsm,
98 int **itpsmp,
99 cs_real_t **smcelp,
100 cs_real_t **gamma);
101
102/*----------------------------------------------------------------------------*/
103
104END_C_DECLS
105
106#endif /* __CS_VOLUME_MASS_INJECTION_H__ */
cs_base.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:335
gamma
@ gamma
Definition: cs_field_pointer.h:224
cs_volume_mass_injection_eval
void cs_volume_mass_injection_eval(void)
Evaluate contributions to volume mass injection.
Definition: cs_volume_mass_injection.cpp:601
cs_volume_mass_injection_get_arrays
void cs_volume_mass_injection_get_arrays(const cs_field_t *f, cs_lnum_t *ncesmp, const cs_lnum_t **icetsm, int **itpsmp, cs_real_t **smcelp, cs_real_t **gamma)
Return pointers to the mass source term arrays.
Definition: cs_volume_mass_injection.cpp:714
cs_volume_mass_injection_flag_zones
void cs_volume_mass_injection_flag_zones(void)
Flag volume zones with the appropriate CS_VOLUME_ZONE_MASS_SOURCE_TERM flag when at least one volume ...
Definition: cs_volume_mass_injection.cpp:509
cs_volume_mass_injection_build_lists
void cs_volume_mass_injection_build_lists(void)
Build the list and zone ids of cells with volume mass injection.
Definition: cs_volume_mass_injection.cpp:546
cs_field_t
Field descriptor.
Definition: cs_field.h:131