9.1
general documentation
cs_equation.h
Go to the documentation of this file.
1#ifndef __CS_EQUATION_H__
2#define __CS_EQUATION_H__
3
4/*============================================================================
5 * Functions to handle the cs_equation_t structure and its related structures
6 *============================================================================*/
7
8/*
9 This file is part of code_saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2025 EDF S.A.
12
13 This program is free software; you can redistribute it and/or modify it under
14 the terms of the GNU General Public License as published by the Free Software
15 Foundation; either version 2 of the License, or (at your option) any later
16 version.
17
18 This program is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21 details.
22
23 You should have received a copy of the GNU General Public License along with
24 this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
25 Street, Fifth Floor, Boston, MA 02110-1301, USA.
26*/
27
28/*----------------------------------------------------------------------------
29 * Local headers
30 *----------------------------------------------------------------------------*/
31
32#include "cdo/cs_cdo_connect.h"
33#include "cdo/cs_cdo_quantities.h"
34#include "cdo/cs_cdo_toolbox.h"
35#include "cdo/cs_equation_builder.h"
36#include "cdo/cs_equation_param.h"
37#include "base/cs_field.h"
38#include "mesh/cs_mesh.h"
39#include "base/cs_restart.h"
40#include "base/cs_time_step.h"
41
42/*----------------------------------------------------------------------------*/
43
44BEGIN_C_DECLS
45
46/*============================================================================
47 * Macro definitions
48 *============================================================================*/
49
50/*============================================================================
51 * Type definitions
52 *============================================================================*/
53
54typedef struct _cs_equation_t cs_equation_t;
55
82typedef struct {
83
84 cs_equation_param_t *param;
85 cs_equation_builder_t *builder;
86 void *scheme_context;
87
88} cs_equation_core_t;
89
90/*============================================================================
91 * Public function prototypes
92 *============================================================================*/
93
94/*----------------------------------------------------------------------------*/
100/*----------------------------------------------------------------------------*/
101
102int
103cs_equation_get_n_equations(void);
104
105/*----------------------------------------------------------------------------*/
114/*----------------------------------------------------------------------------*/
115
116cs_equation_t *
117cs_equation_by_name(const char *eqname);
118
119/*----------------------------------------------------------------------------*/
128/*----------------------------------------------------------------------------*/
129
130cs_equation_t *
131cs_equation_by_field_name(const char *field_name);
132
133/*----------------------------------------------------------------------------*/
144/*----------------------------------------------------------------------------*/
145
146bool
147cs_equation_has_field_name(const cs_equation_t *eq,
148 const char *fld_name);
149
150/*----------------------------------------------------------------------------*/
163/*----------------------------------------------------------------------------*/
164
165cs_equation_param_t *
166cs_equation_param_by_name(const char *eqname);
167
168/*----------------------------------------------------------------------------*/
178/*----------------------------------------------------------------------------*/
179
180cs_equation_param_t *
181cs_equation_param_by_field_name(const char *field_name);
182
183/*----------------------------------------------------------------------------*/
192/*----------------------------------------------------------------------------*/
193
194cs_equation_param_t *
195cs_equation_get_param(const cs_equation_t *eq);
196
197/*----------------------------------------------------------------------------*/
206/*----------------------------------------------------------------------------*/
207
208cs_equation_t *
209cs_equation_by_id(int eq_id);
210
211/*----------------------------------------------------------------------------*/
219/*----------------------------------------------------------------------------*/
220
221const char *
222cs_equation_get_name(const cs_equation_t *eq);
223
224/*----------------------------------------------------------------------------*/
232/*----------------------------------------------------------------------------*/
233
234int
235cs_equation_get_id(const cs_equation_t *eq);
236
237/*----------------------------------------------------------------------------*/
245/*----------------------------------------------------------------------------*/
246
247cs_field_t *
248cs_equation_get_field(const cs_equation_t *eq);
249
250/*----------------------------------------------------------------------------*/
259/*----------------------------------------------------------------------------*/
260
261int
262cs_equation_get_field_id(const cs_equation_t *eq);
263
264/*----------------------------------------------------------------------------*/
273/*----------------------------------------------------------------------------*/
274
275const char *
276cs_equation_get_field_name(const cs_equation_t *eq);
277
278/*----------------------------------------------------------------------------*/
289/*----------------------------------------------------------------------------*/
290
291const cs_range_set_t *
292cs_equation_get_range_set(const cs_equation_t *eq);
293
294/*----------------------------------------------------------------------------*/
304/*----------------------------------------------------------------------------*/
305
306cs_gnum_t
307cs_equation_get_global_n_dofs(const cs_equation_t *eq,
308 const cs_cdo_quantities_t *cdoq);
309
310/*----------------------------------------------------------------------------*/
319/*----------------------------------------------------------------------------*/
320
321cs_field_t *
322cs_equation_get_boundary_flux(const cs_equation_t *eq);
323
324/*----------------------------------------------------------------------------*/
332/*----------------------------------------------------------------------------*/
333
334cs_flag_t
335cs_equation_get_flag(const cs_equation_t *eq);
336
337/*----------------------------------------------------------------------------*/
344/*----------------------------------------------------------------------------*/
345
346void
347cs_equation_set_flag(cs_equation_t *eq,
348 cs_flag_t flag);
349
350/*----------------------------------------------------------------------------*/
361/*----------------------------------------------------------------------------*/
362
363void
364cs_equation_add_build_hook(cs_equation_t *eq,
365 void *context,
366 cs_equation_build_hook_t *func);
367
368/*----------------------------------------------------------------------------*/
377/*----------------------------------------------------------------------------*/
378
379cs_equation_builder_t *
380cs_equation_get_builder(const cs_equation_t *eq);
381
382/*----------------------------------------------------------------------------*/
391/*----------------------------------------------------------------------------*/
392
393void *
394cs_equation_get_scheme_context(const cs_equation_t *eq);
395
396/*----------------------------------------------------------------------------*/
405/*----------------------------------------------------------------------------*/
406
407cs_equation_core_t
408cs_equation_get_core_structure(const cs_equation_t *eq);
409
410/*----------------------------------------------------------------------------*/
420/*----------------------------------------------------------------------------*/
421
422cs_real_t *
423cs_equation_get_source_term_array(const cs_equation_t *eq);
424
425/*----------------------------------------------------------------------------*/
433/*----------------------------------------------------------------------------*/
434
435bool
436cs_equation_is_steady(const cs_equation_t *eq);
437
438/*----------------------------------------------------------------------------*/
448/*----------------------------------------------------------------------------*/
449
450bool
451cs_equation_uses_new_mechanism(const cs_equation_t *eq);
452
453/*----------------------------------------------------------------------------*/
465/*----------------------------------------------------------------------------*/
466
467cs_equation_t *
468cs_equation_add(const char *eqname,
469 const char *varname,
470 cs_equation_type_t eqtype,
471 int dim,
472 cs_param_bc_type_t default_bc);
473
474/*----------------------------------------------------------------------------*/
485/*----------------------------------------------------------------------------*/
486
487cs_equation_t *
488cs_equation_add_user(const char *eqname,
489 const char *varname,
490 int dim,
491 cs_param_bc_type_t default_bc);
492
493/*----------------------------------------------------------------------------*/
510/*----------------------------------------------------------------------------*/
511
512cs_equation_t *
513cs_equation_add_user_tracer(const char *eqname,
514 const char *varname,
515 int dim,
516 cs_param_bc_type_t default_bc,
517 cs_property_t *time_pty,
518 cs_adv_field_t *adv,
519 cs_property_t *diff_pty);
520/*----------------------------------------------------------------------------*/
524/*----------------------------------------------------------------------------*/
525
526void
527cs_equation_destroy_all(void);
528
529/*----------------------------------------------------------------------------*/
536/*----------------------------------------------------------------------------*/
537
538bool
539cs_equation_needs_steady_state_solve(void);
540
541/*----------------------------------------------------------------------------*/
549/*----------------------------------------------------------------------------*/
550
551void
552cs_equation_log_monitoring(const cs_time_step_t *ts,
553 const cs_cdo_quantities_t *cdoq);
554
555/*----------------------------------------------------------------------------*/
563/*----------------------------------------------------------------------------*/
564
565void
566cs_equation_get_count(int *n_equations,
567 int *n_predef_equations,
568 int *n_user_equations);
569
570/*----------------------------------------------------------------------------*/
574/*----------------------------------------------------------------------------*/
575
576void
577cs_equation_log_setup(void);
578
579/*----------------------------------------------------------------------------*/
586/*----------------------------------------------------------------------------*/
587
588void
589cs_equation_set_default_param(cs_equation_key_t key,
590 const char *keyval);
591
592/*----------------------------------------------------------------------------*/
596/*----------------------------------------------------------------------------*/
597
598void
599cs_equation_set_sles(void);
600
601/*----------------------------------------------------------------------------*/
618/*----------------------------------------------------------------------------*/
619
620void
621cs_equation_init_sharing(const cs_mesh_t *mesh,
622 const cs_cdo_connect_t *connect,
623 const cs_cdo_quantities_t *cdoq,
624 const cs_time_step_t *time_step,
625 cs_flag_t cb_scheme_flag,
626 cs_flag_t eb_scheme_flag,
627 cs_flag_t fb_scheme_flag,
628 cs_flag_t vb_scheme_flag,
629 cs_flag_t vcb_scheme_flag,
630 cs_flag_t hho_scheme_flag,
631 cs_flag_t mac_scheme_flag);
632
633/*----------------------------------------------------------------------------*/
645/*----------------------------------------------------------------------------*/
646
647void
648cs_equation_finalize_sharing(cs_flag_t cb_scheme_flag,
649 cs_flag_t eb_scheme_flag,
650 cs_flag_t fb_scheme_flag,
651 cs_flag_t vb_scheme_flag,
652 cs_flag_t vcb_scheme_flag,
653 cs_flag_t hho_scheme_flag,
654 cs_flag_t mac_scheme_flag);
655
656/*----------------------------------------------------------------------------*/
665/*----------------------------------------------------------------------------*/
666
667bool
668cs_equation_set_functions(void);
669
670/*----------------------------------------------------------------------------*/
675/*----------------------------------------------------------------------------*/
676
677void
678cs_equation_lock_settings(void);
679
680/*----------------------------------------------------------------------------*/
696/*----------------------------------------------------------------------------*/
697
698void
699cs_equation_predefined_create_field(int n_previous,
700 cs_equation_t *eq);
701
702/*----------------------------------------------------------------------------*/
706/*----------------------------------------------------------------------------*/
707
708void
709cs_equation_user_create_fields(void);
710
711/*----------------------------------------------------------------------------*/
717/*----------------------------------------------------------------------------*/
718
719void
720cs_equation_define_builders(const cs_mesh_t *mesh);
721
722/*----------------------------------------------------------------------------*/
726/*----------------------------------------------------------------------------*/
727
728void
729cs_equation_define_context_structures(void);
730
731/*----------------------------------------------------------------------------*/
739/*----------------------------------------------------------------------------*/
740
741void
742cs_equation_define_core_structure(const cs_equation_t *eq,
743 cs_equation_core_t **p_core);
744
745/*----------------------------------------------------------------------------*/
753/*----------------------------------------------------------------------------*/
754
755void
756cs_equation_init_field_values(const cs_mesh_t *mesh,
757 const cs_time_step_t *ts);
758
759/*----------------------------------------------------------------------------*/
767/*----------------------------------------------------------------------------*/
768
769void
770cs_equation_solve_steady_state(const cs_mesh_t *mesh,
771 cs_equation_t *eq);
772
773/*----------------------------------------------------------------------------*/
782/*----------------------------------------------------------------------------*/
783
784void
785cs_equation_solve(bool cur2prev,
786 const cs_mesh_t *mesh,
787 cs_equation_t *eq);
788
789/*----------------------------------------------------------------------------*/
797/*----------------------------------------------------------------------------*/
798
799void
800cs_equation_build_system(const cs_mesh_t *mesh,
801 cs_equation_t *eq);
802
803/*----------------------------------------------------------------------------*/
811/*----------------------------------------------------------------------------*/
812
813void
814cs_equation_solve_deprecated(const cs_mesh_t *mesh,
815 cs_equation_t *eq);
816
817/*----------------------------------------------------------------------------*/
826/*----------------------------------------------------------------------------*/
827
828cs_property_t *
829cs_equation_get_diffusion_property(const cs_equation_t *eq);
830
831/*----------------------------------------------------------------------------*/
840/*----------------------------------------------------------------------------*/
841
842cs_property_t *
843cs_equation_get_time_property(const cs_equation_t *eq);
844
845/*----------------------------------------------------------------------------*/
856/*----------------------------------------------------------------------------*/
857
858cs_property_t *
859cs_equation_get_reaction_property(const cs_equation_t *eq,
860 const int reaction_id);
861
862/*----------------------------------------------------------------------------*/
871/*----------------------------------------------------------------------------*/
872
873cs_param_time_scheme_t
874cs_equation_get_time_scheme(const cs_equation_t *eq);
875
876/*----------------------------------------------------------------------------*/
886/*----------------------------------------------------------------------------*/
887
888cs_real_t
889cs_equation_get_theta_time_val(const cs_equation_t *eq);
890
891/*----------------------------------------------------------------------------*/
900/*----------------------------------------------------------------------------*/
901
902cs_param_space_scheme_t
903cs_equation_get_space_scheme(const cs_equation_t *eq);
904
905/*----------------------------------------------------------------------------*/
914/*----------------------------------------------------------------------------*/
915
916int
917cs_equation_get_space_poly_degree(const cs_equation_t *eq);
918
919/*----------------------------------------------------------------------------*/
927/*----------------------------------------------------------------------------*/
928
929int
930cs_equation_get_var_dim(const cs_equation_t *eq);
931
932/*----------------------------------------------------------------------------*/
940/*----------------------------------------------------------------------------*/
941
942cs_equation_type_t
943cs_equation_get_type(const cs_equation_t *eq);
944
945/*----------------------------------------------------------------------------*/
955/*----------------------------------------------------------------------------*/
956
957double
958cs_equation_get_time_eval(const cs_time_step_t *ts,
959 const cs_equation_t *eq);
960
961/*----------------------------------------------------------------------------*/
969/*----------------------------------------------------------------------------*/
970
971void
972cs_equation_current_to_previous(const cs_equation_t *eq);
973
974/*----------------------------------------------------------------------------*/
983/*----------------------------------------------------------------------------*/
984
985void
986cs_equation_get_cellwise_builders(const cs_equation_t *eq,
987 cs_cell_sys_t **csys,
988 cs_cell_builder_t **cb);
989
990/*----------------------------------------------------------------------------*/
1000/*----------------------------------------------------------------------------*/
1001
1002cs_real_t *
1003cs_equation_get_cell_values(const cs_equation_t *eq,
1004 bool previous);
1005
1006/*----------------------------------------------------------------------------*/
1016/*----------------------------------------------------------------------------*/
1017
1018cs_real_t *
1019cs_equation_get_face_values(const cs_equation_t *eq,
1020 bool previous);
1021
1022/*----------------------------------------------------------------------------*/
1032/*----------------------------------------------------------------------------*/
1033
1034cs_real_t *
1035cs_equation_get_edge_values(const cs_equation_t *eq,
1036 bool previous);
1037
1038/*----------------------------------------------------------------------------*/
1048/*----------------------------------------------------------------------------*/
1049
1050cs_real_t *
1051cs_equation_get_vertex_values(const cs_equation_t *eq,
1052 bool previous);
1053
1054/*----------------------------------------------------------------------------*/
1066/*----------------------------------------------------------------------------*/
1067
1068void
1069cs_equation_integrate_variable(const cs_cdo_connect_t *connect,
1070 const cs_cdo_quantities_t *cdoq,
1071 const cs_equation_t *eq,
1072 cs_real_t *result);
1073
1074/*----------------------------------------------------------------------------*/
1114/*----------------------------------------------------------------------------*/
1115
1116void
1117cs_equation_compute_boundary_diff_flux(const cs_equation_t *eq,
1118 const cs_equation_param_t *eqp,
1119 const cs_property_t *diff_pty,
1120 const cs_real_t *dof_vals,
1121 const cs_real_t *cell_vals,
1122 cs_real_t t_eval,
1123 cs_real_t *diff_flux);
1124
1125/*----------------------------------------------------------------------------*/
1136/*----------------------------------------------------------------------------*/
1137
1138void
1139cs_equation_compute_flux_across_plane(const cs_equation_t *eq,
1140 const char *ml_name,
1141 const cs_real_3_t direction,
1142 cs_real_t *diff_flux,
1143 cs_real_t *conv_flux);
1144
1145/*----------------------------------------------------------------------------*/
1184/*----------------------------------------------------------------------------*/
1185
1186void
1187cs_equation_compute_diffusive_flux(const cs_equation_t *eq,
1188 const cs_equation_param_t *eqp,
1189 const cs_property_t *diff_pty,
1190 const cs_real_t *dof_vals,
1191 const cs_real_t *cell_vals,
1192 cs_flag_t location,
1193 cs_real_t t_eval,
1194 cs_real_t *diff_flux);
1195
1196/*----------------------------------------------------------------------------*/
1203/*----------------------------------------------------------------------------*/
1204
1205void
1206cs_equation_compute_vtx_field_gradient(const cs_equation_t *eq,
1207 cs_real_t *v_gradient);
1208
1209/*----------------------------------------------------------------------------*/
1218/*----------------------------------------------------------------------------*/
1219
1220void
1221cs_equation_compute_peclet(const cs_equation_t *eq,
1222 const cs_time_step_t *ts,
1223 cs_real_t peclet[]);
1224
1225/*----------------------------------------------------------------------------*/
1232/*----------------------------------------------------------------------------*/
1233
1234void
1235cs_equation_read_extra_restart(cs_restart_t *restart);
1236
1237/*----------------------------------------------------------------------------*/
1244/*----------------------------------------------------------------------------*/
1245
1246void
1247cs_equation_write_extra_restart(cs_restart_t *restart);
1248
1249/*----------------------------------------------------------------------------*/
1258/*----------------------------------------------------------------------------*/
1259
1260void
1261cs_equation_post_balance(const cs_mesh_t *mesh,
1262 const cs_cdo_connect_t *connect,
1263 const cs_cdo_quantities_t *cdoq,
1264 const cs_time_step_t *ts);
1265
1266/*----------------------------------------------------------------------------*/
1278/*----------------------------------------------------------------------------*/
1279
1280void
1281cs_equation_apply_stiffness(cs_equation_t *eq,
1282 const cs_property_t *property,
1283 const cs_real_t *pot,
1284 cs_flag_t loc_res,
1285 cs_real_t *res);
1286
1287/*----------------------------------------------------------------------------*/
1292/*----------------------------------------------------------------------------*/
1293
1294void
1295cs_equation_extra_post(void);
1296
1297/*----------------------------------------------------------------------------*/
1298
1299END_C_DECLS
1300
1301#endif /* __CS_EQUATION_H__ */
cs_cdo_connect.h
cs_cdo_quantities.h
cs_cdo_toolbox.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:554
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:357
cs_real_3_t
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:374
cs_gnum_t
unsigned cs_gnum_t
global mesh entity number
Definition: cs_defs.h:342
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:555
cs_flag_t
unsigned short int cs_flag_t
Definition: cs_defs.h:359
cs_equation_add_user_tracer
cs_equation_t * cs_equation_add_user_tracer(const char *eqname, const char *varname, int dim, cs_param_bc_type_t default_bc, cs_property_t *time_pty, cs_adv_field_t *adv, cs_property_t *diff_pty)
Add a new user transport equation and set a first set of parameters If time_pty is null,...
Definition: cs_equation.cpp:1667
cs_equation_init_sharing
void cs_equation_init_sharing(const cs_mesh_t *mesh, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, const cs_time_step_t *time_step, cs_flag_t cb_scheme_flag, cs_flag_t eb_scheme_flag, cs_flag_t fb_scheme_flag, cs_flag_t vb_scheme_flag, cs_flag_t vcb_scheme_flag, cs_flag_t hho_scheme_flag, cs_flag_t mac_scheme_flag)
Set shared pointers to the main structures. Associate these structures among the activated class of d...
Definition: cs_equation.cpp:1970
cs_equation_get_cell_values
cs_real_t * cs_equation_get_cell_values(const cs_equation_t *eq, bool previous)
For a given equation, retrieve an array of values related to each cell of the mesh for the unknowns.
Definition: cs_equation.cpp:3234
cs_equation_add_build_hook
void cs_equation_add_build_hook(cs_equation_t *eq, void *context, cs_equation_build_hook_t *func)
Add a hook function to enable an advanced control during the cellwise system building....
Definition: cs_equation.cpp:1381
cs_equation_define_builders
void cs_equation_define_builders(const cs_mesh_t *mesh)
Allocate and define the builder structure.
Definition: cs_equation.cpp:2814
cs_equation_predefined_create_field
void cs_equation_predefined_create_field(int n_previous, cs_equation_t *eq)
Create a field structure related to the predefined equation given as parameter. This includes an equa...
Definition: cs_equation.cpp:2758
cs_equation_get_core_structure
cs_equation_core_t cs_equation_get_core_structure(const cs_equation_t *eq)
Return a pointer to a structure useful to handle low-level operations for the given equation.
Definition: cs_equation.cpp:975
cs_equation_by_id
cs_equation_t * cs_equation_by_id(int eq_id)
Find the cs_equation_t structure with id eq_id Return nullptr if not found.
Definition: cs_equation.cpp:679
cs_equation_finalize_sharing
void cs_equation_finalize_sharing(cs_flag_t cb_scheme_flag, cs_flag_t eb_scheme_flag, cs_flag_t fb_scheme_flag, cs_flag_t vb_scheme_flag, cs_flag_t vcb_scheme_flag, cs_flag_t hho_scheme_flag, cs_flag_t mac_scheme_flag)
Free shared local structures among the discretization schemes.
Definition: cs_equation.cpp:2059
cs_equation_lock_settings
void cs_equation_lock_settings(void)
After this call, parameters related to an equation are set once for all.
Definition: cs_equation.cpp:2713
cs_equation_extra_post
void cs_equation_extra_post(void)
Predefined extra-operations related to equations according to the type of numerical scheme (for the s...
Definition: cs_equation.cpp:4267
cs_equation_get_source_term_array
cs_real_t * cs_equation_get_source_term_array(const cs_equation_t *eq)
Return a pointer to an array of values corresponding to the values of the source terms (cumulated val...
Definition: cs_equation.cpp:1003
cs_equation_write_extra_restart
void cs_equation_write_extra_restart(cs_restart_t *restart)
Write into the restart file additionnal arrays (not defined as fields) but useful for the checkpoint/...
Definition: cs_equation.cpp:4080
cs_equation_get_time_property
cs_property_t * cs_equation_get_time_property(const cs_equation_t *eq)
Return a pointer to the cs_property_t structure associated to the unsteady term for this equation (nu...
Definition: cs_equation.cpp:1076
cs_equation_post_balance
void cs_equation_post_balance(const cs_mesh_t *mesh, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, const cs_time_step_t *ts)
Predefined extra-operations related to all equations.
Definition: cs_equation.cpp:4105
cs_equation_get_range_set
const cs_range_set_t * cs_equation_get_range_set(const cs_equation_t *eq)
Return the range set structure associated to a cs_equation_t structure. One assumes that there is onl...
Definition: cs_equation.cpp:801
cs_equation_get_param
cs_equation_param_t * cs_equation_get_param(const cs_equation_t *eq)
Return the cs_equation_param_t structure associated to a cs_equation_t structure.
Definition: cs_equation.cpp:659
cs_equation_add_user
cs_equation_t * cs_equation_add_user(const char *eqname, const char *varname, int dim, cs_param_bc_type_t default_bc)
Add a new user equation structure and set a first set of parameters.
Definition: cs_equation.cpp:1616
cs_equation_set_default_param
void cs_equation_set_default_param(cs_equation_key_t key, const char *keyval)
Set a parameter attached to a keyname for the default settigns.
Definition: cs_equation.cpp:1895
cs_equation_set_functions
bool cs_equation_set_functions(void)
Assign a set of pointer functions for managing the cs_equation_t structure during the computation Aft...
Definition: cs_equation.cpp:2110
cs_equation_read_extra_restart
void cs_equation_read_extra_restart(cs_restart_t *restart)
Write into the restart file additionnal arrays (not defined as fields) but useful for the checkpoint/...
Definition: cs_equation.cpp:4057
cs_equation_set_sles
void cs_equation_set_sles(void)
Setup the linear algebra requirements.
Definition: cs_equation.cpp:1925
cs_equation_solve
void cs_equation_solve(bool cur2prev, const cs_mesh_t *mesh, cs_equation_t *eq)
Build and then solve the linear system for an equation with an unsteady term.
Definition: cs_equation.cpp:3145
cs_equation_set_flag
void cs_equation_set_flag(cs_equation_t *eq, cs_flag_t flag)
Redefine the flag associated to an equation.
Definition: cs_equation.cpp:1357
cs_equation_get_space_poly_degree
int cs_equation_get_space_poly_degree(const cs_equation_t *eq)
Return the max. degree used in the polynomial basis for the space discretization.
Definition: cs_equation.cpp:1217
cs_equation_needs_steady_state_solve
bool cs_equation_needs_steady_state_solve(void)
Check if a steady-state computation is requested according to the setting.
Definition: cs_equation.cpp:1750
cs_equation_solve_steady_state
void cs_equation_solve_steady_state(const cs_mesh_t *mesh, cs_equation_t *eq)
Build and then solve the linear system for this equation when the goal is to find the steady state.
Definition: cs_equation.cpp:3109
cs_equation_get_scheme_context
void * cs_equation_get_scheme_context(const cs_equation_t *eq)
Return a pointer to a structure useful to handle low-level operations for the given equation.
Definition: cs_equation.cpp:955
cs_equation_get_flag
cs_flag_t cs_equation_get_flag(const cs_equation_t *eq)
Return the flag associated to an equation.
Definition: cs_equation.cpp:1335
cs_equation_get_time_scheme
cs_param_time_scheme_t cs_equation_get_time_scheme(const cs_equation_t *eq)
Return the type of numerical scheme used for the discretization in time.
Definition: cs_equation.cpp:1125
cs_equation_get_field
cs_field_t * cs_equation_get_field(const cs_equation_t *eq)
Return the field structure associated to a cs_equation_t structure.
Definition: cs_equation.cpp:737
cs_equation_get_space_scheme
cs_param_space_scheme_t cs_equation_get_space_scheme(const cs_equation_t *eq)
Return the type of numerical scheme used for the discretization in space.
Definition: cs_equation.cpp:1195
cs_equation_param_by_name
cs_equation_param_t * cs_equation_param_by_name(const char *eqname)
Return the cs_equation_param_t structure associated to a cs_equation_t structure based on the equatio...
Definition: cs_equation.cpp:601
cs_equation_get_count
void cs_equation_get_count(int *n_equations, int *n_predef_equations, int *n_user_equations)
Get the count of equations of each macro type.
Definition: cs_equation.cpp:1842
cs_equation_uses_new_mechanism
bool cs_equation_uses_new_mechanism(const cs_equation_t *eq)
Return true is the given equation follows the new mechanism otherwise false Only HHO and MAC schemes ...
Definition: cs_equation.cpp:1448
cs_equation_define_context_structures
void cs_equation_define_context_structures(void)
Allocate and define the context structure associated to each equation.
Definition: cs_equation.cpp:2843
cs_equation_get_name
const char * cs_equation_get_name(const cs_equation_t *eq)
Return the name related to the given cs_equation_t structure.
Definition: cs_equation.cpp:698
cs_equation_get_edge_values
cs_real_t * cs_equation_get_edge_values(const cs_equation_t *eq, bool previous)
For a given equation, retrieve an array of values related to each edge of the mesh for the unknowns.
Definition: cs_equation.cpp:3286
cs_equation_by_field_name
cs_equation_t * cs_equation_by_field_name(const char *field_name)
Return the pointer to a cs_equation_t structure thanks to the field name of the variable field associ...
Definition: cs_equation.cpp:537
cs_equation_define_core_structure
void cs_equation_define_core_structure(const cs_equation_t *eq, cs_equation_core_t **p_core)
Build a pointer to a core structure. If the input core structure is not allocated,...
Definition: cs_equation.cpp:2891
cs_equation_log_monitoring
void cs_equation_log_monitoring(const cs_time_step_t *ts, const cs_cdo_quantities_t *cdoq)
Print a synthesis of the monitoring information in the performance file.
Definition: cs_equation.cpp:1775
cs_equation_compute_vtx_field_gradient
void cs_equation_compute_vtx_field_gradient(const cs_equation_t *eq, cs_real_t *v_gradient)
Cellwise computation of the discrete gradient at vertices.
Definition: cs_equation.cpp:3968
cs_equation_init_field_values
void cs_equation_init_field_values(const cs_mesh_t *mesh, const cs_time_step_t *ts)
Set the initialize condition to all variable fields associated to each cs_equation_t structure.
Definition: cs_equation.cpp:2920
cs_equation_solve_deprecated
void cs_equation_solve_deprecated(const cs_mesh_t *mesh, cs_equation_t *eq)
Solve the linear system for this equation (deprecated). Only for HHO schemes.
Definition: cs_equation.cpp:3001
cs_equation_get_builder
cs_equation_builder_t * cs_equation_get_builder(const cs_equation_t *eq)
Return the cs_equation_builder_t structure associated to a cs_equation_t structure....
Definition: cs_equation.cpp:935
cs_equation_get_global_n_dofs
cs_gnum_t cs_equation_get_global_n_dofs(const cs_equation_t *eq, const cs_cdo_quantities_t *cdoq)
Return the global number of degrees of freedom associated to this cs_equation_t structure.
Definition: cs_equation.cpp:834
cs_equation_compute_diffusive_flux
void cs_equation_compute_diffusive_flux(const cs_equation_t *eq, const cs_equation_param_t *eqp, const cs_property_t *diff_pty, const cs_real_t *dof_vals, const cs_real_t *cell_vals, cs_flag_t location, cs_real_t t_eval, cs_real_t *diff_flux)
Computation of the diffusive flux across the requested location. If the location is not the "natural"...
Definition: cs_equation.cpp:3747
cs_equation_is_steady
bool cs_equation_is_steady(const cs_equation_t *eq)
Return true is the given equation is steady otherwise false.
Definition: cs_equation.cpp:1422
cs_equation_get_diffusion_property
cs_property_t * cs_equation_get_diffusion_property(const cs_equation_t *eq)
Return a pointer to the cs_property_t structure associated to the diffusion term for this equation (n...
Definition: cs_equation.cpp:1054
cs_equation_has_field_name
bool cs_equation_has_field_name(const cs_equation_t *eq, const char *fld_name)
Check if the asociated field to a cs_equation_t structure has name equal to fld_name.
Definition: cs_equation.cpp:569
cs_equation_get_reaction_property
cs_property_t * cs_equation_get_reaction_property(const cs_equation_t *eq, const int reaction_id)
Return a pointer to the cs_property_t structure associated to the reaction term with id equal to reac...
Definition: cs_equation.cpp:1100
cs_equation_get_face_values
cs_real_t * cs_equation_get_face_values(const cs_equation_t *eq, bool previous)
For a given equation, retrieve an array of values related to each face of the mesh for the unknowns.
Definition: cs_equation.cpp:3260
cs_equation_compute_flux_across_plane
void cs_equation_compute_flux_across_plane(const cs_equation_t *eq, const char *ml_name, const cs_real_3_t direction, cs_real_t *diff_flux, cs_real_t *conv_flux)
Compute the diffusive and convective flux across a plane defined by a mesh location structure attache...
Definition: cs_equation.cpp:3642
cs_equation_by_name
cs_equation_t * cs_equation_by_name(const char *eqname)
Find the cs_equation_t structure with name eqname Return nullptr if not found.
Definition: cs_equation.cpp:504
cs_equation_current_to_previous
void cs_equation_current_to_previous(const cs_equation_t *eq)
Apply the current to previous to all fields (and potentially arrays) related to an equation....
Definition: cs_equation.cpp:3178
cs_equation_integrate_variable
void cs_equation_integrate_variable(const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, const cs_equation_t *eq, cs_real_t *result)
Compute the integral over the domain of the variable field associated to the given equation....
Definition: cs_equation.cpp:3340
cs_equation_build_system
void cs_equation_build_system(const cs_mesh_t *mesh, cs_equation_t *eq)
Build the linear system for this equation (deprecated). Only for HHO schemes.
Definition: cs_equation.cpp:2972
cs_equation_apply_stiffness
void cs_equation_apply_stiffness(cs_equation_t *eq, const cs_property_t *property, const cs_real_t *pot, cs_flag_t loc_res, cs_real_t *res)
Compute the cellwise stiffness matrix associated to the property given as a parameter and apply it to...
Definition: cs_equation.cpp:4225
cs_equation_destroy_all
void cs_equation_destroy_all(void)
Destroy all cs_equation_t structures.
Definition: cs_equation.cpp:1703
cs_equation_compute_boundary_diff_flux
void cs_equation_compute_boundary_diff_flux(const cs_equation_t *eq, const cs_equation_param_t *eqp, const cs_property_t *diff_pty, const cs_real_t *dof_vals, const cs_real_t *cell_vals, cs_real_t t_eval, cs_real_t *diff_flux)
Compute the diffusive flux across all boundary faces According to the space discretization scheme,...
Definition: cs_equation.cpp:3480
cs_equation_get_cellwise_builders
void cs_equation_get_cellwise_builders(const cs_equation_t *eq, cs_cell_sys_t **csys, cs_cell_builder_t **cb)
For a given equation, retrieve the related cellwise builder structures: cs_cell_builder_t and cs_cell...
Definition: cs_equation.cpp:3207
cs_equation_log_setup
void cs_equation_log_setup(void)
Summarize all cs_equation_t structures.
Definition: cs_equation.cpp:1858
cs_equation_user_create_fields
void cs_equation_user_create_fields(void)
Create a field structure related to all user-defined equations.
Definition: cs_equation.cpp:2785
cs_equation_get_theta_time_val
cs_real_t cs_equation_get_theta_time_val(const cs_equation_t *eq)
Return the value of the theta parameter in theta time scheme discretization.
Definition: cs_equation.cpp:1148
cs_equation_get_vertex_values
cs_real_t * cs_equation_get_vertex_values(const cs_equation_t *eq, bool previous)
For a given equation, retrieve an array of values related to each vertex of the mesh for the unknowns...
Definition: cs_equation.cpp:3312
cs_equation_get_boundary_flux
cs_field_t * cs_equation_get_boundary_flux(const cs_equation_t *eq)
Return the field structure for the (normal) boundary flux associated to a cs_equation_t structure.
Definition: cs_equation.cpp:913
cs_equation_get_id
int cs_equation_get_id(const cs_equation_t *eq)
Return the id number related to the given cs_equation_t structure.
Definition: cs_equation.cpp:718
cs_equation_get_type
cs_equation_type_t cs_equation_get_type(const cs_equation_t *eq)
Return the type of equation for the given equation structure.
Definition: cs_equation.cpp:1259
cs_equation_get_time_eval
double cs_equation_get_time_eval(const cs_time_step_t *ts, const cs_equation_t *eq)
Estimate the time at which the evaluation of properties related to the different terms of an equation...
Definition: cs_equation.cpp:1282
cs_equation_add
cs_equation_t * cs_equation_add(const char *eqname, const char *varname, cs_equation_type_t eqtype, int dim, cs_param_bc_type_t default_bc)
Add a new equation structure and set a first set of parameters.
Definition: cs_equation.cpp:1486
cs_equation_get_field_name
const char * cs_equation_get_field_name(const cs_equation_t *eq)
Return the name related to the variable field structure associated to the given cs_equation_t structu...
Definition: cs_equation.cpp:777
cs_equation_get_field_id
int cs_equation_get_field_id(const cs_equation_t *eq)
Return the id related to the variable field structure associated to the cs_equation_t structure.
Definition: cs_equation.cpp:757
cs_equation_param_by_field_name
cs_equation_param_t * cs_equation_param_by_field_name(const char *field_name)
Return the cs_equation_param_t structure related to a cs_equation_t structure thanks to the field nam...
Definition: cs_equation.cpp:634
cs_equation_get_var_dim
int cs_equation_get_var_dim(const cs_equation_t *eq)
Return the dimension of the variable solved by this equation.
Definition: cs_equation.cpp:1238
cs_equation_get_n_equations
int cs_equation_get_n_equations(void)
Retrieve the number of equations.
Definition: cs_equation.cpp:487
cs_equation_compute_peclet
void cs_equation_compute_peclet(const cs_equation_t *eq, const cs_time_step_t *ts, cs_real_t peclet[])
Compute and post-process Peclet number if requested.
Definition: cs_equation.cpp:4009
cs_equation_builder.h
cs_equation_build_hook_t
void() cs_equation_build_hook_t(const cs_equation_param_t *eqp, const cs_equation_builder_t *eqb, const void *eqc, const cs_cell_mesh_t *cm, void *context, cs_hodge_t *mass_hodge, cs_hodge_t *diff_hodge, cs_cell_sys_t *csys, cs_cell_builder_t *cb)
Generic function prototype for a hook during the cellwise building of the linear system Enable an adv...
Definition: cs_equation_builder.h:76
cs_equation_param.h
cs_equation_key_t
cs_equation_key_t
List of available keys for setting the parameters of an equation.
Definition: cs_equation_param.h:1217
cs_equation_type_t
cs_equation_type_t
Type of equations managed by the solver.
Definition: cs_equation_param.h:173
cs_field.h
cs_mesh.h
cs_param_space_scheme_t
cs_param_space_scheme_t
Type of numerical scheme for the discretization in space.
Definition: cs_param_types.h:215
cs_param_bc_type_t
cs_param_bc_type_t
Definition: cs_param_types.h:493
cs_param_time_scheme_t
cs_param_time_scheme_t
Definition: cs_param_types.h:279
cs_restart.h
cs_restart_t
struct _cs_restart_t cs_restart_t
Definition: cs_restart.h:95
cs_time_step.h
mesh
Definition: mesh.f90:26
_cs_equation_t
Definition: cs_equation_priv.h:323
cs_adv_field_t
Definition: cs_advection_field.h:151
cs_cdo_connect_t
Definition: cs_cdo_connect.h:61
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:145
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_core_t
Main structures on which an equation structure relies.
Definition: cs_equation.h:82
cs_equation_core_t::scheme_context
void * scheme_context
Definition: cs_equation.h:86
cs_equation_core_t::builder
cs_equation_builder_t * builder
Definition: cs_equation.h:85
cs_equation_core_t::param
cs_equation_param_t * param
Definition: cs_equation.h:84
cs_equation_param_t
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources.
Definition: cs_equation_param.h:194
cs_equation_t
Main structure to handle the discretization and the resolution of an equation.
cs_field_t
Field descriptor.
Definition: cs_field.h:156
cs_mesh_t
Definition: cs_mesh.h:85
cs_property_t
Structure associated to the definition of a property relying on the cs_xdef_t structure.
cs_range_set_t
Definition: cs_range_set.h:57
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:64