My Project
programmer's documentation
Loading...
Searching...
No Matches
cs_cdovcb_scaleq.h
Go to the documentation of this file.
1#ifndef __CS_CDOVCB_SCALEQ_H__
2#define __CS_CDOVCB_SCALEQ_H__
3
4/*============================================================================
5 * Build an algebraic CDO vertex+cell-based system for unsteady convection
6 * diffusion reaction of scalar-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-2019 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_equation_common.h"
37#include "cs_equation_param.h"
38#include "cs_field.h"
39#include "cs_cdo_connect.h"
40#include "cs_cdo_quantities.h"
41#include "cs_equation_param.h"
42#include "cs_restart.h"
43#include "cs_source_term.h"
44
45/*----------------------------------------------------------------------------*/
46
47BEGIN_C_DECLS
48
49/*============================================================================
50 * Macro definitions
51 *============================================================================*/
52
53/*============================================================================
54 * Public function prototypes
55 *============================================================================*/
56
57/*----------------------------------------------------------------------------*/
64/*----------------------------------------------------------------------------*/
65
66bool
67cs_cdovcb_scaleq_is_initialized(void);
68
69/*----------------------------------------------------------------------------*/
80/*----------------------------------------------------------------------------*/
81
82void
83cs_cdovcb_scaleq_init_common(const cs_cdo_quantities_t *quant,
84 const cs_cdo_connect_t *connect,
85 const cs_time_step_t *time_step,
86 const cs_matrix_structure_t *ms);
87
88/*----------------------------------------------------------------------------*/
95/*----------------------------------------------------------------------------*/
96
97void
98cs_cdovcb_scaleq_get(cs_cell_sys_t **csys,
99 cs_cell_builder_t **cb);
100
101/*----------------------------------------------------------------------------*/
106/*----------------------------------------------------------------------------*/
107
108void
109cs_cdovcb_scaleq_finalize_common(void);
110
111/*----------------------------------------------------------------------------*/
123/*----------------------------------------------------------------------------*/
124
125void *
126cs_cdovcb_scaleq_init_context(const cs_equation_param_t *eqp,
127 int var_id,
128 int bflux_id,
129 cs_equation_builder_t *eqb);
130
131/*----------------------------------------------------------------------------*/
139/*----------------------------------------------------------------------------*/
140
141void *
142cs_cdovcb_scaleq_free_context(void *data);
143
144/*----------------------------------------------------------------------------*/
157/*----------------------------------------------------------------------------*/
158
159void
160cs_cdovcb_scaleq_init_values(cs_real_t t_eval,
161 const int field_id,
162 const cs_mesh_t *mesh,
163 const cs_equation_param_t *eqp,
164 cs_equation_builder_t *eqb,
165 void *context);
166
167/*----------------------------------------------------------------------------*/
179/*----------------------------------------------------------------------------*/
180
181void
182cs_cdovcb_scaleq_solve_steady_state(const cs_mesh_t *mesh,
183 const int field_id,
184 const cs_equation_param_t *eqp,
185 cs_equation_builder_t *eqb,
186 void *context);
187
188/*----------------------------------------------------------------------------*/
201/*----------------------------------------------------------------------------*/
202
203void
204cs_cdovcb_scaleq_solve_implicit(const cs_mesh_t *mesh,
205 const int field_id,
206 const cs_equation_param_t *eqp,
207 cs_equation_builder_t *eqb,
208 void *context);
209
210/*----------------------------------------------------------------------------*/
223/*----------------------------------------------------------------------------*/
224
225void
226cs_cdovcb_scaleq_solve_theta(const cs_mesh_t *mesh,
227 const int field_id,
228 const cs_equation_param_t *eqp,
229 cs_equation_builder_t *eqb,
230 void *context);
231
232/*----------------------------------------------------------------------------*/
243/*----------------------------------------------------------------------------*/
244
245cs_real_t *
246cs_cdovcb_scaleq_get_vertex_values(void *context);
247
248/*----------------------------------------------------------------------------*/
261/*----------------------------------------------------------------------------*/
262
263cs_real_t *
264cs_cdovcb_scaleq_get_cell_values(void *context);
265
266/*----------------------------------------------------------------------------*/
281/*----------------------------------------------------------------------------*/
282
283void
284cs_cdovcb_scaleq_boundary_diff_flux(const cs_real_t t_eval,
285 const cs_equation_param_t *eqp,
286 const cs_real_t *pot_v,
287 const cs_real_t *pot_c,
288 cs_equation_builder_t *eqb,
289 cs_real_t *vf_flux);
290
291/*----------------------------------------------------------------------------*/
305/*----------------------------------------------------------------------------*/
306
307void
308cs_cdovcb_scaleq_flux_across_plane(const cs_real_t normal[],
309 const cs_real_t *pdi,
310 const cs_equation_param_t *eqp,
311 int ml_id,
312 cs_equation_builder_t *eqb,
313 void *context,
314 double *d_flux,
315 double *c_flux);
316
317/*----------------------------------------------------------------------------*/
329/*----------------------------------------------------------------------------*/
330
331void
332cs_cdovcb_scaleq_diff_flux_in_cells(const cs_real_t *values,
333 const cs_equation_param_t *eqp,
334 cs_real_t t_eval,
335 cs_equation_builder_t *eqb,
336 void *context,
337 cs_real_t *diff_flux);
338
339/*----------------------------------------------------------------------------*/
351/*----------------------------------------------------------------------------*/
352
353void
354cs_cdovcb_scaleq_diff_flux_dfaces(const cs_real_t *values,
355 const cs_equation_param_t *eqp,
356 cs_real_t t_eval,
357 cs_equation_builder_t *eqb,
358 void *context,
359 cs_real_t *diff_flux);
360
361/*----------------------------------------------------------------------------*/
370/*----------------------------------------------------------------------------*/
371
372void
373cs_cdovcb_scaleq_vtx_gradient(const cs_real_t *v_values,
374 cs_equation_builder_t *eqb,
375 void *context,
376 cs_real_t *v_gradient);
377
378/*----------------------------------------------------------------------------*/
387/*----------------------------------------------------------------------------*/
388
389void
390cs_cdovcb_scaleq_read_restart(cs_restart_t *restart,
391 const char *eqname,
392 void *scheme_context);
393
394/*----------------------------------------------------------------------------*/
403/*----------------------------------------------------------------------------*/
404
405void
406cs_cdovcb_scaleq_write_restart(cs_restart_t *restart,
407 const char *eqname,
408 void *scheme_context);
409
410/*----------------------------------------------------------------------------*/
420/*----------------------------------------------------------------------------*/
421
422void
423cs_cdovcb_scaleq_extra_op(const char *eqname,
424 const cs_field_t *field,
425 const cs_equation_param_t *eqp,
426 cs_equation_builder_t *eqb,
427 void *context);
428
429/*----------------------------------------------------------------------------*/
430
431END_C_DECLS
432
433#endif /* __CS_CDOVCB_SCALEQ_H__ */
cs_base.h
cs_cdo_connect.h
cs_cdo_quantities.h
cs_cdovcb_scaleq_get_vertex_values
cs_real_t * cs_cdovcb_scaleq_get_vertex_values(void *context)
Retrieve an array of values at mesh vertices for the variable field associated to the given context T...
Definition cs_cdovcb_scaleq.c:2073
cs_cdovcb_scaleq_write_restart
void cs_cdovcb_scaleq_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_cdovcb_scaleq.c:2850
cs_cdovcb_scaleq_solve_theta
void cs_cdovcb_scaleq_solve_theta(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 scalar unsteady convection/diffusion/reaction equati...
Definition cs_cdovcb_scaleq.c:1736
cs_cdovcb_scaleq_is_initialized
bool cs_cdovcb_scaleq_is_initialized(void)
Check if the generic structures for building a CDO-vertex+cell based scheme are allocated.
Definition cs_cdovcb_scaleq.c:782
cs_cdovcb_scaleq_vtx_gradient
void cs_cdovcb_scaleq_vtx_gradient(const cs_real_t *v_values, cs_equation_builder_t *eqb, void *context, cs_real_t *v_gradient)
Cellwise computation of the discrete gradient at vertices.
Definition cs_cdovcb_scaleq.c:2680
cs_cdovcb_scaleq_get_cell_values
cs_real_t * cs_cdovcb_scaleq_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_cdovcb_scaleq.c:2097
cs_cdovcb_scaleq_init_values
void cs_cdovcb_scaleq_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....
Definition cs_cdovcb_scaleq.c:1170
cs_cdovcb_scaleq_extra_op
void cs_cdovcb_scaleq_extra_op(const char *eqname, const cs_field_t *field, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context)
Predefined extra-operations related to this equation.
Definition cs_cdovcb_scaleq.c:2891
cs_cdovcb_scaleq_init_common
void cs_cdovcb_scaleq_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 vertex+cell-based schemes Set shared point...
Definition cs_cdovcb_scaleq.c:804
cs_cdovcb_scaleq_flux_across_plane
void cs_cdovcb_scaleq_flux_across_plane(const cs_real_t normal[], const cs_real_t *pdi, const cs_equation_param_t *eqp, int ml_id, cs_equation_builder_t *eqb, void *context, double *d_flux, double *c_flux)
Compute the diffusive and convective flux across a list of faces Case of scalar-valued CDO-Vcb scheme...
Definition cs_cdovcb_scaleq.c:2317
cs_cdovcb_scaleq_solve_implicit
void cs_cdovcb_scaleq_solve_implicit(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 scalar unsteady convection/diffusion/reaction equati...
Definition cs_cdovcb_scaleq.c:1477
cs_cdovcb_scaleq_init_context
void * cs_cdovcb_scaleq_init_context(const cs_equation_param_t *eqp, int var_id, int bflux_id, cs_equation_builder_t *eqb)
Initialize a cs_cdovcb_scaleq_t structure storing data useful for building and managing such a scheme...
Definition cs_cdovcb_scaleq.c:912
cs_cdovcb_scaleq_free_context
void * cs_cdovcb_scaleq_free_context(void *data)
Destroy a cs_cdovcb_scaleq_t structure.
Definition cs_cdovcb_scaleq.c:1134
cs_cdovcb_scaleq_finalize_common
void cs_cdovcb_scaleq_finalize_common(void)
Free buffers and generic structures related to CDO vertex+cell-based schemes.
Definition cs_cdovcb_scaleq.c:876
cs_cdovcb_scaleq_diff_flux_in_cells
void cs_cdovcb_scaleq_diff_flux_in_cells(const cs_real_t *values, const cs_equation_param_t *eqp, cs_real_t t_eval, cs_equation_builder_t *eqb, void *context, cs_real_t *diff_flux)
Cellwise computation of the diffusive flux in each cells. Case of scalar-valued CDO-VCb schemes.
Definition cs_cdovcb_scaleq.c:2499
cs_cdovcb_scaleq_boundary_diff_flux
void cs_cdovcb_scaleq_boundary_diff_flux(const cs_real_t t_eval, const cs_equation_param_t *eqp, const cs_real_t *pot_v, const cs_real_t *pot_c, cs_equation_builder_t *eqb, cs_real_t *vf_flux)
Compute for each vertex of a boundary face, the portion of diffusive flux across the boundary face....
Definition cs_cdovcb_scaleq.c:2125
cs_cdovcb_scaleq_diff_flux_dfaces
void cs_cdovcb_scaleq_diff_flux_dfaces(const cs_real_t *values, const cs_equation_param_t *eqp, cs_real_t t_eval, cs_equation_builder_t *eqb, void *context, cs_real_t *diff_flux)
Cellwise computation of the diffusive flux across dual faces Case of scalar-valued CDO-VCb schemes.
Definition cs_cdovcb_scaleq.c:2591
cs_cdovcb_scaleq_solve_steady_state
void cs_cdovcb_scaleq_solve_steady_state(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 scalar steady-state convection/diffusion/reaction eq...
Definition cs_cdovcb_scaleq.c:1273
cs_cdovcb_scaleq_get
void cs_cdovcb_scaleq_get(cs_cell_sys_t **csys, cs_cell_builder_t **cb)
Retrieve work buffers used for building a CDO system cellwise.
Definition cs_cdovcb_scaleq.c:854
cs_cdovcb_scaleq_read_restart
void cs_cdovcb_scaleq_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_cdovcb_scaleq.c:2800
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition cs_defs.h:467
cs_real_t
double cs_real_t
Floating-point value.
Definition cs_defs.h:302
END_C_DECLS
#define END_C_DECLS
Definition cs_defs.h:468
cs_equation_common.h
cs_equation_param.h
Structure and routines handling the specific settings related to a cs_equation_t structure.
cs_field.h
cs_matrix_structure_t
struct _cs_matrix_structure_t cs_matrix_structure_t
Definition cs_matrix.h:86
cs_mesh.h
cs_restart.h
cs_restart_t
struct _cs_restart_t cs_restart_t
Definition cs_restart.h:87
cs_source_term.h
cs_time_step.h
field
Definition field.f90:27
mesh
Definition mesh.f90:26
cs_cdo_connect_t
Definition cs_cdo_connect.h:74
cs_cdo_quantities_t
Definition cs_cdo_quantities.h:94
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:56
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:93
cs_equation_builder_t
Store common elements used when building an algebraic system related to an equation.
Definition cs_equation_common.h:61
cs_equation_param_t
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources.
Definition cs_equation_param.h:148
cs_field_t
Field descriptor.
Definition cs_field.h:124
cs_mesh_t
Definition cs_mesh.h:63
cs_time_step_t
time step descriptor
Definition cs_time_step.h:51
Generated on Mon Apr 1 2024 05:38:54 for My Project by doxygen 1.9.8