8.0
general documentation
cs_pressure_correction.h
Go to the documentation of this file.
1 #ifndef __CS_PRESSURE_CORRECTION_H__
2 #define __CS_PRESSURE_CORRECTION_H__
3 
4 /*============================================================================
5  * Pressure correction.
6  *============================================================================*/
7 
8 /*
9  This file is part of code_saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2023 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 "cs_defs.h"
35 
36 /*----------------------------------------------------------------------------*/
37 
38 BEGIN_C_DECLS
39 
40 /*============================================================================
41  * Type definitions
42  *============================================================================*/
43 
44 typedef struct {
45 
49  cs_equation_t *pressure_incr;
50 
55  cs_field_t *pressure_incr_gradient;
56 
60  cs_field_t *pressure_gradient;
61 
66  cs_real_t *div_st;
67 
71  cs_real_t *inner_potential_flux;
72 
76  cs_real_t *bdy_potential_flux;
77 
82  cs_real_t *bdy_pressure_incr;
83 
84  cs_flag_t post_flag;
85 
86 } cs_pressure_correction_cdo_t;
87 
88 /*============================================================================
89  * Public function definitions
90  *============================================================================*/
91 
92 /*----------------------------------------------------------------------------*/
96 /*----------------------------------------------------------------------------*/
97 
98 void
99 cs_pressure_correction_fv_activate(void);
100 
101 /*----------------------------------------------------------------------------*/
105 /*----------------------------------------------------------------------------*/
106 
107 void
108 cs_pressure_correction_cdo_destroy_all(void);
109 
110 
111 /*----------------------------------------------------------------------------*/
115 /*----------------------------------------------------------------------------*/
116 
117 void
118 cs_pressure_correction_cdo_activate(void);
119 
120 /*----------------------------------------------------------------------------*/
124 /*----------------------------------------------------------------------------*/
125 
126 void
127 cs_pressure_correction_model_activate(void);
128 
129 /*----------------------------------------------------------------------------*/
135 /*----------------------------------------------------------------------------*/
136 
137 bool
138 cs_pressure_correction_cdo_is_activated(void);
139 
140 /*----------------------------------------------------------------------------*/
146 /*----------------------------------------------------------------------------*/
147 
148 void
149 cs_pressure_correction_cdo_init_setup(void);
150 
151 /*----------------------------------------------------------------------------*/
158 /*----------------------------------------------------------------------------*/
159 
160 void
161 cs_pressure_correction_cdo_finalize_setup(const cs_domain_t *domain);
162 
163 /*----------------------------------------------------------------------------*/
206 /*----------------------------------------------------------------------------*/
207 
208 void
209 cs_pressure_correction(int iterns,
210  cs_lnum_t nfbpcd,
211  cs_lnum_t ncmast,
212  cs_lnum_t ifbpcd[nfbpcd],
213  cs_lnum_t ltmast[],
214  int isostd[],
215  cs_real_t vel[restrict][3],
216  cs_real_t da_uu[restrict][6],
217  cs_real_t coefav[restrict][3],
218  cs_real_t coefbv[restrict][3][3],
219  cs_real_t coefa_dp[restrict],
220  cs_real_t coefb_dp[restrict],
221  cs_real_t spcond[restrict],
222  cs_real_t svcond[restrict],
223  cs_real_t frcxt[restrict][3],
224  cs_real_t dfrcxt[restrict][3],
225  cs_real_t i_visc[restrict],
226  cs_real_t b_visc[restrict]);
227 
228 /*----------------------------------------------------------------------------*/
229 
230 END_C_DECLS
231 
232 #endif /* __CS_PRESSURE_CORRECTION_H__ */
cs_defs.h
restrict
#define restrict
Definition: cs_defs.h:139
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:509
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:319
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:510
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:313
cs_flag_t
unsigned short int cs_flag_t
Definition: cs_defs.h:321
vel
@ vel
Definition: cs_field_pointer.h:68
cs_pressure_correction_cdo_activate
void cs_pressure_correction_cdo_activate(void)
Activate the pressure increment solving with CDO.
Definition: cs_pressure_correction.c:2952
cs_pressure_correction_cdo_destroy_all
void cs_pressure_correction_cdo_destroy_all(void)
Free the main structure related to the pressure correction.
Definition: cs_pressure_correction.c:3186
cs_pressure_correction_cdo_is_activated
bool cs_pressure_correction_cdo_is_activated(void)
Test if pressure solving with CDO is activated.
Definition: cs_pressure_correction.c:3027
cs_pressure_correction
void cs_pressure_correction(int iterns, cs_lnum_t nfbpcd, cs_lnum_t ncmast, cs_lnum_t ifbpcd[nfbpcd], cs_lnum_t ltmast[], int isostd[], cs_real_t vel[restrict][3], cs_real_t da_uu[restrict][6], cs_real_t coefav[restrict][3], cs_real_t coefbv[restrict][3][3], cs_real_t coefa_dp[restrict], cs_real_t coefb_dp[restrict], cs_real_t spcond[restrict], cs_real_t svcond[restrict], cs_real_t frcxt[restrict][3], cs_real_t dfrcxt[restrict][3], cs_real_t i_visc[restrict], cs_real_t b_visc[restrict])
Perform the pressure correction step of the Navier-Stokes equations for incompressible or slightly co...
Definition: cs_pressure_correction.c:3261
cs_pressure_correction_fv_activate
void cs_pressure_correction_fv_activate(void)
Activate the pressure increment solving with Legacy FV.
Definition: cs_pressure_correction.c:2926
cs_pressure_correction_cdo_init_setup
void cs_pressure_correction_cdo_init_setup(void)
Start setting-up the pressure increment equation At this stage, numerical settings should be complete...
Definition: cs_pressure_correction.c:3044
cs_pressure_correction_cdo_finalize_setup
void cs_pressure_correction_cdo_finalize_setup(const cs_domain_t *domain)
Finalize setting-up the pressure increment equation At this stage, numerical settings should be compl...
Definition: cs_pressure_correction.c:3113
cs_pressure_correction_model_activate
void cs_pressure_correction_model_activate(void)
Activate the pressure increment, either FV or CDO.
Definition: cs_pressure_correction.c:3007
pointe::ncmast
integer, save ncmast
number of the ncmast cells in which a condensation source terms is imposed. See lstmast list and the ...
Definition: pointe.f90:218
pointe::ltmast
integer, dimension(:), allocatable ltmast
list on the ncmast cells in which a condensation source terms is imposed. See the user subroutine cs_...
Definition: pointe.f90:222
pointe::svcond
double precision, dimension(:,:), allocatable svcond
value of the condensation source terms for pressure associated to the metal structures modelling....
Definition: pointe.f90:238
cs_nz_condensation::nfbpcd
integer(c_int), pointer, save nfbpcd
number of faces in which a condensation source terms is imposed. See ifbpcd and the user subroutine c...
Definition: cs_nz_condensation.f90:55
cs_nz_condensation::spcond
double precision, dimension(:,:), pointer, save spcond
value of the condensation source terms for pressure. For the other variables, eventual imposed specif...
Definition: cs_nz_condensation.f90:83
cs_nz_condensation::ifbpcd
integer, dimension(:), pointer, save ifbpcd
list on the nfbpcd faces in which a condensation source terms is imposed. See ifbpcd and the user sub...
Definition: cs_nz_condensation.f90:95
cs_domain_t
Structure storing the main features of the computational domain and pointers to the main geometrical ...
Definition: cs_domain.h:138
cs_equation_t
Main structure to handle the discretization and the resolution of an equation.
cs_field_t
Field descriptor.
Definition: cs_field.h:130
cs_pressure_correction_cdo_t
Definition: cs_pressure_correction.h:44
cs_pressure_correction_cdo_t::post_flag
cs_flag_t post_flag
Definition: cs_pressure_correction.h:84
cs_pressure_correction_cdo_t::pressure_incr
cs_equation_t * pressure_incr
Definition: cs_pressure_correction.h:49
cs_pressure_correction_cdo_t::pressure_incr_gradient
cs_field_t * pressure_incr_gradient
Definition: cs_pressure_correction.h:55
cs_pressure_correction_cdo_t::bdy_pressure_incr
cs_real_t * bdy_pressure_incr
Definition: cs_pressure_correction.h:82
cs_pressure_correction_cdo_t::pressure_gradient
cs_field_t * pressure_gradient
Definition: cs_pressure_correction.h:60
cs_pressure_correction_cdo_t::div_st
cs_real_t * div_st
Definition: cs_pressure_correction.h:66
cs_pressure_correction_cdo_t::inner_potential_flux
cs_real_t * inner_potential_flux
Definition: cs_pressure_correction.h:71
cs_pressure_correction_cdo_t::bdy_potential_flux
cs_real_t * bdy_potential_flux
Definition: cs_pressure_correction.h:76