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-2017 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 
46 
47 /*============================================================================
48  * Macro definitions
49  *============================================================================*/
50 
51 
52 /*============================================================================
53  * Type definitions
54  *============================================================================*/
55 
56 /*============================================================================
57  * Global variables
58  *============================================================================*/
59 
60 /*============================================================================
61  * Public function prototypes
62  *============================================================================*/
63 
64 /*----------------------------------------------------------------------------*/
70 /*----------------------------------------------------------------------------*/
71 
72 void
74 
75 /*----------------------------------------------------------------------------*/
81 /*----------------------------------------------------------------------------*/
82 
83 void
85 
86 /*----------------------------------------------------------------------------*/
94 /*----------------------------------------------------------------------------*/
95 
96 void
98 
99 /*----------------------------------------------------------------------------*/
106 /*----------------------------------------------------------------------------*/
107 
108 void
110 
111 /*----------------------------------------------------------------------------*/
119 /*----------------------------------------------------------------------------*/
120 
121 void
123  cs_mesh_t *mesh,
124  const cs_mesh_quantities_t *mesh_quantities);
125 
126 /*----------------------------------------------------------------------------*/
132 /*----------------------------------------------------------------------------*/
133 
134 void
136 
137 /*----------------------------------------------------------------------------*/
144 /*----------------------------------------------------------------------------*/
145 
146 void
148 
149 /*----------------------------------------------------------------------------*/
150 
152 
153 #endif /* __CS_DOMAIN_SETUP_H__ */
void cs_domain_solve(cs_domain_t *domain)
Solve all the equations of a computational domain for one time step.
#define BEGIN_C_DECLS
Definition: cs_defs.h:461
Definition: cs_mesh.h:63
void cs_domain_setup_predefined_equations(cs_domain_t *domain)
Setup predefined equations which are activated At this stage, no equation is added and the space disc...
Definition: cs_domain_setup.c:280
void cs_domain_update_advfield(cs_domain_t *domain)
Set to true the automatic update of all advection fields.
Definition: cs_domain_setup.c:232
Definition: cs_mesh_quantities.h:85
Definition: cs_domain.h:97
void cs_domain_finalize_setup(cs_domain_t *domain, cs_mesh_t *mesh, const cs_mesh_quantities_t *mesh_quantities)
Build a cs_domain_t structure.
Definition: cs_domain_setup.c:444
#define END_C_DECLS
Definition: cs_defs.h:462
void cs_domain_update_wall_zones(cs_domain_t *domain)
Add a new zone gathering all CS_DOMAIN_BOUNDARY_WALL zone type.
Definition: cs_domain_setup.c:251
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:557
void cs_domain_set_scheme_flags(cs_domain_t *domain)
Define the scheme flags for the current computational domain Requirement: domain->cdo_context is allo...
Definition: cs_domain_setup.c:309
Definition: mesh.f90:26