8.3
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-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
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
41BEGIN_C_DECLS
42
43/*============================================================================
44 * Macro definitions
45 *============================================================================*/
46
47/*============================================================================
48 * Type definitions
49 *============================================================================*/
50
51/*============================================================================
52 * Global variables
53 *============================================================================*/
54
55/*============================================================================
56 * Public function prototypes
57 *============================================================================*/
58
59/*----------------------------------------------------------------------------*/
68/*----------------------------------------------------------------------------*/
69
70void
71cs_domain_set_time_param(cs_domain_t *domain,
72 int nt_max,
73 double t_max);
74
75/*----------------------------------------------------------------------------*/
83/*----------------------------------------------------------------------------*/
84
85void
86cs_domain_automatic_time_step_settings(cs_domain_t *domain);
87
88/*----------------------------------------------------------------------------*/
98/*----------------------------------------------------------------------------*/
99
100cs_xdef_t *
101cs_domain_def_time_step_by_function(cs_domain_t *domain,
102 cs_time_func_t *func,
103 void *func_input);
104
105/*----------------------------------------------------------------------------*/
112/*----------------------------------------------------------------------------*/
113
114void
115cs_domain_def_time_step_by_value(cs_domain_t *domain,
116 double dt);
117
118/*----------------------------------------------------------------------------*/
128/*----------------------------------------------------------------------------*/
129
130void
131cs_domain_initialize_setup(cs_domain_t *domain);
132
133/*----------------------------------------------------------------------------*/
140/*----------------------------------------------------------------------------*/
141
142void
143cs_domain_init_cdo_structures(cs_domain_t *domain);
144
145/*----------------------------------------------------------------------------*/
151/*----------------------------------------------------------------------------*/
152
153void
154cs_domain_finalize_user_setup(cs_domain_t *domain);
155
156/*----------------------------------------------------------------------------*/
162/*----------------------------------------------------------------------------*/
163
164void
165cs_domain_finalize_module_setup(cs_domain_t *domain);
166
167/*----------------------------------------------------------------------------*/
174/*----------------------------------------------------------------------------*/
175
176void
177cs_domain_initialize_systems(cs_domain_t *domain);
178
179/*----------------------------------------------------------------------------*/
185/*----------------------------------------------------------------------------*/
186
187void
188cs_domain_setup_log(const cs_domain_t *domain);
189
190/*----------------------------------------------------------------------------*/
191
192END_C_DECLS
193
194#endif /* __CS_DOMAIN_SETUP_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543
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.cpp:859
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.cpp:433
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.cpp:328
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.cpp:385
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.cpp:474
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.cpp:790
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.cpp:350
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.cpp:578
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.cpp:690
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.cpp:729
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:129
cs_xdef_t
Structure storing medata for defining a quantity in a very flexible way.
Definition: cs_xdef.h:160