My Project
programmer's documentation
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-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_base.h"
35 #include "cs_domain.h"
36 #include "cs_mesh.h"
37 #include "cs_mesh_quantities.h"
38 
39 /*----------------------------------------------------------------------------*/
40 
41 BEGIN_C_DECLS
42 
43 /*============================================================================
44  * Macro definitions
45  *============================================================================*/
46 
47 /*============================================================================
48  * Type definitions
49  *============================================================================*/
50 
51 /*============================================================================
52  * Public function prototypes
53  *============================================================================*/
54 
55 /*----------------------------------------------------------------------------*/
62 /*----------------------------------------------------------------------------*/
63 
64 void
65 cs_cdo_initialize_setup(cs_domain_t *domain);
66 
67 /*----------------------------------------------------------------------------*/
76 /*----------------------------------------------------------------------------*/
77 
78 void
79 cs_cdo_initialize_structures(cs_domain_t *domain,
80  cs_mesh_t *m,
81  cs_mesh_quantities_t *mq);
82 
83 /*----------------------------------------------------------------------------*/
90 /*----------------------------------------------------------------------------*/
91 
92 void
93 cs_cdo_finalize(cs_domain_t *domain);
94 
95 /*----------------------------------------------------------------------------*/
101 /*----------------------------------------------------------------------------*/
102 
103 void
104 cs_cdo_main(cs_domain_t *domain);
105 
106 /*----------------------------------------------------------------------------*/
107 
108 END_C_DECLS
109 
110 #endif /* __CS_CDO_MAIN_H__ */
cs_cdo_initialize_structures
void cs_cdo_initialize_structures(cs_domain_t *domain, 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:447
cs_domain_t
Structure storing the main features of the computational domain and pointers to the main geometrical ...
Definition: cs_domain.h:87
cs_domain.h
cs_cdo_initialize_setup
void cs_cdo_initialize_setup(cs_domain_t *domain)
Initialize the computational domain when CDO/HHO schemes are activated and cs_user_model() has been c...
Definition: cs_cdo_main.c:396
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:468
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:467
cs_mesh_quantities.h
cs_mesh_quantities_t
Definition: cs_mesh_quantities.h:90
cs_mesh.h
cs_cdo_main
void cs_cdo_main(cs_domain_t *domain)
Main program for running a simulation with the CDO kernel.
Definition: cs_cdo_main.c:563
cs_cdo_finalize
void cs_cdo_finalize(cs_domain_t *domain)
Free all structures allocated during the resolution of CDO/HHO schemes.
Definition: cs_cdo_main.c:503
cs_mesh_t
Definition: cs_mesh.h:63
cs_base.h
Generated on Thu Apr 9 2020 17:26:56 for My Project by   doxygen 1.8.16