programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
cs_cdo_main.h
Go to the documentation of this file.
1 #ifndef __CS_CDO_MAIN_H__
2 #define __CS_CDO_MAIN_H__
3 
4 /*============================================================================
5  * Routines for solving equations with CDO discretizations
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_base.h"
35 #include "cs_mesh.h"
36 #include "cs_mesh_quantities.h"
37 
38 /*----------------------------------------------------------------------------*/
39 
41 
42 /*============================================================================
43  * Macro definitions
44  *============================================================================*/
45 
46 /*============================================================================
47  * Type definitions
48  *============================================================================*/
49 
50 /*============================================================================
51  * Public function prototypes
52  *============================================================================*/
53 
54 /*----------------------------------------------------------------------------*/
61 /*----------------------------------------------------------------------------*/
62 
63 void
64 cs_cdo_initialize_setup(int activation_mode);
65 
66 /*----------------------------------------------------------------------------*/
74 /*----------------------------------------------------------------------------*/
75 
76 void
79 
80 /*----------------------------------------------------------------------------*/
85 /*----------------------------------------------------------------------------*/
86 
87 void
88 cs_cdo_finalize(void);
89 
90 /*----------------------------------------------------------------------------*/
94 /*----------------------------------------------------------------------------*/
95 
96 void
97 cs_cdo_main(void);
98 
99 /*----------------------------------------------------------------------------*/
100 
102 
103 #endif /* __CS_CDO_MAIN_H__ */
void cs_cdo_finalize(void)
Free all structures allocated during the resolution of CDO/HHO schemes.
Definition: cs_cdo_main.c:233
#define BEGIN_C_DECLS
Definition: cs_defs.h:453
Definition: cs_mesh.h:63
void cs_cdo_initialize_structures(cs_mesh_t *m, cs_mesh_quantities_t *mq)
Define the structures related to the computational domain when CDO/HHO schemes are activated...
Definition: cs_cdo_main.c:185
Definition: cs_mesh_quantities.h:82
void cs_cdo_initialize_setup(int activation_mode)
Initialize the computational domain when CDO/HHO schemes are activated.
Definition: cs_cdo_main.c:102
void cs_cdo_main(void)
Main program for running a simulation with the CDO kernel.
Definition: cs_cdo_main.c:269
#define END_C_DECLS
Definition: cs_defs.h:454