programmer's documentation
cs_hodge.h
Go to the documentation of this file.
1 #ifndef __CS_HODGE_H__
2 #define __CS_HODGE_H__
3 
4 /*============================================================================
5  * Build discrete Hodge operators
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  * Standard C library headers
30  *----------------------------------------------------------------------------*/
31 
32 /*----------------------------------------------------------------------------
33  * Local headers
34  *----------------------------------------------------------------------------*/
35 
36 #include "cs_base.h"
37 #include "cs_time_step.h"
38 #include "cs_cdo_toolbox.h"
39 #include "cs_sla.h"
40 #include "cs_cdo_connect.h"
41 #include "cs_cdo_quantities.h"
42 #include "cs_param.h"
43 #include "cs_property.h"
44 
45 /*----------------------------------------------------------------------------*/
46 
48 
49 /*============================================================================
50  * Macro and type definitions
51  *============================================================================*/
52 
53 typedef struct _hodge_builder_t cs_hodge_builder_t;
54 
55 /*============================================================================
56  * Public function definitions
57  *============================================================================*/
58 
59 /*----------------------------------------------------------------------------*/
69 /*----------------------------------------------------------------------------*/
70 
73  cs_param_hodge_t h_info);
74 
75 /*----------------------------------------------------------------------------*/
83 /*----------------------------------------------------------------------------*/
84 
87 
88 /*----------------------------------------------------------------------------*/
95 /*----------------------------------------------------------------------------*/
96 
97 void
99  cs_real_t ptyval);
100 
101 /*----------------------------------------------------------------------------*/
108 /*----------------------------------------------------------------------------*/
109 
110 void
112  const cs_real_33_t ptymat);
113 
114 /*----------------------------------------------------------------------------*/
125 /*----------------------------------------------------------------------------*/
126 
127 cs_locmat_t *
128 cs_hodge_build_local(int c_id,
129  const cs_cdo_connect_t *connect,
130  const cs_cdo_quantities_t *quant,
131  cs_hodge_builder_t *hb);
132 
133 /*----------------------------------------------------------------------------*/
144 /*----------------------------------------------------------------------------*/
145 
147 cs_hodge_compute(const cs_cdo_connect_t *connect,
148  const cs_cdo_quantities_t *quant,
149  const cs_property_t *pty,
150  const cs_param_hodge_t h_info);
151 
152 /*----------------------------------------------------------------------------*/
153 
155 
156 #endif /* __CS_HODGE_H__ */
157 
#define BEGIN_C_DECLS
Definition: cs_defs.h:429
cs_locmat_t * cs_hodge_build_local(int c_id, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, cs_hodge_builder_t *hb)
Build a local discrete Hodge.
Definition: cs_hodge.c:1315
void cs_hodge_builder_set_tensor(cs_hodge_builder_t *hb, const cs_real_33_t ptymat)
Set the value of the property attached to a hodge builder.
Definition: cs_hodge.c:1290
Definition: cs_cdo_connect.h:67
Definition: cs_cdo_quantities.h:86
Definition: cs_sla.h:86
struct _hodge_builder_t cs_hodge_builder_t
Definition: cs_hodge.h:53
cs_hodge_builder_t * cs_hodge_builder_init(const cs_cdo_connect_t *connect, cs_param_hodge_t h_info)
Allocate and initialize a cs_hodge_builder_t structure.
Definition: cs_hodge.c:1156
#define END_C_DECLS
Definition: cs_defs.h:430
double cs_real_t
Definition: cs_defs.h:296
cs_real_t cs_real_33_t[3][3]
3x3 matrix of floating-point values
Definition: cs_defs.h:311
cs_hodge_builder_t * cs_hodge_builder_free(cs_hodge_builder_t *hb)
Free a cs_hodge_builder_t structure.
Definition: cs_hodge.c:1235
Definition: cs_param.h:130
void cs_hodge_builder_set_val(cs_hodge_builder_t *hb, cs_real_t ptyval)
Set the value of the property attached to a hodge builder.
Definition: cs_hodge.c:1271
Definition: cs_cdo_toolbox.h:72
cs_sla_matrix_t * cs_hodge_compute(const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_property_t *pty, const cs_param_hodge_t h_info)
Build a discrete Hodge operator.
Definition: cs_hodge.c:1395