My Project
programmer's documentation
Loading...
Searching...
No Matches
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-2019 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_advection_field.h"
37#include "cs_domain.h"
38#include "cs_equation.h"
39#include "cs_gwf.h"
40#include "cs_param.h"
41#include "cs_property.h"
42
43/*----------------------------------------------------------------------------*/
44
45BEGIN_C_DECLS
46
47/*============================================================================
48 * Macro definitions
49 *============================================================================*/
50
51/*============================================================================
52 * Type definitions
53 *============================================================================*/
54
55/*============================================================================
56 * Global variables
57 *============================================================================*/
58
59/*============================================================================
60 * Public function prototypes
61 *============================================================================*/
62
63/*----------------------------------------------------------------------------*/
73/*----------------------------------------------------------------------------*/
74
75void
76cs_domain_set_output_param(cs_domain_t *domain,
77 int nt_interval,
78 int nt_list,
79 int verbosity);
80
81/*----------------------------------------------------------------------------*/
90/*----------------------------------------------------------------------------*/
91
92void
93cs_domain_set_time_param(cs_domain_t *domain,
94 int nt_max,
95 double t_max);
96
97/*----------------------------------------------------------------------------*/
105/*----------------------------------------------------------------------------*/
106
107void
108cs_domain_automatic_time_step_settings(cs_domain_t *domain);
109
110/*----------------------------------------------------------------------------*/
118/*----------------------------------------------------------------------------*/
119
120void
121cs_domain_def_time_step_by_function(cs_domain_t *domain,
122 cs_time_func_t *func,
123 void *func_input);
124
125/*----------------------------------------------------------------------------*/
132/*----------------------------------------------------------------------------*/
133
134void
135cs_domain_def_time_step_by_value(cs_domain_t *domain,
136 double dt);
137
138/*----------------------------------------------------------------------------*/
148/*----------------------------------------------------------------------------*/
149
150void
151cs_domain_initialize_setup(cs_domain_t *domain);
152
153/*----------------------------------------------------------------------------*/
160/*----------------------------------------------------------------------------*/
161
162void
163cs_domain_init_cdo_structures(cs_domain_t *domain);
164
165/*----------------------------------------------------------------------------*/
171/*----------------------------------------------------------------------------*/
172
173void
174cs_domain_finalize_setup(cs_domain_t *domain);
175
176/*----------------------------------------------------------------------------*/
183/*----------------------------------------------------------------------------*/
184
185void
186cs_domain_initialize_systems(cs_domain_t *domain);
187
188/*----------------------------------------------------------------------------*/
194/*----------------------------------------------------------------------------*/
195
196void
197cs_domain_setup_log(const cs_domain_t *domain);
198
199/*----------------------------------------------------------------------------*/
200
201END_C_DECLS
202
203#endif /* __CS_DOMAIN_SETUP_H__ */
cs_advection_field.h
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition cs_defs.h:467
END_C_DECLS
#define END_C_DECLS
Definition cs_defs.h:468
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:701
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:408
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:309
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:444
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:660
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:282
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:334
cs_domain_finalize_setup
void cs_domain_finalize_setup(cs_domain_t *domain)
Last setup stage of the cs_domain_t structure.
Definition cs_domain_setup.c:577
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:500
cs_domain_def_time_step_by_function
void 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:366
cs_equation.h
dt
@ dt
Definition cs_field_pointer.h:65
cs_gwf.h
cs_param.h
cs_time_func_t
void() cs_time_func_t(int time_iter, double time, void *input, cs_real_t *retval)
Function which defines the evolution of a quantity according to the number of iteration already done,...
Definition cs_param.h:88
cs_property.h
cs_domain_t
Structure storing the main features of the computational domain and pointers to the main geometrical ...
Definition cs_domain.h:87
Generated on Wed Mar 13 2024 18:14:52 for My Project by doxygen 1.9.8