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_restart.h"
50 #include "cs_source_term.h"
51 #include "cs_time_step.h"
52 
53 /*----------------------------------------------------------------------------*/
54 
55 BEGIN_C_DECLS
56 
57 /*============================================================================
58  * Macro definitions
59  *============================================================================*/
60 
61 /*============================================================================
62  * Type definitions
63  *============================================================================*/
64 
65 /* Algebraic system for CDO face-based discretization */
66 typedef struct _cs_cdofb_t cs_cdofb_vecteq_t;
67 
68 /*============================================================================
69  * Public function prototypes
70  *============================================================================*/
71 
72 /*----------------------------------------------------------------------------*/
88 /*----------------------------------------------------------------------------*/
89 
90 void
91 cs_cdofb_vecteq_init_cell_system(const cs_flag_t cell_flag,
92  const cs_cell_mesh_t *cm,
93  const cs_equation_param_t *eqp,
94  const cs_equation_builder_t *eqb,
95  const cs_cdofb_vecteq_t *eqc,
96  const cs_real_t dir_values[],
97  const short int neu_tags[],
98  const cs_real_t field_tn[],
99  cs_real_t t_eval,
100  cs_cell_sys_t *csys,
101  cs_cell_builder_t *cb);
102 
103 /*----------------------------------------------------------------------------*/
110 /*----------------------------------------------------------------------------*/
111 
112 bool
113 cs_cdofb_vecteq_is_initialized(void);
114 
115 /*----------------------------------------------------------------------------*/
126 /*----------------------------------------------------------------------------*/
127 
128 void
129 cs_cdofb_vecteq_init_common(const cs_cdo_quantities_t *quant,
130  const cs_cdo_connect_t *connect,
131  const cs_time_step_t *time_step,
132  const cs_matrix_structure_t *ms);
133 
134 /*----------------------------------------------------------------------------*/
140 /*----------------------------------------------------------------------------*/
141 
142 const cs_matrix_structure_t *
143 cs_cdofb_vecteq_matrix_structure(void);
144 
145 /*----------------------------------------------------------------------------*/
152 /*----------------------------------------------------------------------------*/
153 
154 void
155 cs_cdofb_vecteq_get(cs_cell_sys_t **csys,
156  cs_cell_builder_t **cb);
157 
158 /*----------------------------------------------------------------------------*/
163 /*----------------------------------------------------------------------------*/
164 
165 void
166 cs_cdofb_vecteq_finalize_common(void);
167 
168 /*----------------------------------------------------------------------------*/
180 /*----------------------------------------------------------------------------*/
181 
182 void *
183 cs_cdofb_vecteq_init_context(const cs_equation_param_t *eqp,
184  int var_id,
185  int bflux_id,
186  cs_equation_builder_t *eqb);
187 
188 /*----------------------------------------------------------------------------*/
196 /*----------------------------------------------------------------------------*/
197 
198 void *
199 cs_cdofb_vecteq_free_context(void *data);
200 
201 /*----------------------------------------------------------------------------*/
213 /*----------------------------------------------------------------------------*/
214 
215 void
216 cs_cdofb_vecteq_initialize_system(const cs_equation_param_t *eqp,
217  cs_equation_builder_t *eqb,
218  void *data,
219  cs_matrix_t **system_matrix,
220  cs_real_t **system_rhs);
221 
222 /*----------------------------------------------------------------------------*/
233 /*----------------------------------------------------------------------------*/
234 
235 void
236 cs_cdofb_vecteq_set_dir_bc(const cs_mesh_t *mesh,
237  const cs_equation_param_t *eqp,
238  cs_equation_builder_t *eqb,
239  cs_real_t t_eval,
240  cs_real_t field_val[]);
241 
242 /*----------------------------------------------------------------------------*/
257 /*----------------------------------------------------------------------------*/
258 
259 void
260 cs_cdofb_vecteq_build_system(const cs_mesh_t *mesh,
261  const cs_real_t *field_val,
262  double dt_cur,
263  const cs_equation_param_t *eqp,
264  cs_equation_builder_t *eqb,
265  void *data,
266  cs_real_t *rhs,
267  cs_matrix_t *matrix);
268 
269 /*----------------------------------------------------------------------------*/
281 /*----------------------------------------------------------------------------*/
282 
283 void
284 cs_cdofb_vecteq_update_field(const cs_real_t *solu,
285  const cs_real_t *rhs,
286  const cs_equation_param_t *eqp,
287  cs_equation_builder_t *eqb,
288  void *data,
289  cs_real_t *field_val);
290 
291 /*----------------------------------------------------------------------------*/
301 /*----------------------------------------------------------------------------*/
302 
303 void
304 cs_cdofb_vecteq_extra_op(const char *eqname,
305  const cs_field_t *field,
306  const cs_equation_param_t *eqp,
307  cs_equation_builder_t *eqb,
308  void *data);
309 
310 /*----------------------------------------------------------------------------*/
322 /*----------------------------------------------------------------------------*/
323 
324 cs_real_t *
325 cs_cdofb_vecteq_get_cell_values(void *context);
326 
327 /*----------------------------------------------------------------------------*/
337 /*----------------------------------------------------------------------------*/
338 
339 cs_real_t *
340 cs_cdofb_vecteq_get_face_values(void *context);
341 
342 /*----------------------------------------------------------------------------*/
351 /*----------------------------------------------------------------------------*/
352 
353 void
354 cs_cdofb_vecteq_read_restart(cs_restart_t *restart,
355  const char *eqname,
356  void *scheme_context);
357 
358 /*----------------------------------------------------------------------------*/
367 /*----------------------------------------------------------------------------*/
368 
369 void
370 cs_cdofb_vecteq_write_restart(cs_restart_t *restart,
371  const char *eqname,
372  void *scheme_context);
373 
374 /*----------------------------------------------------------------------------*/
375 
376 END_C_DECLS
377 
378 #endif /* __CS_CDOFB_VECTEQ_H__ */
cs_cdofb_vecteq_init_context
void * cs_cdofb_vecteq_init_context(const cs_equation_param_t *eqp, int var_id, int bflux_id, cs_equation_builder_t *eqb)
Initialize a cs_cdofb_vecteq_t structure storing data useful for building and managing such a scheme...
Definition: cs_cdofb_vecteq.c:432
cs_cdofb_vecteq_init_cell_system
void cs_cdofb_vecteq_init_cell_system(const cs_flag_t cell_flag, const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, const cs_equation_builder_t *eqb, const cs_cdofb_vecteq_t *eqc, const cs_real_t dir_values[], const short int neu_tags[], const cs_real_t field_tn[], cs_real_t t_eval, cs_cell_sys_t *csys, cs_cell_builder_t *cb)
Initialize the local structure for the current cell.
Definition: cs_cdofb_vecteq.c:171
cs_equation_builder_t
Store common elements used when building an algebraic system related to an equation.
Definition: cs_equation_common.h:63
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:51
cs_base.h
cs_restart.h
cs_field_t
Field descriptor.
Definition: cs_field.h:124
cs_equation_param_t
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources...
Definition: cs_equation_param.h:159
cs_cdo_connect.h
cs_cdofb_vecteq_write_restart
void cs_cdofb_vecteq_write_restart(cs_restart_t *restart, const char *eqname, void *scheme_context)
Write additional arrays (not defined as fields) but useful for the checkpoint/restart process...
Definition: cs_cdofb_vecteq.c:1177
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:462
cs_cdofb_vecteq_build_system
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 vector convection/diffusion equation with a CDO face-based sch...
Definition: cs_cdofb_vecteq.c:686
cs_cdofb_vecteq_free_context
void * cs_cdofb_vecteq_free_context(void *data)
Destroy a cs_cdofb_vecteq_t structure.
Definition: cs_cdofb_vecteq.c:568
cs_cell_mesh_t
Set of local quantities and connectivities related to a mesh cell This is a key structure for all cel...
Definition: cs_cdo_local.h:163
cs_cdofb_vecteq_matrix_structure
const cs_matrix_structure_t * cs_cdofb_vecteq_matrix_structure(void)
Get the pointer to the related cs_matrix_structure_t.
Definition: cs_cdofb_vecteq.c:359
cs_cdo_connect_t
Definition: cs_cdo_connect.h:74
field
Definition: field.f90:27
cs_matrix.h
cs_source_term.h
cs_cdofb_vecteq_is_initialized
bool cs_cdofb_vecteq_is_initialized(void)
Check if the generic structures for building a CDO-Fb scheme are allocated.
Definition: cs_cdofb_vecteq.c:272
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:94
cs_cdofb_vecteq_finalize_common
void cs_cdofb_vecteq_finalize_common(void)
Free work buffer and general structure related to CDO face-based schemes.
Definition: cs_cdofb_vecteq.c:396
matrix
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
cs_cell_sys_t
Set of arrays and local (small) dense matrices related to a mesh cell This is a key structure for bui...
Definition: cs_cdo_local.h:112
cs_cdofb_vecteq_read_restart
void cs_cdofb_vecteq_read_restart(cs_restart_t *restart, const char *eqname, void *scheme_context)
Read additional arrays (not defined as fields) but useful for the checkpoint/restart process...
Definition: cs_cdofb_vecteq.c:1096
cs_matrix_t
struct _cs_matrix_t cs_matrix_t
Definition: cs_matrix.h:90
cs_mesh_t
Definition: cs_mesh.h:63
cs_equation_common.h
cs_restart_t
struct _cs_restart_t cs_restart_t
Definition: cs_restart.h:86
cs_cdofb_vecteq_init_common
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:294
cs_cell_builder_t
Set of local and temporary buffers useful for building the algebraic system with a cellwise process...
Definition: cs_cdo_local.h:75
cs_cdo_quantities.h
cs_cdofb_vecteq_extra_op
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:998
cs_cdofb_vecteq_initialize_system
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:601
cs_field.h
cs_mesh.h
cs_time_step.h
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:463
cs_flag_t
unsigned short int cs_flag_t
Definition: cs_defs.h:299
cs_cdofb_vecteq_get
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:374
_cs_cdofb_t
Definition: cs_cdofb_priv.h:51
cs_cdofb_vecteq_get_face_values
cs_real_t * cs_cdofb_vecteq_get_face_values(void *context)
Retrieve an array of values at mesh faces for the current context. The lifecycle of this array is man...
Definition: cs_cdofb_vecteq.c:1074
cs_cdofb_vecteq_set_dir_bc
void cs_cdofb_vecteq_set_dir_bc(const cs_mesh_t *mesh, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, cs_real_t t_eval, cs_real_t field_val[])
Set the boundary conditions known from the settings when the fields stem from a vector CDO face-based...
Definition: cs_cdofb_vecteq.c:643
cs_equation_param.h
Structure and routines handling the specific settings related to a cs_equation_t structure.
cs_matrix_structure_t
struct _cs_matrix_structure_t cs_matrix_structure_t
Definition: cs_matrix.h:86
cs_cdofb_vecteq_update_field
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:958
mesh
Definition: mesh.f90:26
cs_cdofb_vecteq_get_cell_values
cs_real_t * cs_cdofb_vecteq_get_cell_values(void *context)
Get the computed values at mesh cells from the inverse operation w.r.t. the static condensation (DoF ...
Definition: cs_cdofb_vecteq.c:1053
Generated on Sat Feb 2 2019 15:43:25 by   doxygen 1.8.13