programmer's 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-2018 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 
45 BEGIN_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 /*----------------------------------------------------------------------------*/
69 /*----------------------------------------------------------------------------*/
70 
71 void
72 cs_domain_update_advfield(cs_domain_t *domain);
73 
74 /*----------------------------------------------------------------------------*/
84 /*----------------------------------------------------------------------------*/
85 
86 void
87 cs_domain_set_output_param(cs_domain_t *domain,
88  int nt_interval,
89  int nt_list,
90  int verbosity);
91 
92 /*----------------------------------------------------------------------------*/
101 /*----------------------------------------------------------------------------*/
102 
103 void
104 cs_domain_set_time_param(cs_domain_t *domain,
105  int nt_max,
106  double t_max);
107 
108 /*----------------------------------------------------------------------------*/
116 /*----------------------------------------------------------------------------*/
117 
118 void
119 cs_domain_def_time_step_by_function(cs_domain_t *domain,
120  cs_timestep_func_t *func,
121  void *func_input);
122 
123 /*----------------------------------------------------------------------------*/
130 /*----------------------------------------------------------------------------*/
131 
132 void
133 cs_domain_def_time_step_by_value(cs_domain_t *domain,
134  double dt);
135 
136 /*----------------------------------------------------------------------------*/
146 /*----------------------------------------------------------------------------*/
147 
148 void
149 cs_domain_initialize_setup(cs_domain_t *domain);
150 
151 /*----------------------------------------------------------------------------*/
159 /*----------------------------------------------------------------------------*/
160 
161 void
162 cs_domain_finalize_setup(cs_domain_t *domain,
163  cs_mesh_t *mesh,
164  const cs_mesh_quantities_t *mesh_quantities);
165 
166 /*----------------------------------------------------------------------------*/
173 /*----------------------------------------------------------------------------*/
174 
175 void
176 cs_domain_initialize_systems(cs_domain_t *domain);
177 
178 /*----------------------------------------------------------------------------*/
179 
180 END_C_DECLS
181 
182 #endif /* __CS_DOMAIN_SETUP_H__ */
cs_gwf.h
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:462
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:359
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:274
cs_timestep_func_t
cs_real_t() cs_timestep_func_t(int time_iter, double time, void *input)
Function which defines the time step according to the number of iteration already done...
Definition: cs_param.h:89
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:301
cs_mesh_t
Definition: cs_mesh.h:63
cs_equation.h
cs_property.h
cs_domain.h
cs_param.h
cs_domain_update_advfield
void cs_domain_update_advfield(cs_domain_t *domain)
Set to true the automatic update of all advection fields.
Definition: cs_domain_setup.c:252
cs_advection_field.h
dt
Definition: cs_field_pointer.h:65
cs_mesh_quantities_t
Definition: cs_mesh_quantities.h:90
cs_domain_t
Structure storing the main features of the computational domain and pointers to the main geometrical ...
Definition: cs_domain.h:84
cs_domain_finalize_setup
void cs_domain_finalize_setup(cs_domain_t *domain, cs_mesh_t *mesh, const cs_mesh_quantities_t *mesh_quantities)
Last setup stage of the cs_domain_t structure.
Definition: cs_domain_setup.c:443
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:463
cs_domain_def_time_step_by_function
void cs_domain_def_time_step_by_function(cs_domain_t *domain, cs_timestep_func_t *func, void *func_input)
Define the value of the time step thanks to a predefined function.
Definition: cs_domain_setup.c:322
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:568
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:391
mesh
Definition: mesh.f90:26
Generated on Sat Feb 2 2019 15:43:25 by   doxygen 1.8.13