programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
cs_hho_scaleq.h
Go to the documentation of this file.
1 #ifndef __CS_HHO_SCALEQ_H__
2 #define __CS_HHO_SCALEQ_H__
3 
4 /*============================================================================
5  * Build an algebraic system for scalar conv./diff. eq. with Hybrid High Order
6  * space discretization
7  *============================================================================*/
8 
9 /*
10  This file is part of Code_Saturne, a general-purpose CFD tool.
11 
12  Copyright (C) 1998-2017 EDF S.A.
13 
14  This program is free software; you can redistribute it and/or modify it under
15  the terms of the GNU General Public License as published by the Free Software
16  Foundation; either version 2 of the License, or (at your option) any later
17  version.
18 
19  This program is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
21  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
22  details.
23 
24  You should have received a copy of the GNU General Public License along with
25  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
26  Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 */
28 
29 /*----------------------------------------------------------------------------
30  * Local headers
31  *----------------------------------------------------------------------------*/
32 
33 #include "cs_base.h"
34 #include "cs_time_step.h"
35 #include "cs_mesh.h"
36 #include "cs_field.h"
37 #include "cs_cdo_connect.h"
38 #include "cs_cdo_quantities.h"
39 #include "cs_equation_param.h"
40 #include "cs_source_term.h"
41 
42 /*----------------------------------------------------------------------------*/
43 
45 
46 /*============================================================================
47  * Macro definitions
48  *============================================================================*/
49 
50 /*============================================================================
51  * Type definitions
52  *============================================================================*/
53 
54 /* Algebraic system for HHO discretization */
55 typedef struct _cs_hho_scaleq_t cs_hho_scaleq_t;
56 
57 /*============================================================================
58  * Public function prototypes
59  *============================================================================*/
60 
61 /*----------------------------------------------------------------------------*/
69 /*----------------------------------------------------------------------------*/
70 
71 void
73  const cs_cdo_connect_t *connect,
74  const cs_time_step_t *time_step);
75 
76 /*----------------------------------------------------------------------------*/
83 /*----------------------------------------------------------------------------*/
84 
85 void
87 
88 /*----------------------------------------------------------------------------*/
92 /*----------------------------------------------------------------------------*/
93 
94 void
96 
97 /*----------------------------------------------------------------------------*/
107 /*----------------------------------------------------------------------------*/
108 
109 void *
111  cs_equation_builder_t *eqb);
112 
113 /*----------------------------------------------------------------------------*/
121 /*----------------------------------------------------------------------------*/
122 
123 void *
124 cs_hho_scaleq_free_data(void *data);
125 
126 /*----------------------------------------------------------------------------*/
134 /*----------------------------------------------------------------------------*/
135 
136 void
139  void *data);
140 
141 /*----------------------------------------------------------------------------*/
153 /*----------------------------------------------------------------------------*/
154 
155 void
158  void *data,
159  cs_matrix_t **system_matrix,
160  cs_real_t **system_rhs);
161 
162 /*----------------------------------------------------------------------------*/
177 /*----------------------------------------------------------------------------*/
178 
179 void
181  const cs_real_t *field_val,
182  double dt_cur,
183  const cs_equation_param_t *eqp,
185  void *data,
186  cs_real_t *rhs,
188 
189 /*----------------------------------------------------------------------------*/
201 /*----------------------------------------------------------------------------*/
202 
203 void
205  const cs_real_t *rhs,
206  const cs_equation_param_t *eqp,
208  void *data,
209  cs_real_t *field_val);
210 
211 /*----------------------------------------------------------------------------*/
220 /*----------------------------------------------------------------------------*/
221 
222 double *
223 cs_hho_scaleq_get_face_values(const void *data);
224 
225 /*----------------------------------------------------------------------------*/
235 /*----------------------------------------------------------------------------*/
236 
237 void
238 cs_hho_scaleq_extra_op(const char *eqname,
239  const cs_field_t *field,
240  const cs_equation_param_t *eqp,
242  void *data);
243 
244 /*----------------------------------------------------------------------------*/
245 
247 
248 #endif /* __CS_HHO_SCALEQ_H__ */
Definition: cs_equation_common.h:57
time step descriptor
Definition: cs_time_step.h:51
void cs_hho_scaleq_build_system(const cs_mesh_t *mesh, const cs_real_t *field_val, double dt_cur, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data, cs_real_t *rhs, cs_matrix_t *matrix)
Build the linear system arising from a scalar convection/diffusion equation with a HHO scheme...
Definition: cs_hho_scaleq.c:494
Field descriptor.
Definition: cs_field.h:124
Definition: cs_equation_param.h:101
#define BEGIN_C_DECLS
Definition: cs_defs.h:453
Definition: cs_cdo_connect.h:55
void cs_hho_scaleq_set_shared_pointers(const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect, const cs_time_step_t *time_step)
Set shared pointers from the main domain members.
Definition: cs_hho_scaleq.c:152
void cs_hho_scaleq_update_field(const cs_real_t *solu, const cs_real_t *rhs, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data, cs_real_t *field_val)
Store solution(s) of the linear system into a field structure Update extra-field values required for ...
Definition: cs_hho_scaleq.c:691
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
Definition: cs_cdo_quantities.h:89
void matrix(const int *iconvp, const int *idiffp, const int *ndircp, const int *isym, const cs_real_t *thetap, const int *imucpp, const cs_real_t coefbp[], const cs_real_t cofbfp[], const cs_real_t rovsdt[], const cs_real_t i_massflux[], const cs_real_t b_massflux[], const cs_real_t i_visc[], const cs_real_t b_visc[], const cs_real_t xcpp[], cs_real_t da[], cs_real_t xa[])
Definition: cs_matrix_building.c:111
void cs_hho_scaleq_compute_source(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data)
Compute the contributions of source terms (store inside builder)
Definition: cs_hho_scaleq.c:398
struct _cs_matrix_t cs_matrix_t
Definition: cs_matrix.h:90
Definition: cs_mesh.h:63
void * cs_hho_scaleq_init_data(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb)
Initialize a cs_hho_scaleq_t structure storing data useful for managing such a scheme.
Definition: cs_hho_scaleq.c:293
void cs_hho_scaleq_finalize(void)
Free buffers and generic structures related to HHO schemes.
Definition: cs_hho_scaleq.c:256
double * cs_hho_scaleq_get_face_values(const void *data)
Get the computed values at faces (DoF used in the linear system are located at primal faces) ...
Definition: cs_hho_scaleq.c:722
void cs_hho_scaleq_extra_op(const char *eqname, const cs_field_t *field, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data)
Predefined extra-operations related to this equation.
Definition: cs_hho_scaleq.c:745
void cs_hho_scaleq_initialize(cs_flag_t scheme_flag)
Allocate work buffer and general structures related to HHO schemes.
Definition: cs_hho_scaleq.c:172
#define END_C_DECLS
Definition: cs_defs.h:454
unsigned short int cs_flag_t
Definition: cs_defs.h:299
void cs_hho_scaleq_initialize_system(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data, cs_matrix_t **system_matrix, cs_real_t **system_rhs)
Create the matrix of the current algebraic system. Allocate and initialize the right-hand side associ...
Definition: cs_hho_scaleq.c:424
void * cs_hho_scaleq_free_data(void *data)
Destroy a cs_hho_scaleq_t structure.
Definition: cs_hho_scaleq.c:370