programmer's documentation
cs_cdofb_vecteq.h
Go to the documentation of this file.
1 #ifndef __CS_CDOFB_VECTEQ_H__
2 #define __CS_CDOFB_VECTEQ_H__
3 
4 /*============================================================================
5  * Build an algebraic CDO face-based system for unsteady convection/diffusion
6  * reaction of vector-valued equations with source terms
7  *============================================================================*/
8 
9 /*
10  This file is part of Code_Saturne, a general-purpose CFD tool.
11 
12  Copyright (C) 1998-2018 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 
31 #include "cs_defs.h"
32 
33 /*----------------------------------------------------------------------------
34  * Standard C library headers
35  *----------------------------------------------------------------------------*/
36 
37 /*----------------------------------------------------------------------------
38  * Local headers
39  *----------------------------------------------------------------------------*/
40 
41 #include "cs_base.h"
42 #include "cs_cdo_connect.h"
43 #include "cs_cdo_quantities.h"
44 #include "cs_equation_common.h"
45 #include "cs_equation_param.h"
46 #include "cs_field.h"
47 #include "cs_matrix.h"
48 #include "cs_mesh.h"
49 #include "cs_source_term.h"
50 #include "cs_time_step.h"
51 
52 /*----------------------------------------------------------------------------*/
53 
55 
56 /*============================================================================
57  * Macro definitions
58  *============================================================================*/
59 
60 /*============================================================================
61  * Type definitions
62  *============================================================================*/
63 
64 /* Algebraic system for CDO face-based discretization */
65 typedef struct _cs_cdofb_t cs_cdofb_vecteq_t;
66 
67 /*============================================================================
68  * Public function prototypes
69  *============================================================================*/
70 
71 /*----------------------------------------------------------------------------*/
82 /*----------------------------------------------------------------------------*/
83 
84 void
86  const cs_cdo_connect_t *connect,
87  const cs_time_step_t *time_step,
88  const cs_matrix_structure_t *ms);
89 
90 /*----------------------------------------------------------------------------*/
97 /*----------------------------------------------------------------------------*/
98 
99 void
101  cs_cell_builder_t **cb);
102 
103 /*----------------------------------------------------------------------------*/
108 /*----------------------------------------------------------------------------*/
109 
110 void
112 
113 /*----------------------------------------------------------------------------*/
123 /*----------------------------------------------------------------------------*/
124 
125 void *
127  cs_equation_builder_t *eqb);
128 
129 /*----------------------------------------------------------------------------*/
137 /*----------------------------------------------------------------------------*/
138 
139 void *
140 cs_cdofb_vecteq_free_context(void *data);
141 
142 /*----------------------------------------------------------------------------*/
150 /*----------------------------------------------------------------------------*/
151 
152 void
155  void *data);
156 
157 /*----------------------------------------------------------------------------*/
169 /*----------------------------------------------------------------------------*/
170 
171 void
174  void *data,
175  cs_matrix_t **system_matrix,
176  cs_real_t **system_rhs);
177 
178 /*----------------------------------------------------------------------------*/
193 /*----------------------------------------------------------------------------*/
194 
195 void
197  const cs_real_t *field_val,
198  double dt_cur,
199  const cs_equation_param_t *eqp,
201  void *data,
202  cs_real_t *rhs,
204 
205 /*----------------------------------------------------------------------------*/
217 /*----------------------------------------------------------------------------*/
218 
219 void
221  const cs_real_t *rhs,
222  const cs_equation_param_t *eqp,
224  void *data,
225  cs_real_t *field_val);
226 
227 /*----------------------------------------------------------------------------*/
237 /*----------------------------------------------------------------------------*/
238 
239 void
240 cs_cdofb_vecteq_extra_op(const char *eqname,
241  const cs_field_t *field,
242  const cs_equation_param_t *eqp,
244  void *data);
245 
246 /*----------------------------------------------------------------------------*/
254 /*----------------------------------------------------------------------------*/
255 
256 double *
257 cs_cdofb_vecteq_get_face_values(const void *data);
258 
259 /*----------------------------------------------------------------------------*/
260 
262 
263 #endif /* __CS_CDOFB_VECTEQ_H__ */
Store common elements used when building an algebraic system related to an equation.
Definition: cs_equation_common.h:62
time step descriptor
Definition: cs_time_step.h:51
Field descriptor.
Definition: cs_field.h:124
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources...
Definition: cs_equation_param.h:150
#define BEGIN_C_DECLS
Definition: cs_defs.h:461
void cs_cdofb_vecteq_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 CDO face-based sch...
Definition: cs_cdofb_vecteq.c:671
void * cs_cdofb_vecteq_free_context(void *data)
Destroy a cs_cdofb_vecteq_t structure.
Definition: cs_cdofb_vecteq.c:536
Definition: cs_cdo_connect.h:69
Definition: field.f90:27
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
Definition: cs_cdo_quantities.h:94
void cs_cdofb_vecteq_finalize_common(void)
Free work buffer and general structure related to CDO face-based schemes.
Definition: cs_cdofb_vecteq.c:367
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
Definition: cs_cdo_local.h:94
struct _cs_matrix_t cs_matrix_t
Definition: cs_matrix.h:90
void cs_cdofb_vecteq_compute_source(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data)
Compute the contributions of source terms (store inside data)
Definition: cs_cdofb_vecteq.c:565
Definition: cs_mesh.h:63
void * cs_cdofb_vecteq_init_context(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb)
Initialize a cs_cdofb_vecteq_t structure storing data useful for managing such a scheme.
Definition: cs_cdofb_vecteq.c:399
void cs_cdofb_vecteq_init_common(const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect, const cs_time_step_t *time_step, const cs_matrix_structure_t *ms)
Allocate work buffer and general structures related to CDO vector-valued face-based schemes...
Definition: cs_cdofb_vecteq.c:279
Definition: cs_cdo_local.h:71
void cs_cdofb_vecteq_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_cdofb_vecteq.c:965
void cs_cdofb_vecteq_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_cdofb_vecteq.c:625
double * cs_cdofb_vecteq_get_face_values(const void *data)
Get the computed values at each face.
Definition: cs_cdofb_vecteq.c:1016
#define END_C_DECLS
Definition: cs_defs.h:462
void cs_cdofb_vecteq_get(cs_cell_sys_t **csys, cs_cell_builder_t **cb)
Retrieve work buffers used for building a CDO system cellwise.
Definition: cs_cdofb_vecteq.c:345
Definition: cs_cdofb_priv.h:51
Structure and routines handling the specific settings related to a cs_equation_t structure.
struct _cs_matrix_structure_t cs_matrix_structure_t
Definition: cs_matrix.h:86
void cs_cdofb_vecteq_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 if required (...
Definition: cs_cdofb_vecteq.c:926
Definition: mesh.f90:26