7.1
general documentation
cs_cdovb_vecteq.h
Go to the documentation of this file.
1 #ifndef __CS_CDOVB_VECTEQ_H__
2 #define __CS_CDOVB_VECTEQ_H__
3 
4 /*============================================================================
5  * Build an algebraic CDO vertex-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-2021 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_cdo_connect.h"
35 #include "cs_cdo_local.h"
36 #include "cs_cdo_quantities.h"
37 #include "cs_equation_common.h"
38 #include "cs_equation_param.h"
39 #include "cs_field.h"
40 #include "cs_matrix.h"
41 #include "cs_mesh.h"
42 #include "cs_source_term.h"
43 #include "cs_time_step.h"
44 
45 /*----------------------------------------------------------------------------*/
46 
47 BEGIN_C_DECLS
48 
49 /*============================================================================
50  * Macro definitions
51  *============================================================================*/
52 
53 /*============================================================================
54  * Type definitions
55  *============================================================================*/
56 
57 /*============================================================================
58  * Public function prototypes
59  *============================================================================*/
60 
61 /*----------------------------------------------------------------------------*/
68 /*----------------------------------------------------------------------------*/
69 
70 bool
71 cs_cdovb_vecteq_is_initialized(void);
72 
73 /*----------------------------------------------------------------------------*/
84 /*----------------------------------------------------------------------------*/
85 
86 void
87 cs_cdovb_vecteq_init_common(const cs_cdo_quantities_t *quant,
88  const cs_cdo_connect_t *connect,
89  const cs_time_step_t *time_step,
90  const cs_matrix_structure_t *ms);
91 
92 /*----------------------------------------------------------------------------*/
99 /*----------------------------------------------------------------------------*/
100 
101 void
102 cs_cdovb_vecteq_get(cs_cell_sys_t **csys,
103  cs_cell_builder_t **cb);
104 
105 /*----------------------------------------------------------------------------*/
110 /*----------------------------------------------------------------------------*/
111 
112 void
113 cs_cdovb_vecteq_finalize_common(void);
114 
115 /*----------------------------------------------------------------------------*/
127 /*----------------------------------------------------------------------------*/
128 
129 void *
130 cs_cdovb_vecteq_init_context(const cs_equation_param_t *eqp,
131  int var_id,
132  int bflux_id,
133  cs_equation_builder_t *eqb);
134 
135 /*----------------------------------------------------------------------------*/
143 /*----------------------------------------------------------------------------*/
144 
145 void *
146 cs_cdovb_vecteq_free_context(void *builder);
147 
148 /*----------------------------------------------------------------------------*/
161 /*----------------------------------------------------------------------------*/
162 
163 void
164 cs_cdovb_vecteq_init_values(cs_real_t t_eval,
165  const int field_id,
166  const cs_mesh_t *mesh,
167  const cs_equation_param_t *eqp,
168  cs_equation_builder_t *eqb,
169  void *context);
170 
171 /*----------------------------------------------------------------------------*/
184 /*----------------------------------------------------------------------------*/
185 
186 void
187 cs_cdovb_vecteq_solve_steady_state(bool cur2prev,
188  const cs_mesh_t *mesh,
189  const int field_id,
190  const cs_equation_param_t *eqp,
191  cs_equation_builder_t *eqb,
192  void *context);
193 
194 /*----------------------------------------------------------------------------*/
206 /*----------------------------------------------------------------------------*/
207 
208 void
209 cs_cdovb_vecteq_update_field(const cs_real_t *solu,
210  const cs_real_t *rhs,
211  const cs_equation_param_t *eqp,
212  cs_equation_builder_t *eqb,
213  void *data,
214  cs_real_t *field_val);
215 
216 /*----------------------------------------------------------------------------*/
228 /*----------------------------------------------------------------------------*/
229 
230 cs_real_t *
231 cs_cdovb_vecteq_get_vertex_values(void *context,
232  bool previous);
233 
234 /*----------------------------------------------------------------------------*/
247 /*----------------------------------------------------------------------------*/
248 
249 cs_real_t *
250 cs_cdovb_vecteq_get_cell_values(void *context,
251  bool previous);
252 
253 /*----------------------------------------------------------------------------*/
262 /*----------------------------------------------------------------------------*/
263 
264 void
265 cs_cdovb_vecteq_current_to_previous(const cs_equation_param_t *eqp,
266  cs_equation_builder_t *eqb,
267  void *context);
268 
269 /*----------------------------------------------------------------------------*/
277 /*----------------------------------------------------------------------------*/
278 
279 void
280 cs_cdovb_vecteq_extra_post(const cs_equation_param_t *eqp,
281  cs_equation_builder_t *eqb,
282  void *context);
283 
284 /*----------------------------------------------------------------------------*/
285 
286 END_C_DECLS
287 
288 #endif /* __CS_CDOVB_VECTEQ_H__ */
cs_equation_builder_t
Store common elements used when building an algebraic system related to an equation.
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:64
cs_base.h
cs_cdovb_vecteq_get_vertex_values
cs_real_t * cs_cdovb_vecteq_get_vertex_values(void *context, bool previous)
Retrieve an array of values at mesh vertices for the variable field associated to the given context T...
Definition: cs_cdovb_vecteq.c:1531
cs_equation_param_t
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources...
Definition: cs_equation_param.h:177
cs_cdovb_vecteq_init_context
void * cs_cdovb_vecteq_init_context(const cs_equation_param_t *eqp, int var_id, int bflux_id, cs_equation_builder_t *eqb)
Initialize a cs_cdovb_vecteq_t structure storing data useful for building and managing such a scheme...
Definition: cs_cdovb_vecteq.c:796
cs_cdovb_vecteq_is_initialized
bool cs_cdovb_vecteq_is_initialized(void)
Check if the generic structures for building a CDO-Vb scheme are allocated.
Definition: cs_cdovb_vecteq.c:652
cs_cdo_connect.h
cs_cdovb_vecteq_get_cell_values
cs_real_t * cs_cdovb_vecteq_get_cell_values(void *context, bool previous)
Compute an array of values at mesh cells by interpolating the variable field associated to the given ...
Definition: cs_cdovb_vecteq.c:1563
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:510
cs_cdovb_vecteq_finalize_common
void cs_cdovb_vecteq_finalize_common(void)
Free work buffer and general structure related to CDO vertex-based schemes.
Definition: cs_cdovb_vecteq.c:760
cs_cdo_connect_t
Definition: cs_cdo_connect.h:79
cs_matrix.h
cs_source_term.h
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:322
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:129
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:146
cs_cdovb_vecteq_current_to_previous
void cs_cdovb_vecteq_current_to_previous(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context)
Operate a current to previous operation for the field associated to this equation and potentially for...
Definition: cs_cdovb_vecteq.c:1610
cs_mesh_t
Definition: cs_mesh.h:84
cs_cdovb_vecteq_update_field
void cs_cdovb_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_cdovb_vecteq.c:1493
cs_equation_common.h
cs_cdovb_vecteq_init_common
void cs_cdovb_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 vertex-based schemes Set sha...
Definition: cs_cdovb_vecteq.c:674
cs_cdovb_vecteq_extra_post
void cs_cdovb_vecteq_extra_post(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context)
Predefined extra-operations related to this equation.
Definition: cs_cdovb_vecteq.c:1634
cs_cell_builder_t
Set of local and temporary buffers.
Definition: cs_cdo_local.h:60
cs_cdo_quantities.h
atincl::solu
double precision, dimension(:,:), allocatable solu
Definition: atincl.f90:321
cs_field.h
cs_mesh.h
cs_time_step.h
cs_cdo_local.h
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:511
cs_cdovb_vecteq_free_context
void * cs_cdovb_vecteq_free_context(void *builder)
Destroy a cs_cdovb_vecteq_t structure.
Definition: cs_cdovb_vecteq.c:1112
cs_cdovb_vecteq_get
void cs_cdovb_vecteq_get(cs_cell_sys_t **csys, cs_cell_builder_t **cb)
Retrieve work buffers used for building a CDO system cellwise.
Definition: cs_cdovb_vecteq.c:738
cs_cdovb_vecteq_init_values
void cs_cdovb_vecteq_init_values(cs_real_t t_eval, const int field_id, const cs_mesh_t *mesh, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context)
Set the initial values of the variable field taking into account the boundary conditions. Case of vector-valued CDO-Vb schemes.
Definition: cs_cdovb_vecteq.c:1149
cs_cdovb_vecteq_solve_steady_state
void cs_cdovb_vecteq_solve_steady_state(bool cur2prev, const cs_mesh_t *mesh, const int field_id, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context)
Build and solve the linear system arising from a vector steady-state convection/diffusion/reaction eq...
Definition: cs_cdovb_vecteq.c:1262
cs_equation_param.h
cs_matrix_structure_t
struct _cs_matrix_structure_t cs_matrix_structure_t
Definition: cs_matrix.h:89
mesh
Definition: mesh.f90:26