8.3
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-2024 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_builder.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
47BEGIN_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
70bool
71cs_cdovb_vecteq_is_initialized(void);
72
73/*----------------------------------------------------------------------------*/
83/*----------------------------------------------------------------------------*/
84
85void
86cs_cdovb_vecteq_init_sharing(const cs_cdo_quantities_t *quant,
87 const cs_cdo_connect_t *connect,
88 const cs_time_step_t *time_step);
89
90/*----------------------------------------------------------------------------*/
97/*----------------------------------------------------------------------------*/
98
99void
100cs_cdovb_vecteq_get(cs_cell_sys_t **csys,
101 cs_cell_builder_t **cb);
102
103/*----------------------------------------------------------------------------*/
108/*----------------------------------------------------------------------------*/
109
110void
111cs_cdovb_vecteq_finalize_sharing(void);
112
113/*----------------------------------------------------------------------------*/
125/*----------------------------------------------------------------------------*/
126
127void *
128cs_cdovb_vecteq_init_context(cs_equation_param_t *eqp,
129 int var_id,
130 int bflux_id,
131 cs_equation_builder_t *eqb);
132
133/*----------------------------------------------------------------------------*/
141/*----------------------------------------------------------------------------*/
142
143void *
144cs_cdovb_vecteq_free_context(void *builder);
145
146/*----------------------------------------------------------------------------*/
159/*----------------------------------------------------------------------------*/
160
161void
162cs_cdovb_vecteq_init_values(cs_real_t t_eval,
163 const int field_id,
164 const cs_mesh_t *mesh,
165 const cs_equation_param_t *eqp,
166 cs_equation_builder_t *eqb,
167 void *context);
168
169/*----------------------------------------------------------------------------*/
182/*----------------------------------------------------------------------------*/
183
184void
185cs_cdovb_vecteq_solve_steady_state(bool cur2prev,
186 const cs_mesh_t *mesh,
187 const int field_id,
188 const cs_equation_param_t *eqp,
189 cs_equation_builder_t *eqb,
190 void *context);
191
192/*----------------------------------------------------------------------------*/
204/*----------------------------------------------------------------------------*/
205
206void
207cs_cdovb_vecteq_update_field(const cs_real_t *solu,
208 const cs_real_t *rhs,
209 const cs_equation_param_t *eqp,
210 cs_equation_builder_t *eqb,
211 void *data,
212 cs_real_t *field_val);
213
214/*----------------------------------------------------------------------------*/
226/*----------------------------------------------------------------------------*/
227
228cs_real_t *
229cs_cdovb_vecteq_get_vertex_values(void *context,
230 bool previous);
231
232/*----------------------------------------------------------------------------*/
245/*----------------------------------------------------------------------------*/
246
247cs_real_t *
248cs_cdovb_vecteq_get_cell_values(void *context,
249 bool previous);
250
251/*----------------------------------------------------------------------------*/
260/*----------------------------------------------------------------------------*/
261
262void
263cs_cdovb_vecteq_current_to_previous(const cs_equation_param_t *eqp,
264 cs_equation_builder_t *eqb,
265 void *context);
266
267/*----------------------------------------------------------------------------*/
275/*----------------------------------------------------------------------------*/
276
277void
278cs_cdovb_vecteq_extra_post(const cs_equation_param_t *eqp,
279 cs_equation_builder_t *eqb,
280 void *context);
281
282/*----------------------------------------------------------------------------*/
283
284END_C_DECLS
285
286#endif /* __CS_CDOVB_VECTEQ_H__ */
cs_base.h
cs_cdo_connect.h
cs_cdo_local.h
cs_cdo_quantities.h
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.cpp:1337
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.cpp:699
cs_cdovb_vecteq_finalize_sharing
void cs_cdovb_vecteq_finalize_sharing(void)
Free work buffer and general structure related to CDO vertex-based schemes.
Definition: cs_cdovb_vecteq.cpp:799
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....
Definition: cs_cdovb_vecteq.cpp:1222
cs_cdovb_vecteq_init_sharing
void cs_cdovb_vecteq_init_sharing(const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect, const cs_time_step_t *time_step)
Allocate work buffer and general structures related to CDO vector-valued vertex-based schemes Set sha...
Definition: cs_cdovb_vecteq.cpp:720
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.cpp:782
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.cpp:1568
cs_cdovb_vecteq_free_context
void * cs_cdovb_vecteq_free_context(void *builder)
Destroy a cs_cdovb_vecteq_t structure.
Definition: cs_cdovb_vecteq.cpp:1185
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.cpp:1709
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.cpp:1685
cs_cdovb_vecteq_init_context
void * cs_cdovb_vecteq_init_context(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.cpp:835
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.cpp:1606
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.cpp:1638
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543
cs_equation_builder.h
cs_equation_param.h
cs_field.h
cs_matrix.h
cs_mesh.h
cs_source_term.h
cs_time_step.h
atincl::solu
double precision, dimension(:,:), pointer solu
Definition: atincl.f90:308
mesh
Definition: mesh.f90:26
cs_cdo_connect_t
Definition: cs_cdo_connect.h:61
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:139
cs_cell_builder_t
Set of local and temporary buffers.
Definition: cs_cdo_local.h:60
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:147
cs_equation_builder_t
Store common elements used when building an algebraic system related to an equation.
cs_equation_param_t
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources.
Definition: cs_equation_param.h:192
cs_mesh_t
Definition: cs_mesh.h:85
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:64