8.3
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-2024 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 "cs_cdo_connect.h"
33#include "cs_cdo_quantities.h"
34#include "cs_cdo_toolbox.h"
35#include "cs_equation_builder.h"
36#include "cs_equation_param.h"
37#include "cs_field.h"
38#include "cs_mesh.h"
39#include "cs_restart.h"
40#include "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/*----------------------------------------------------------------------------*/
275/*----------------------------------------------------------------------------*/
276
277const cs_range_set_t *
278cs_equation_get_range_set(const cs_equation_t *eq);
279
280/*----------------------------------------------------------------------------*/
290/*----------------------------------------------------------------------------*/
291
292cs_gnum_t
293cs_equation_get_global_n_dofs(const cs_equation_t *eq,
294 const cs_cdo_quantities_t *cdoq);
295
296/*----------------------------------------------------------------------------*/
305/*----------------------------------------------------------------------------*/
306
307cs_field_t *
308cs_equation_get_boundary_flux(const cs_equation_t *eq);
309
310/*----------------------------------------------------------------------------*/
318/*----------------------------------------------------------------------------*/
319
320cs_flag_t
321cs_equation_get_flag(const cs_equation_t *eq);
322
323/*----------------------------------------------------------------------------*/
330/*----------------------------------------------------------------------------*/
331
332void
333cs_equation_set_flag(cs_equation_t *eq,
334 cs_flag_t flag);
335
336/*----------------------------------------------------------------------------*/
347/*----------------------------------------------------------------------------*/
348
349void
350cs_equation_add_build_hook(cs_equation_t *eq,
351 void *context,
352 cs_equation_build_hook_t *func);
353
354/*----------------------------------------------------------------------------*/
363/*----------------------------------------------------------------------------*/
364
365cs_equation_builder_t *
366cs_equation_get_builder(const cs_equation_t *eq);
367
368/*----------------------------------------------------------------------------*/
377/*----------------------------------------------------------------------------*/
378
379void *
380cs_equation_get_scheme_context(const cs_equation_t *eq);
381
382/*----------------------------------------------------------------------------*/
391/*----------------------------------------------------------------------------*/
392
393cs_equation_core_t
394cs_equation_get_core_structure(const cs_equation_t *eq);
395
396/*----------------------------------------------------------------------------*/
406/*----------------------------------------------------------------------------*/
407
408cs_real_t *
409cs_equation_get_source_term_array(const cs_equation_t *eq);
410
411/*----------------------------------------------------------------------------*/
419/*----------------------------------------------------------------------------*/
420
421bool
422cs_equation_is_steady(const cs_equation_t *eq);
423
424/*----------------------------------------------------------------------------*/
433/*----------------------------------------------------------------------------*/
434
435bool
436cs_equation_uses_new_mechanism(const cs_equation_t *eq);
437
438/*----------------------------------------------------------------------------*/
450/*----------------------------------------------------------------------------*/
451
452cs_equation_t *
453cs_equation_add(const char *eqname,
454 const char *varname,
455 cs_equation_type_t eqtype,
456 int dim,
457 cs_param_bc_type_t default_bc);
458
459/*----------------------------------------------------------------------------*/
470/*----------------------------------------------------------------------------*/
471
472cs_equation_t *
473cs_equation_add_user(const char *eqname,
474 const char *varname,
475 int dim,
476 cs_param_bc_type_t default_bc);
477
478/*----------------------------------------------------------------------------*/
495/*----------------------------------------------------------------------------*/
496
497cs_equation_t *
498cs_equation_add_user_tracer(const char *eqname,
499 const char *varname,
500 int dim,
501 cs_param_bc_type_t default_bc,
502 cs_property_t *time_pty,
503 cs_adv_field_t *adv,
504 cs_property_t *diff_pty);
505/*----------------------------------------------------------------------------*/
509/*----------------------------------------------------------------------------*/
510
511void
512cs_equation_destroy_all(void);
513
514/*----------------------------------------------------------------------------*/
521/*----------------------------------------------------------------------------*/
522
523bool
524cs_equation_needs_steady_state_solve(void);
525
526/*----------------------------------------------------------------------------*/
531/*----------------------------------------------------------------------------*/
532
533void
534cs_equation_log_monitoring(void);
535
536/*----------------------------------------------------------------------------*/
544/*----------------------------------------------------------------------------*/
545
546void
547cs_equation_get_count(int *n_equations,
548 int *n_predef_equations,
549 int *n_user_equations);
550
551/*----------------------------------------------------------------------------*/
555/*----------------------------------------------------------------------------*/
556
557void
558cs_equation_log_setup(void);
559
560/*----------------------------------------------------------------------------*/
567/*----------------------------------------------------------------------------*/
568
569void
570cs_equation_set_default_param(cs_equation_key_t key,
571 const char *keyval);
572
573/*----------------------------------------------------------------------------*/
577/*----------------------------------------------------------------------------*/
578
579void
580cs_equation_set_sles(void);
581
582/*----------------------------------------------------------------------------*/
599/*----------------------------------------------------------------------------*/
600
601void
602cs_equation_init_sharing(const cs_mesh_t *mesh,
603 const cs_cdo_connect_t *connect,
604 const cs_cdo_quantities_t *cdoq,
605 const cs_time_step_t *time_step,
606 cs_flag_t cb_scheme_flag,
607 cs_flag_t eb_scheme_flag,
608 cs_flag_t fb_scheme_flag,
609 cs_flag_t vb_scheme_flag,
610 cs_flag_t vcb_scheme_flag,
611 cs_flag_t hho_scheme_flag,
612 cs_flag_t mac_scheme_flag);
613
614/*----------------------------------------------------------------------------*/
626/*----------------------------------------------------------------------------*/
627
628void
629cs_equation_finalize_sharing(cs_flag_t cb_scheme_flag,
630 cs_flag_t eb_scheme_flag,
631 cs_flag_t fb_scheme_flag,
632 cs_flag_t vb_scheme_flag,
633 cs_flag_t vcb_scheme_flag,
634 cs_flag_t hho_scheme_flag,
635 cs_flag_t mac_scheme_flag);
636
637/*----------------------------------------------------------------------------*/
646/*----------------------------------------------------------------------------*/
647
648bool
649cs_equation_set_functions(void);
650
651/*----------------------------------------------------------------------------*/
656/*----------------------------------------------------------------------------*/
657
658void
659cs_equation_lock_settings(void);
660
661/*----------------------------------------------------------------------------*/
677/*----------------------------------------------------------------------------*/
678
679void
680cs_equation_predefined_create_field(int n_previous,
681 cs_equation_t *eq);
682
683/*----------------------------------------------------------------------------*/
687/*----------------------------------------------------------------------------*/
688
689void
690cs_equation_user_create_fields(void);
691
692/*----------------------------------------------------------------------------*/
698/*----------------------------------------------------------------------------*/
699
700void
701cs_equation_define_builders(const cs_mesh_t *mesh);
702
703/*----------------------------------------------------------------------------*/
707/*----------------------------------------------------------------------------*/
708
709void
710cs_equation_define_context_structures(void);
711
712/*----------------------------------------------------------------------------*/
720/*----------------------------------------------------------------------------*/
721
722void
723cs_equation_define_core_structure(const cs_equation_t *eq,
724 cs_equation_core_t **p_core);
725
726/*----------------------------------------------------------------------------*/
734/*----------------------------------------------------------------------------*/
735
736void
737cs_equation_init_field_values(const cs_mesh_t *mesh,
738 const cs_time_step_t *ts);
739
740/*----------------------------------------------------------------------------*/
748/*----------------------------------------------------------------------------*/
749
750void
751cs_equation_solve_steady_state(const cs_mesh_t *mesh,
752 cs_equation_t *eq);
753
754/*----------------------------------------------------------------------------*/
763/*----------------------------------------------------------------------------*/
764
765void
766cs_equation_solve(bool cur2prev,
767 const cs_mesh_t *mesh,
768 cs_equation_t *eq);
769
770/*----------------------------------------------------------------------------*/
778/*----------------------------------------------------------------------------*/
779
780void
781cs_equation_build_system(const cs_mesh_t *mesh,
782 cs_equation_t *eq);
783
784/*----------------------------------------------------------------------------*/
791/*----------------------------------------------------------------------------*/
792
793void
794cs_equation_solve_deprecated(cs_equation_t *eq);
795
796/*----------------------------------------------------------------------------*/
805/*----------------------------------------------------------------------------*/
806
807cs_property_t *
808cs_equation_get_diffusion_property(const cs_equation_t *eq);
809
810/*----------------------------------------------------------------------------*/
819/*----------------------------------------------------------------------------*/
820
821cs_property_t *
822cs_equation_get_time_property(const cs_equation_t *eq);
823
824/*----------------------------------------------------------------------------*/
835/*----------------------------------------------------------------------------*/
836
837cs_property_t *
838cs_equation_get_reaction_property(const cs_equation_t *eq,
839 const int reaction_id);
840
841/*----------------------------------------------------------------------------*/
850/*----------------------------------------------------------------------------*/
851
852cs_param_time_scheme_t
853cs_equation_get_time_scheme(const cs_equation_t *eq);
854
855/*----------------------------------------------------------------------------*/
865/*----------------------------------------------------------------------------*/
866
867cs_real_t
868cs_equation_get_theta_time_val(const cs_equation_t *eq);
869
870/*----------------------------------------------------------------------------*/
879/*----------------------------------------------------------------------------*/
880
881cs_param_space_scheme_t
882cs_equation_get_space_scheme(const cs_equation_t *eq);
883
884/*----------------------------------------------------------------------------*/
893/*----------------------------------------------------------------------------*/
894
895int
896cs_equation_get_space_poly_degree(const cs_equation_t *eq);
897
898/*----------------------------------------------------------------------------*/
906/*----------------------------------------------------------------------------*/
907
908int
909cs_equation_get_var_dim(const cs_equation_t *eq);
910
911/*----------------------------------------------------------------------------*/
919/*----------------------------------------------------------------------------*/
920
921cs_equation_type_t
922cs_equation_get_type(const cs_equation_t *eq);
923
924/*----------------------------------------------------------------------------*/
934/*----------------------------------------------------------------------------*/
935
936double
937cs_equation_get_time_eval(const cs_time_step_t *ts,
938 const cs_equation_t *eq);
939
940/*----------------------------------------------------------------------------*/
948/*----------------------------------------------------------------------------*/
949
950void
951cs_equation_current_to_previous(const cs_equation_t *eq);
952
953/*----------------------------------------------------------------------------*/
962/*----------------------------------------------------------------------------*/
963
964void
965cs_equation_get_cellwise_builders(const cs_equation_t *eq,
966 cs_cell_sys_t **csys,
967 cs_cell_builder_t **cb);
968
969/*----------------------------------------------------------------------------*/
979/*----------------------------------------------------------------------------*/
980
981cs_real_t *
982cs_equation_get_cell_values(const cs_equation_t *eq,
983 bool previous);
984
985/*----------------------------------------------------------------------------*/
995/*----------------------------------------------------------------------------*/
996
997cs_real_t *
998cs_equation_get_face_values(const cs_equation_t *eq,
999 bool previous);
1000
1001/*----------------------------------------------------------------------------*/
1011/*----------------------------------------------------------------------------*/
1012
1013cs_real_t *
1014cs_equation_get_edge_values(const cs_equation_t *eq,
1015 bool previous);
1016
1017/*----------------------------------------------------------------------------*/
1027/*----------------------------------------------------------------------------*/
1028
1029cs_real_t *
1030cs_equation_get_vertex_values(const cs_equation_t *eq,
1031 bool previous);
1032
1033/*----------------------------------------------------------------------------*/
1045/*----------------------------------------------------------------------------*/
1046
1047void
1048cs_equation_integrate_variable(const cs_cdo_connect_t *connect,
1049 const cs_cdo_quantities_t *cdoq,
1050 const cs_equation_t *eq,
1051 cs_real_t *result);
1052
1053/*----------------------------------------------------------------------------*/
1093/*----------------------------------------------------------------------------*/
1094
1095void
1096cs_equation_compute_boundary_diff_flux(const cs_equation_t *eq,
1097 const cs_equation_param_t *eqp,
1098 const cs_property_t *diff_pty,
1099 const cs_real_t *dof_vals,
1100 const cs_real_t *cell_vals,
1101 cs_real_t t_eval,
1102 cs_real_t *diff_flux);
1103
1104/*----------------------------------------------------------------------------*/
1115/*----------------------------------------------------------------------------*/
1116
1117void
1118cs_equation_compute_flux_across_plane(const cs_equation_t *eq,
1119 const char *ml_name,
1120 const cs_real_3_t direction,
1121 cs_real_t *diff_flux,
1122 cs_real_t *conv_flux);
1123
1124/*----------------------------------------------------------------------------*/
1163/*----------------------------------------------------------------------------*/
1164
1165void
1166cs_equation_compute_diffusive_flux(const cs_equation_t *eq,
1167 const cs_equation_param_t *eqp,
1168 const cs_property_t *diff_pty,
1169 const cs_real_t *dof_vals,
1170 const cs_real_t *cell_vals,
1171 cs_flag_t location,
1172 cs_real_t t_eval,
1173 cs_real_t *diff_flux);
1174
1175/*----------------------------------------------------------------------------*/
1182/*----------------------------------------------------------------------------*/
1183
1184void
1185cs_equation_compute_vtx_field_gradient(const cs_equation_t *eq,
1186 cs_real_t *v_gradient);
1187
1188/*----------------------------------------------------------------------------*/
1197/*----------------------------------------------------------------------------*/
1198
1199void
1200cs_equation_compute_peclet(const cs_equation_t *eq,
1201 const cs_time_step_t *ts,
1202 cs_real_t peclet[]);
1203
1204/*----------------------------------------------------------------------------*/
1211/*----------------------------------------------------------------------------*/
1212
1213void
1214cs_equation_read_extra_restart(cs_restart_t *restart);
1215
1216/*----------------------------------------------------------------------------*/
1223/*----------------------------------------------------------------------------*/
1224
1225void
1226cs_equation_write_extra_restart(cs_restart_t *restart);
1227
1228/*----------------------------------------------------------------------------*/
1237/*----------------------------------------------------------------------------*/
1238
1239void
1240cs_equation_post_balance(const cs_mesh_t *mesh,
1241 const cs_cdo_connect_t *connect,
1242 const cs_cdo_quantities_t *cdoq,
1243 const cs_time_step_t *ts);
1244
1245/*----------------------------------------------------------------------------*/
1257/*----------------------------------------------------------------------------*/
1258
1259void
1260cs_equation_apply_stiffness(cs_equation_t *eq,
1261 const cs_property_t *property,
1262 const cs_real_t *pot,
1263 cs_flag_t loc_res,
1264 cs_real_t *res);
1265
1266/*----------------------------------------------------------------------------*/
1271/*----------------------------------------------------------------------------*/
1272
1273void
1274cs_equation_extra_post(void);
1275
1276/*----------------------------------------------------------------------------*/
1277
1278END_C_DECLS
1279
1280#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:542
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
cs_real_3_t
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:359
cs_gnum_t
uint64_t cs_gnum_t
global mesh entity number
Definition: cs_defs.h:325
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543
cs_flag_t
unsigned short int cs_flag_t
Definition: cs_defs.h:344
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:1642
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:1930
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:3195
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:1358
cs_equation_define_builders
void cs_equation_define_builders(const cs_mesh_t *mesh)
Allocate and define the builder structure.
Definition: cs_equation.cpp:2777
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:2721
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:952
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:678
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:2019
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:2676
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:4230
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:980
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:4043
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:1053
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:4068
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:778
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:658
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:1592
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:1855
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:2070
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:4020
cs_equation_set_sles
void cs_equation_set_sles(void)
Setup the linear algebra requirements.
Definition: cs_equation.cpp:1885
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:3106
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:1334
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:1194
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:1725
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:3070
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:932
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:1312
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:1102
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:736
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:1172
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:600
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:1802
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.
Definition: cs_equation.cpp:1424
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:2806
cs_equation_log_monitoring
void cs_equation_log_monitoring(void)
Print a synthesis of the monitoring information in the performance file.
Definition: cs_equation.cpp:1747
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:697
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:3247
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:536
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:2854
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:3931
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:2883
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:912
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:811
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:3710
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:1399
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:1031
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:568
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:1077
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:3221
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:3605
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:503
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:3139
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:3301
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:2935
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:4188
cs_equation_destroy_all
void cs_equation_destroy_all(void)
Destroy all cs_equation_t structures.
Definition: cs_equation.cpp:1678
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:3441
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:3168
cs_equation_log_setup
void cs_equation_log_setup(void)
Summarize all cs_equation_t structures.
Definition: cs_equation.cpp:1818
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:2748
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:1125
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:3273
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:890
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:717
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:1236
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:1259
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:1462
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:756
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:633
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:1215
cs_equation_get_n_equations
int cs_equation_get_n_equations(void)
Retrieve the number of equations.
Definition: cs_equation.cpp:486
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:3972
cs_equation_solve_deprecated
void cs_equation_solve_deprecated(cs_equation_t *eq)
Solve the linear system for this equation (deprecated). Only for HHO schemes.
Definition: cs_equation.cpp:2963
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:1195
cs_equation_type_t
cs_equation_type_t
Type of equations managed by the solver.
Definition: cs_equation_param.h:171
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:481
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:321
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: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_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:192
cs_equation_t
Main structure to handle the discretization and the resolution of an equation.
cs_field_t
Field descriptor.
Definition: cs_field.h:131
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