8.1
general documentation
cs_domain_setup.h
Go to the documentation of this file.
1 #ifndef __CS_DOMAIN_SETUP_H__
2 #define __CS_DOMAIN_SETUP_H__
3 
4 /*============================================================================
5  * Manage the definition/setting of a computation
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 #include "cs_domain.h"
37 #include "cs_param_types.h"
38 
39 /*----------------------------------------------------------------------------*/
40 
41 BEGIN_C_DECLS
42 
43 /*============================================================================
44  * Macro definitions
45  *============================================================================*/
46 
47 /*============================================================================
48  * Type definitions
49  *============================================================================*/
50 
51 /*============================================================================
52  * Global variables
53  *============================================================================*/
54 
55 /*============================================================================
56  * Prototypes for functions intended for use only by Fortran wrappers.
57  * (descriptions follow, with function bodies).
58  *============================================================================*/
59 
60 void
61 cs_f_domain_setup_init_model_context(void);
62 
63 void
64 cs_f_domain_initialize_cdo_systems(void);
65 
66 /*============================================================================
67  * Public function prototypes
68  *============================================================================*/
69 
70 /*----------------------------------------------------------------------------*/
80 /*----------------------------------------------------------------------------*/
81 
82 void
83 cs_domain_set_output_param(cs_domain_t *domain,
84  int nt_interval,
85  int nt_list,
86  int verbosity);
87 
88 /*----------------------------------------------------------------------------*/
97 /*----------------------------------------------------------------------------*/
98 
99 void
100 cs_domain_set_time_param(cs_domain_t *domain,
101  int nt_max,
102  double t_max);
103 
104 /*----------------------------------------------------------------------------*/
112 /*----------------------------------------------------------------------------*/
113 
114 void
115 cs_domain_automatic_time_step_settings(cs_domain_t *domain);
116 
117 /*----------------------------------------------------------------------------*/
127 /*----------------------------------------------------------------------------*/
128 
129 cs_xdef_t *
130 cs_domain_def_time_step_by_function(cs_domain_t *domain,
131  cs_time_func_t *func,
132  void *func_input);
133 
134 /*----------------------------------------------------------------------------*/
141 /*----------------------------------------------------------------------------*/
142 
143 void
144 cs_domain_def_time_step_by_value(cs_domain_t *domain,
145  double dt);
146 
147 /*----------------------------------------------------------------------------*/
157 /*----------------------------------------------------------------------------*/
158 
159 void
160 cs_domain_initialize_setup(cs_domain_t *domain);
161 
162 /*----------------------------------------------------------------------------*/
169 /*----------------------------------------------------------------------------*/
170 
171 void
172 cs_domain_init_cdo_structures(cs_domain_t *domain);
173 
174 /*----------------------------------------------------------------------------*/
180 /*----------------------------------------------------------------------------*/
181 
182 void
183 cs_domain_finalize_user_setup(cs_domain_t *domain);
184 
185 /*----------------------------------------------------------------------------*/
191 /*----------------------------------------------------------------------------*/
192 
193 void
194 cs_domain_finalize_module_setup(cs_domain_t *domain);
195 
196 /*----------------------------------------------------------------------------*/
203 /*----------------------------------------------------------------------------*/
204 
205 void
206 cs_domain_initialize_systems(cs_domain_t *domain);
207 
208 /*----------------------------------------------------------------------------*/
214 /*----------------------------------------------------------------------------*/
215 
216 void
217 cs_domain_setup_log(const cs_domain_t *domain);
218 
219 /*----------------------------------------------------------------------------*/
220 
221 END_C_DECLS
222 
223 #endif /* __CS_DOMAIN_SETUP_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:515
cs_domain.h
cs_domain_setup_log
void cs_domain_setup_log(const cs_domain_t *domain)
Summary of the main domain settings.
Definition: cs_domain_setup.c:887
cs_domain_def_time_step_by_value
void cs_domain_def_time_step_by_value(cs_domain_t *domain, double dt)
Define the value of the time step.
Definition: cs_domain_setup.c:471
cs_domain_set_time_param
void cs_domain_set_time_param(cs_domain_t *domain, int nt_max, double t_max)
Set parameters for unsteady computations: the max number of time steps or the final physical time of ...
Definition: cs_domain_setup.c:369
cs_domain_initialize_setup
void cs_domain_initialize_setup(cs_domain_t *domain)
First setup stage of the cs_domain_t structure Define extra domain boundaries Setup predefined equati...
Definition: cs_domain_setup.c:512
cs_f_domain_initialize_cdo_systems
void cs_f_domain_initialize_cdo_systems(void)
Initialize CDO systems.
Definition: cs_domain_setup.c:320
cs_domain_initialize_systems
void cs_domain_initialize_systems(cs_domain_t *domain)
Initialize systems of equations and their related field values according to the user settings.
Definition: cs_domain_setup.c:818
cs_domain_set_output_param
void cs_domain_set_output_param(cs_domain_t *domain, int nt_interval, int nt_list, int verbosity)
Set to true the automatic update of all advection fields.
Definition: cs_domain_setup.c:342
cs_domain_automatic_time_step_settings
void cs_domain_automatic_time_step_settings(cs_domain_t *domain)
Set time step parameters for unsteady computations when this is not already done. This situation shou...
Definition: cs_domain_setup.c:390
cs_domain_init_cdo_structures
void cs_domain_init_cdo_structures(cs_domain_t *domain)
After having read the mesh and the first setup stage build the connectivities and mesh quantities rel...
Definition: cs_domain_setup.c:616
cs_f_domain_setup_init_model_context
void cs_f_domain_setup_init_model_context(void)
When the models have been activated, continue to allocate, add and define structures related to those...
Definition: cs_domain_setup.c:305
cs_domain_finalize_user_setup
void cs_domain_finalize_user_setup(cs_domain_t *domain)
Last user setup stage of the cs_domain_t structure.
Definition: cs_domain_setup.c:722
cs_domain_finalize_module_setup
void cs_domain_finalize_module_setup(cs_domain_t *domain)
Last setup stage of the cs_domain_t structure.
Definition: cs_domain_setup.c:757
cs_domain_def_time_step_by_function
cs_xdef_t * cs_domain_def_time_step_by_function(cs_domain_t *domain, cs_time_func_t *func, void *func_input)
Define the value of the time step thanks to a predefined function.
Definition: cs_domain_setup.c:424
dt
@ dt
Definition: cs_field_pointer.h:65
cs_param_types.h
cs_time_func_t
void() cs_time_func_t(double time, void *input, cs_real_t *retval)
Function which defines the evolution of a quantity according to the current time and any structure gi...
Definition: cs_param_types.h:172
cs_domain_t
Structure storing the main features of the computational domain and pointers to the main geometrical ...
Definition: cs_domain.h:138
cs_xdef_t
Structure storing medata for defining a quantity in a very flexible way.
Definition: cs_xdef.h:160