6.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-2020 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 
37 
38 /*============================================================================
39  * Type definitions
40  *============================================================================*/
41 
42 /*----------------------------------------------------------------------------*/
59 typedef void
60 (cs_volume_mass_injection_eval_t) (void *input,
61  const cs_zone_t *z,
62  cs_field_t *f,
63  cs_real_t *val);
64 
71 typedef struct {
72 
77  void *input;
78 
83 
85 
86 /*=============================================================================
87  * Public function prototypes
88  *============================================================================*/
89 
90 /*----------------------------------------------------------------------------*/
100 /*----------------------------------------------------------------------------*/
101 
102 void
104 
105 /*----------------------------------------------------------------------------*/
113 /*----------------------------------------------------------------------------*/
114 
115 void
117  cs_lnum_t cell_num[],
118  int cell_zone_id[]);
119 
120 /*----------------------------------------------------------------------------*/
133 /*----------------------------------------------------------------------------*/
134 
135 void
137  cs_lnum_t ncesmp,
138  int itypsm[],
139  cs_real_t smacel[]);
140 
141 /*----------------------------------------------------------------------------*/
142 
144 
145 #endif /* __CS_VOLUME_MASS_INJECTION_H__ */
cs_volume_mass_injection_by_function_context_t
Context structure associated to a mass injection inside a volume relying on a function.
Definition: cs_volume_mass_injection.h:71
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.c:363
cs_zone_t
Definition: cs_zone.h:55
dimens::nvar
integer, save nvar
number of solved variables (must be lower than nvarmx)
Definition: dimens.f90:42
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:493
cs_volume_mass_injection_eval_t
void() cs_volume_mass_injection_eval_t(void *input, const cs_zone_t *z, cs_field_t *f, cs_real_t *val)
Function pointer to update cell values in a given zone for volume mass injection.
Definition: cs_volume_mass_injection.h:60
cs_volume_mass_injection_by_function_context_t::input
void * input
Definition: cs_volume_mass_injection.h:77
cs_volume_mass_injection_by_function_context_t::func
cs_volume_mass_injection_eval_t * func
Definition: cs_volume_mass_injection.h:82
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:304
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:492
cs_volume_mass_injection_eval
void cs_volume_mass_injection_eval(int nvar, cs_lnum_t ncesmp, int itypsm[], cs_real_t smacel[])
Evaluate contributions to volume mass injection.
Definition: cs_volume_mass_injection.c:450
pointe::smacel
double precision, dimension(:,:), allocatable smacel
value of the mass source term for pressure. For the other variables, eventual imposed injection value...
Definition: pointe.f90:200
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:298
pointe::itypsm
integer, dimension(:,:), allocatable itypsm
type of mass source term for each variable
Definition: pointe.f90:194
cs_field_t
Field descriptor.
Definition: cs_field.h:125
cs_volume_mass_injection_build_lists
void cs_volume_mass_injection_build_lists(cs_lnum_t n_cells, cs_lnum_t cell_num[], int cell_zone_id[])
Build the list and zone ids of cells with volume mass injection.
Definition: cs_volume_mass_injection.c:406
cs_base.h