9.2
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-2026 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 "alge/cs_matrix.h"
34#include "base/cs_base.h"
35#include "base/cs_field.h"
36#include "base/cs_time_step.h"
37#include "cdo/cs_cdo_connect.h"
38#include "cdo/cs_cdo_local.h"
39#include "cdo/cs_cdo_quantities.h"
40#include "cdo/cs_equation_builder.h"
41#include "cdo/cs_equation_param.h"
42#include "cdo/cs_source_term.h"
43#include "mesh/cs_mesh.h"
44
45/*============================================================================
46 * Macro definitions
47 *============================================================================*/
48
49/*============================================================================
50 * Type definitions
51 *============================================================================*/
52
53/*============================================================================
54 * Public function prototypes
55 *============================================================================*/
56
57/*----------------------------------------------------------------------------*/
64/*----------------------------------------------------------------------------*/
65
66bool
67cs_cdovb_vecteq_is_initialized(void);
68
69/*----------------------------------------------------------------------------*/
79/*----------------------------------------------------------------------------*/
80
81void
82cs_cdovb_vecteq_init_sharing(const cs_cdo_quantities_t *quant,
83 const cs_cdo_connect_t *connect,
84 const cs_time_step_t *time_step);
85
86/*----------------------------------------------------------------------------*/
93/*----------------------------------------------------------------------------*/
94
95void
96cs_cdovb_vecteq_get(cs_cell_sys_t **csys,
97 cs_cell_builder_t **cb);
98
99/*----------------------------------------------------------------------------*/
104/*----------------------------------------------------------------------------*/
105
106void
107cs_cdovb_vecteq_finalize_sharing(void);
108
109/*----------------------------------------------------------------------------*/
121/*----------------------------------------------------------------------------*/
122
123void *
124cs_cdovb_vecteq_init_context(cs_equation_param_t *eqp,
125 int var_id,
126 int bflux_id,
127 cs_equation_builder_t *eqb);
128
129/*----------------------------------------------------------------------------*/
137/*----------------------------------------------------------------------------*/
138
139void *
140cs_cdovb_vecteq_free_context(void *builder);
141
142/*----------------------------------------------------------------------------*/
155/*----------------------------------------------------------------------------*/
156
157void
158cs_cdovb_vecteq_init_values(cs_real_t t_eval,
159 const int field_id,
160 const cs_mesh_t *mesh,
161 const cs_equation_param_t *eqp,
162 cs_equation_builder_t *eqb,
163 void *context);
164
165/*----------------------------------------------------------------------------*/
178/*----------------------------------------------------------------------------*/
179
180void
181cs_cdovb_vecteq_solve_steady_state(bool cur2prev,
182 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/*----------------------------------------------------------------------------*/
200/*----------------------------------------------------------------------------*/
201
202void
203cs_cdovb_vecteq_update_field(const cs_real_t *solu,
204 const cs_real_t *rhs,
205 const cs_equation_param_t *eqp,
206 cs_equation_builder_t *eqb,
207 void *data,
208 cs_real_t *field_val);
209
210/*----------------------------------------------------------------------------*/
222/*----------------------------------------------------------------------------*/
223
224cs_real_t *
225cs_cdovb_vecteq_get_vertex_values(void *context,
226 bool previous);
227
228/*----------------------------------------------------------------------------*/
241/*----------------------------------------------------------------------------*/
242
243cs_real_t *
244cs_cdovb_vecteq_get_cell_values(void *context,
245 bool previous);
246
247/*----------------------------------------------------------------------------*/
256/*----------------------------------------------------------------------------*/
257
258void
259cs_cdovb_vecteq_current_to_previous(const cs_equation_param_t *eqp,
260 cs_equation_builder_t *eqb,
261 void *context);
262
263/*----------------------------------------------------------------------------*/
271/*----------------------------------------------------------------------------*/
272
273void
274cs_cdovb_vecteq_extra_post(const cs_equation_param_t *eqp,
275 cs_equation_builder_t *eqb,
276 void *context);
277
278#endif /* CS_CDOVB_VECTEQ_H */
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:60
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:1329
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:691
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:791
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:1210
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:712
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:774
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:1555
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:1173
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:1694
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:1670
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:827
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:1593
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:1624
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:332
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:260
mesh
Definition: mesh.f90:26
cs_cdo_connect_t
Definition: cs_cdo_connect.h:57
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:142
cs_cell_builder_t
Set of local and temporary buffers.
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:163
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:190
cs_mesh_t
Definition: cs_mesh.h:85