9.2
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-2026 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 "base/cs_defs.h"
35
36#include "base/cs_param_types.h"
37#include "cdo/cs_domain.h"
38
39/*============================================================================
40 * Macro definitions
41 *============================================================================*/
42
43/*============================================================================
44 * Type definitions
45 *============================================================================*/
46
47/*============================================================================
48 * Global variables
49 *============================================================================*/
50
51/*============================================================================
52 * Public function prototypes
53 *============================================================================*/
54
55/*----------------------------------------------------------------------------*/
64/*----------------------------------------------------------------------------*/
65
66void
67cs_domain_set_time_param(cs_domain_t *domain,
68 int nt_max,
69 double t_max);
70
71/*----------------------------------------------------------------------------*/
79/*----------------------------------------------------------------------------*/
80
81void
82cs_domain_automatic_time_step_settings(cs_domain_t *domain);
83
84/*----------------------------------------------------------------------------*/
94/*----------------------------------------------------------------------------*/
95
96cs_xdef_t *
97cs_domain_def_time_step_by_function(cs_domain_t *domain,
98 cs_time_func_t *func,
99 void *func_input);
100
101/*----------------------------------------------------------------------------*/
108/*----------------------------------------------------------------------------*/
109
110void
111cs_domain_def_time_step_by_value(cs_domain_t *domain,
112 double dt);
113
114/*----------------------------------------------------------------------------*/
121/*----------------------------------------------------------------------------*/
122
123void
124cs_domain_setup_init_cdo_structures(cs_domain_t *domain);
125
126/*----------------------------------------------------------------------------*/
136/*----------------------------------------------------------------------------*/
137
138void
139cs_domain_setup_initialize(cs_domain_t *domain);
140
141/*----------------------------------------------------------------------------*/
147/*----------------------------------------------------------------------------*/
148
149void
150cs_domain_setup_finalize(cs_domain_t *domain);
151
152/*----------------------------------------------------------------------------*/
158/*----------------------------------------------------------------------------*/
159
160void
161cs_domain_setup_finalize_module(cs_domain_t *domain);
162
163/*----------------------------------------------------------------------------*/
170/*----------------------------------------------------------------------------*/
171
172void
173cs_domain_setup_init_state(cs_domain_t *domain);
174
175/*----------------------------------------------------------------------------*/
181/*----------------------------------------------------------------------------*/
182
183void
184cs_domain_setup_log(const cs_domain_t *domain);
185
186#endif /* CS_DOMAIN_SETUP_H */
cs_defs.h
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:880
cs_domain_setup_initialize
void cs_domain_setup_initialize(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:603
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:432
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:327
cs_domain_setup_init_cdo_structures
void cs_domain_setup_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:470
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:384
cs_domain_setup_finalize_module
void cs_domain_setup_finalize_module(cs_domain_t *domain)
Last user setup stage of the cs_domain_t structure.
Definition: cs_domain_setup.cpp:753
cs_domain_setup_init_state
void cs_domain_setup_init_state(cs_domain_t *domain)
Initialize systems of equations and their related field/properties values according to the user setti...
Definition: cs_domain_setup.cpp:814
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:349
cs_domain_setup_finalize
void cs_domain_setup_finalize(cs_domain_t *domain)
Last GUI and then user setup stage of the cs_domain_t structure.
Definition: cs_domain_setup.cpp:703
dt
@ dt
Definition: cs_field_pointer.h:61
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:120
cs_xdef_t
Structure storing medata for defining a quantity in a very flexible way.
Definition: cs_xdef.h:156