programmer's documentation
cs_cdovb_codits.h
Go to the documentation of this file.
1 #ifndef __CS_CDOVB_CODITS_H__
2 #define __CS_CDOVB_CODITS_H__
3 
4 /*============================================================================
5  * Build an algebraic CDO vertex-based system for scalar conv./diff. eq.
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2015 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  * Local headers
30  *----------------------------------------------------------------------------*/
31 
32 #include "cs_base.h"
33 #include "cs_cdo_connect.h"
34 #include "cs_cdo_quantities.h"
35 #include "cs_param_eq.h"
36 #include "cs_cdo_bc.h"
37 #include "cs_hodge.h"
38 
39 /*----------------------------------------------------------------------------*/
40 
42 
43 /*============================================================================
44  * Macro definitions
45  *============================================================================*/
46 
47 /*============================================================================
48  * Type definitions
49  *============================================================================*/
50 
51 /* Algebraic system for CDO vertex-based discretization */
52 typedef struct _cdovb_codits_t cs_cdovb_codits_t;
53 
54 /*============================================================================
55  * Public function prototypes
56  *============================================================================*/
57 
58 /*----------------------------------------------------------------------------*/
65 /*----------------------------------------------------------------------------*/
66 
67 void
68 cs_cdovb_codits_create_all(int n_scal_systems);
69 
70 /*----------------------------------------------------------------------------*/
78 /*----------------------------------------------------------------------------*/
79 
80 void
82  const cs_mesh_t *m,
83  int eq_id);
84 
85 /*----------------------------------------------------------------------------*/
89 /*----------------------------------------------------------------------------*/
90 
91 void
93 
94 /*----------------------------------------------------------------------------*/
105 /*----------------------------------------------------------------------------*/
106 
107 void
109  const cs_cdo_connect_t *connect,
110  const cs_cdo_quantities_t *quant,
111  double tcur,
112  int eq_id);
113 
114 /*----------------------------------------------------------------------------*/
123 /*----------------------------------------------------------------------------*/
124 
125 void
127  const cs_cdo_quantities_t *quant,
128  int eq_id);
129 
130 /*----------------------------------------------------------------------------*/
131 
133 
134 #endif /* __CS_CDOVB_CODITS_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:419
void cs_cdovb_codits_create_all(int n_scal_systems)
Allocate the required number of scalar equations based on a vertex based discretization.
Definition: cs_cdovb_codits.c:792
Definition: cs_cdo_connect.h:86
Definition: cs_param_eq.h:99
Definition: cs_cdo_quantities.h:94
Definition: cs_mesh.h:62
void cs_cdovb_codits_solve(const cs_mesh_t *m, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, double tcur, int eq_id)
Solve a scalar convection/diffusion equation with a CDO vertex-based scheme.
Definition: cs_cdovb_codits.c:958
#define END_C_DECLS
Definition: cs_defs.h:420
void cs_cdovb_codits_post(const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, int eq_id)
Post-process the solution of a scalar convection/diffusion equation solved with a CDO vertex-based sc...
Definition: cs_cdovb_codits.c:1036
void cs_cdovb_codits_init(const cs_param_eq_t *eq, const cs_mesh_t *m, int eq_id)
Initialize a cs_cdovb_codits_t.
Definition: cs_cdovb_codits.c:812
void cs_cdovb_codits_free_all(void)
Destroy all cs_cdovb_codits_t structures.
Definition: cs_cdovb_codits.c:902