8.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-2023 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_param.h"
36 #include "cs_equation_builder.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 
44 BEGIN_C_DECLS
45 
46 /*============================================================================
47  * Macro definitions
48  *============================================================================*/
49 
50 /*============================================================================
51  * Type definitions
52  *============================================================================*/
53 
54 typedef struct _cs_equation_t cs_equation_t;
55 
82 typedef 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 
102 int
103 cs_equation_get_n_equations(void);
104 
105 /*----------------------------------------------------------------------------*/
114 /*----------------------------------------------------------------------------*/
115 
116 cs_equation_t *
117 cs_equation_by_name(const char *eqname);
118 
119 /*----------------------------------------------------------------------------*/
128 /*----------------------------------------------------------------------------*/
129 
130 cs_equation_t *
131 cs_equation_by_field_name(const char *field_name);
132 
133 /*----------------------------------------------------------------------------*/
144 /*----------------------------------------------------------------------------*/
145 
146 bool
147 cs_equation_has_field_name(const cs_equation_t *eq,
148  const char *fld_name);
149 
150 /*----------------------------------------------------------------------------*/
163 /*----------------------------------------------------------------------------*/
164 
165 cs_equation_param_t *
166 cs_equation_param_by_name(const char *eqname);
167 
168 /*----------------------------------------------------------------------------*/
178 /*----------------------------------------------------------------------------*/
179 
180 cs_equation_param_t *
181 cs_equation_param_by_field_name(const char *field_name);
182 
183 /*----------------------------------------------------------------------------*/
192 /*----------------------------------------------------------------------------*/
193 
194 cs_equation_param_t *
195 cs_equation_get_param(const cs_equation_t *eq);
196 
197 /*----------------------------------------------------------------------------*/
206 /*----------------------------------------------------------------------------*/
207 
208 cs_equation_t *
209 cs_equation_by_id(int eq_id);
210 
211 /*----------------------------------------------------------------------------*/
219 /*----------------------------------------------------------------------------*/
220 
221 const char *
222 cs_equation_get_name(const cs_equation_t *eq);
223 
224 /*----------------------------------------------------------------------------*/
232 /*----------------------------------------------------------------------------*/
233 
234 int
235 cs_equation_get_id(const cs_equation_t *eq);
236 
237 /*----------------------------------------------------------------------------*/
245 /*----------------------------------------------------------------------------*/
246 
247 cs_field_t *
248 cs_equation_get_field(const cs_equation_t *eq);
249 
250 /*----------------------------------------------------------------------------*/
259 /*----------------------------------------------------------------------------*/
260 
261 int
262 cs_equation_get_field_id(const cs_equation_t *eq);
263 
264 /*----------------------------------------------------------------------------*/
275 /*----------------------------------------------------------------------------*/
276 
277 const cs_range_set_t *
278 cs_equation_get_range_set(const cs_equation_t *eq);
279 
280 /*----------------------------------------------------------------------------*/
290 /*----------------------------------------------------------------------------*/
291 
292 cs_gnum_t
293 cs_equation_get_global_n_dofs(const cs_equation_t *eq,
294  const cs_cdo_quantities_t *cdoq);
295 
296 /*----------------------------------------------------------------------------*/
305 /*----------------------------------------------------------------------------*/
306 
307 cs_field_t *
308 cs_equation_get_boundary_flux(const cs_equation_t *eq);
309 
310 /*----------------------------------------------------------------------------*/
318 /*----------------------------------------------------------------------------*/
319 
320 cs_flag_t
321 cs_equation_get_flag(const cs_equation_t *eq);
322 
323 /*----------------------------------------------------------------------------*/
330 /*----------------------------------------------------------------------------*/
331 
332 void
333 cs_equation_set_flag(cs_equation_t *eq,
334  cs_flag_t flag);
335 
336 /*----------------------------------------------------------------------------*/
347 /*----------------------------------------------------------------------------*/
348 
349 void
350 cs_equation_add_build_hook(cs_equation_t *eq,
351  void *context,
352  cs_equation_build_hook_t *func);
353 
354 /*----------------------------------------------------------------------------*/
363 /*----------------------------------------------------------------------------*/
364 
365 cs_equation_builder_t *
366 cs_equation_get_builder(const cs_equation_t *eq);
367 
368 /*----------------------------------------------------------------------------*/
377 /*----------------------------------------------------------------------------*/
378 
379 void *
380 cs_equation_get_scheme_context(const cs_equation_t *eq);
381 
382 /*----------------------------------------------------------------------------*/
391 /*----------------------------------------------------------------------------*/
392 
393 cs_equation_core_t
394 cs_equation_get_core_structure(const cs_equation_t *eq);
395 
396 /*----------------------------------------------------------------------------*/
406 /*----------------------------------------------------------------------------*/
407 
408 cs_real_t *
409 cs_equation_get_source_term_array(const cs_equation_t *eq);
410 
411 /*----------------------------------------------------------------------------*/
419 /*----------------------------------------------------------------------------*/
420 
421 bool
422 cs_equation_is_steady(const cs_equation_t *eq);
423 
424 /*----------------------------------------------------------------------------*/
433 /*----------------------------------------------------------------------------*/
434 
435 bool
436 cs_equation_uses_new_mechanism(const cs_equation_t *eq);
437 
438 /*----------------------------------------------------------------------------*/
450 /*----------------------------------------------------------------------------*/
451 
452 cs_equation_t *
453 cs_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 
472 cs_equation_t *
473 cs_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 
497 cs_equation_t *
498 cs_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 
511 void
512 cs_equation_destroy_all(void);
513 
514 /*----------------------------------------------------------------------------*/
521 /*----------------------------------------------------------------------------*/
522 
523 bool
524 cs_equation_needs_steady_state_solve(void);
525 
526 /*----------------------------------------------------------------------------*/
531 /*----------------------------------------------------------------------------*/
532 
533 void
534 cs_equation_log_monitoring(void);
535 
536 /*----------------------------------------------------------------------------*/
544 /*----------------------------------------------------------------------------*/
545 
546 void
547 cs_equation_get_count(int *n_equations,
548  int *n_predef_equations,
549  int *n_user_equations);
550 
551 /*----------------------------------------------------------------------------*/
555 /*----------------------------------------------------------------------------*/
556 
557 void
558 cs_equation_log_setup(void);
559 
560 /*----------------------------------------------------------------------------*/
567 /*----------------------------------------------------------------------------*/
568 
569 void
570 cs_equation_set_default_param(cs_equation_key_t key,
571  const char *keyval);
572 
573 /*----------------------------------------------------------------------------*/
577 /*----------------------------------------------------------------------------*/
578 
579 void
580 cs_equation_set_sles(void);
581 
582 /*----------------------------------------------------------------------------*/
597 /*----------------------------------------------------------------------------*/
598 
599 void
600 cs_equation_init_sharing(const cs_cdo_connect_t *connect,
601  const cs_cdo_quantities_t *cdoq,
602  const cs_time_step_t *time_step,
603  cs_flag_t cb_scheme_flag,
604  cs_flag_t eb_scheme_flag,
605  cs_flag_t fb_scheme_flag,
606  cs_flag_t vb_scheme_flag,
607  cs_flag_t vcb_scheme_flag,
608  cs_flag_t hho_scheme_flag);
609 
610 /*----------------------------------------------------------------------------*/
621 /*----------------------------------------------------------------------------*/
622 
623 void
624 cs_equation_finalize_sharing(cs_flag_t cb_scheme_flag,
625  cs_flag_t eb_scheme_flag,
626  cs_flag_t fb_scheme_flag,
627  cs_flag_t vb_scheme_flag,
628  cs_flag_t vcb_scheme_flag,
629  cs_flag_t hho_scheme_flag);
630 
631 /*----------------------------------------------------------------------------*/
640 /*----------------------------------------------------------------------------*/
641 
642 bool
643 cs_equation_set_functions(void);
644 
645 /*----------------------------------------------------------------------------*/
650 /*----------------------------------------------------------------------------*/
651 
652 void
653 cs_equation_lock_settings(void);
654 
655 /*----------------------------------------------------------------------------*/
671 /*----------------------------------------------------------------------------*/
672 
673 void
674 cs_equation_predefined_create_field(int n_previous,
675  cs_equation_t *eq);
676 
677 /*----------------------------------------------------------------------------*/
681 /*----------------------------------------------------------------------------*/
682 
683 void
684 cs_equation_user_create_fields(void);
685 
686 /*----------------------------------------------------------------------------*/
692 /*----------------------------------------------------------------------------*/
693 
694 void
695 cs_equation_define_builders(const cs_mesh_t *mesh);
696 
697 /*----------------------------------------------------------------------------*/
701 /*----------------------------------------------------------------------------*/
702 
703 void
704 cs_equation_define_context_structures(void);
705 
706 /*----------------------------------------------------------------------------*/
714 /*----------------------------------------------------------------------------*/
715 
716 void
717 cs_equation_define_core_structure(const cs_equation_t *eq,
718  cs_equation_core_t **p_core);
719 
720 /*----------------------------------------------------------------------------*/
728 /*----------------------------------------------------------------------------*/
729 
730 void
731 cs_equation_init_field_values(const cs_mesh_t *mesh,
732  const cs_time_step_t *ts);
733 
734 /*----------------------------------------------------------------------------*/
742 /*----------------------------------------------------------------------------*/
743 
744 void
745 cs_equation_solve_steady_state(const cs_mesh_t *mesh,
746  cs_equation_t *eq);
747 
748 /*----------------------------------------------------------------------------*/
757 /*----------------------------------------------------------------------------*/
758 
759 void
760 cs_equation_solve(bool cur2prev,
761  const cs_mesh_t *mesh,
762  cs_equation_t *eq);
763 
764 /*----------------------------------------------------------------------------*/
772 /*----------------------------------------------------------------------------*/
773 
774 void
775 cs_equation_solve_steady_state_wrapper(const char *eqname);
776 
777 /*----------------------------------------------------------------------------*/
786 /*----------------------------------------------------------------------------*/
787 
788 void
789 cs_equation_solve_wrapper(bool cur2prev,
790  const char *eqname);
791 
792 /*----------------------------------------------------------------------------*/
799 /*----------------------------------------------------------------------------*/
800 
801 void
802 cs_equation_build_system(const cs_mesh_t *mesh,
803  cs_equation_t *eq);
804 
805 /*----------------------------------------------------------------------------*/
811 /*----------------------------------------------------------------------------*/
812 
813 void
814 cs_equation_solve_deprecated(cs_equation_t *eq);
815 
816 /*----------------------------------------------------------------------------*/
825 /*----------------------------------------------------------------------------*/
826 
827 cs_property_t *
828 cs_equation_get_diffusion_property(const cs_equation_t *eq);
829 
830 /*----------------------------------------------------------------------------*/
839 /*----------------------------------------------------------------------------*/
840 
841 cs_property_t *
842 cs_equation_get_time_property(const cs_equation_t *eq);
843 
844 /*----------------------------------------------------------------------------*/
855 /*----------------------------------------------------------------------------*/
856 
857 cs_property_t *
858 cs_equation_get_reaction_property(const cs_equation_t *eq,
859  const int reaction_id);
860 
861 /*----------------------------------------------------------------------------*/
870 /*----------------------------------------------------------------------------*/
871 
872 cs_param_time_scheme_t
873 cs_equation_get_time_scheme(const cs_equation_t *eq);
874 
875 /*----------------------------------------------------------------------------*/
885 /*----------------------------------------------------------------------------*/
886 
887 cs_real_t
888 cs_equation_get_theta_time_val(const cs_equation_t *eq);
889 
890 /*----------------------------------------------------------------------------*/
899 /*----------------------------------------------------------------------------*/
900 
901 cs_param_space_scheme_t
902 cs_equation_get_space_scheme(const cs_equation_t *eq);
903 
904 /*----------------------------------------------------------------------------*/
913 /*----------------------------------------------------------------------------*/
914 
915 int
916 cs_equation_get_space_poly_degree(const cs_equation_t *eq);
917 
918 /*----------------------------------------------------------------------------*/
926 /*----------------------------------------------------------------------------*/
927 
928 int
929 cs_equation_get_var_dim(const cs_equation_t *eq);
930 
931 /*----------------------------------------------------------------------------*/
939 /*----------------------------------------------------------------------------*/
940 
941 cs_equation_type_t
942 cs_equation_get_type(const cs_equation_t *eq);
943 
944 /*----------------------------------------------------------------------------*/
954 /*----------------------------------------------------------------------------*/
955 
956 double
957 cs_equation_get_time_eval(const cs_time_step_t *ts,
958  const cs_equation_t *eq);
959 
960 /*----------------------------------------------------------------------------*/
968 /*----------------------------------------------------------------------------*/
969 
970 void
971 cs_equation_current_to_previous(const cs_equation_t *eq);
972 
973 /*----------------------------------------------------------------------------*/
982 /*----------------------------------------------------------------------------*/
983 
984 void
985 cs_equation_get_cellwise_builders(const cs_equation_t *eq,
986  cs_cell_sys_t **csys,
987  cs_cell_builder_t **cb);
988 
989 /*----------------------------------------------------------------------------*/
999 /*----------------------------------------------------------------------------*/
1000 
1001 cs_real_t *
1002 cs_equation_get_cell_values(const cs_equation_t *eq,
1003  bool previous);
1004 
1005 /*----------------------------------------------------------------------------*/
1015 /*----------------------------------------------------------------------------*/
1016 
1017 cs_real_t *
1018 cs_equation_get_face_values(const cs_equation_t *eq,
1019  bool previous);
1020 
1021 /*----------------------------------------------------------------------------*/
1031 /*----------------------------------------------------------------------------*/
1032 
1033 cs_real_t *
1034 cs_equation_get_edge_values(const cs_equation_t *eq,
1035  bool previous);
1036 
1037 /*----------------------------------------------------------------------------*/
1047 /*----------------------------------------------------------------------------*/
1048 
1049 cs_real_t *
1050 cs_equation_get_vertex_values(const cs_equation_t *eq,
1051  bool previous);
1052 
1053 /*----------------------------------------------------------------------------*/
1065 /*----------------------------------------------------------------------------*/
1066 
1067 void
1068 cs_equation_integrate_variable(const cs_cdo_connect_t *connect,
1069  const cs_cdo_quantities_t *cdoq,
1070  const cs_equation_t *eq,
1071  cs_real_t *result);
1072 
1073 /*----------------------------------------------------------------------------*/
1084 /*----------------------------------------------------------------------------*/
1085 
1086 void
1087 cs_equation_compute_boundary_diff_flux(cs_real_t t_eval,
1088  const cs_equation_t *eq,
1089  cs_real_t *diff_flux);
1090 
1091 /*----------------------------------------------------------------------------*/
1102 /*----------------------------------------------------------------------------*/
1103 
1104 void
1105 cs_equation_compute_flux_across_plane(const cs_equation_t *eq,
1106  const char *ml_name,
1107  const cs_real_3_t direction,
1108  cs_real_t *diff_flux,
1109  cs_real_t *conv_flux);
1110 
1111 /*----------------------------------------------------------------------------*/
1150 /*----------------------------------------------------------------------------*/
1151 
1152 void
1153 cs_equation_compute_diffusive_flux(const cs_equation_t *eq,
1154  const cs_equation_param_t *eqp,
1155  const cs_property_t *diff_pty,
1156  const cs_real_t *dof_vals,
1157  const cs_real_t *cell_vals,
1158  cs_flag_t location,
1159  cs_real_t t_eval,
1160  cs_real_t *diff_flux);
1161 
1162 /*----------------------------------------------------------------------------*/
1169 /*----------------------------------------------------------------------------*/
1170 
1171 void
1172 cs_equation_compute_vtx_field_gradient(const cs_equation_t *eq,
1173  cs_real_t *v_gradient);
1174 
1175 /*----------------------------------------------------------------------------*/
1184 /*----------------------------------------------------------------------------*/
1185 
1186 void
1187 cs_equation_compute_peclet(const cs_equation_t *eq,
1188  const cs_time_step_t *ts,
1189  cs_real_t peclet[]);
1190 
1191 /*----------------------------------------------------------------------------*/
1198 /*----------------------------------------------------------------------------*/
1199 
1200 void
1201 cs_equation_read_extra_restart(cs_restart_t *restart);
1202 
1203 /*----------------------------------------------------------------------------*/
1210 /*----------------------------------------------------------------------------*/
1211 
1212 void
1213 cs_equation_write_extra_restart(cs_restart_t *restart);
1214 
1215 /*----------------------------------------------------------------------------*/
1224 /*----------------------------------------------------------------------------*/
1225 
1226 void
1227 cs_equation_post_balance(const cs_mesh_t *mesh,
1228  const cs_cdo_connect_t *connect,
1229  const cs_cdo_quantities_t *cdoq,
1230  const cs_time_step_t *ts);
1231 
1232 /*----------------------------------------------------------------------------*/
1244 /*----------------------------------------------------------------------------*/
1245 
1246 void
1247 cs_equation_apply_stiffness(cs_equation_t *eq,
1248  const cs_property_t *property,
1249  const cs_real_t *pot,
1250  cs_flag_t loc_res,
1251  cs_real_t *res);
1252 
1253 /*----------------------------------------------------------------------------*/
1258 /*----------------------------------------------------------------------------*/
1259 
1260 void
1261 cs_equation_extra_post(void);
1262 
1263 /*----------------------------------------------------------------------------*/
1264 
1265 END_C_DECLS
1266 
1267 #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:514
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:319
cs_real_3_t
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:334
cs_gnum_t
unsigned long cs_gnum_t
global mesh entity number
Definition: cs_defs.h:298
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:515
cs_flag_t
unsigned short int cs_flag_t
Definition: cs_defs.h:321
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.c:1372
cs_equation_by_name
cs_equation_t * cs_equation_by_name(const char *eqname)
Find the cs_equation_t structure with name eqname Return NULL if not find.
Definition: cs_equation.c:516
cs_equation_define_builders
void cs_equation_define_builders(const cs_mesh_t *mesh)
Allocate and define the builder structure.
Definition: cs_equation.c:2698
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.c:2642
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.c:1090
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.c:963
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.c:3170
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.c:2597
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.c:4108
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.c:1476
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.c:550
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.c:1606
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.c:3908
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)
Free shared local structures among the discretization schemes.
Definition: cs_equation.c:2008
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.c:3933
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.c:1858
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.c:2055
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.c:3885
cs_equation_set_sles
void cs_equation_set_sles(void)
Setup the linear algebra requirements.
Definition: cs_equation.c:1888
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.c:3002
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.c:1348
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.c:1208
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.c:1735
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.c:2966
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.c:3196
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.c:1326
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.c:1115
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.c:992
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.c:1186
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.c:1806
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.c:1438
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.c:3222
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.c:2727
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.c:901
cs_equation_log_monitoring
void cs_equation_log_monitoring(void)
Print a synthesis of the monitoring information in the performance file.
Definition: cs_equation.c:1757
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.c:614
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.c:2774
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 NULL if not find.
Definition: cs_equation.c:693
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.c:1044
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.c:673
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.c:923
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.c:3795
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.c:3248
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.c:648
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.c:2803
cs_equation_solve_wrapper
void cs_equation_solve_wrapper(bool cur2prev, const char *eqname)
Build and then solve the linear system for an equation with an unsteady term. This is wrapper for the...
Definition: cs_equation.c:3077
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.c:829
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.c:1066
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.c:3579
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.c:1413
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.c:582
cs_equation_compute_boundary_diff_flux
void cs_equation_compute_boundary_diff_flux(cs_real_t t_eval, const cs_equation_t *eq, cs_real_t *diff_flux)
Compute the diffusive flux across all boundary faces According to the space discretization scheme,...
Definition: cs_equation.c:3391
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.c:3476
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.c:3114
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.c:3276
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)
Definition: cs_equation.c:2854
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.c:4061
cs_equation_destroy_all
void cs_equation_destroy_all(void)
Destroy all cs_equation_t structures.
Definition: cs_equation.c:1691
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.c:713
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.c:753
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.c:3143
cs_equation_log_setup
void cs_equation_log_setup(void)
Summarize all cs_equation_t structures.
Definition: cs_equation.c:1822
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.c:2669
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.c:1138
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.c:943
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.c:733
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.c:1250
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.c:1655
cs_equation_init_sharing
void cs_equation_init_sharing(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)
Set shared pointers to the main structures. Associate these structures among the activated class of d...
Definition: cs_equation.c:1930
cs_equation_solve_steady_state_wrapper
void cs_equation_solve_steady_state_wrapper(const char *eqname)
Build and then solve the linear system for a steady-state equation. This is wrapper for the FORTRAN i...
Definition: cs_equation.c:3039
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.c:1273
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.c:773
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.c:795
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.c:1229
cs_equation_get_n_equations
int cs_equation_get_n_equations(void)
Retrieve the number of equations.
Definition: cs_equation.c:499
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.c:3835
cs_equation_solve_deprecated
void cs_equation_solve_deprecated(cs_equation_t *eq)
Solve the linear system for this equation (deprecated)
Definition: cs_equation.c:2881
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:1212
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:211
cs_param_bc_type_t
cs_param_bc_type_t
Definition: cs_param_types.h:476
cs_param_time_scheme_t
cs_param_time_scheme_t
Definition: cs_param_types.h:274
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:150
cs_cdo_connect_t
Definition: cs_cdo_connect.h:61
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:137
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