8.0
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 /*----------------------------------------------------------------------------*/
404 /*----------------------------------------------------------------------------*/
405 
406 bool
407 cs_equation_is_steady(const cs_equation_t *eq);
408 
409 /*----------------------------------------------------------------------------*/
418 /*----------------------------------------------------------------------------*/
419 
420 bool
421 cs_equation_uses_new_mechanism(const cs_equation_t *eq);
422 
423 /*----------------------------------------------------------------------------*/
435 /*----------------------------------------------------------------------------*/
436 
437 cs_equation_t *
438 cs_equation_add(const char *eqname,
439  const char *varname,
440  cs_equation_type_t eqtype,
441  int dim,
442  cs_param_bc_type_t default_bc);
443 
444 /*----------------------------------------------------------------------------*/
455 /*----------------------------------------------------------------------------*/
456 
457 cs_equation_t *
458 cs_equation_add_user(const char *eqname,
459  const char *varname,
460  int dim,
461  cs_param_bc_type_t default_bc);
462 
463 /*----------------------------------------------------------------------------*/
480 /*----------------------------------------------------------------------------*/
481 
482 cs_equation_t *
483 cs_equation_add_user_tracer(const char *eqname,
484  const char *varname,
485  int dim,
486  cs_param_bc_type_t default_bc,
487  cs_property_t *time_pty,
488  cs_adv_field_t *adv,
489  cs_property_t *diff_pty);
490 /*----------------------------------------------------------------------------*/
494 /*----------------------------------------------------------------------------*/
495 
496 void
497 cs_equation_destroy_all(void);
498 
499 /*----------------------------------------------------------------------------*/
506 /*----------------------------------------------------------------------------*/
507 
508 bool
509 cs_equation_needs_steady_state_solve(void);
510 
511 /*----------------------------------------------------------------------------*/
516 /*----------------------------------------------------------------------------*/
517 
518 void
519 cs_equation_log_monitoring(void);
520 
521 /*----------------------------------------------------------------------------*/
529 /*----------------------------------------------------------------------------*/
530 
531 void
532 cs_equation_get_count(int *n_equations,
533  int *n_predef_equations,
534  int *n_user_equations);
535 
536 /*----------------------------------------------------------------------------*/
540 /*----------------------------------------------------------------------------*/
541 
542 void
543 cs_equation_log_setup(void);
544 
545 /*----------------------------------------------------------------------------*/
552 /*----------------------------------------------------------------------------*/
553 
554 void
555 cs_equation_set_default_param(cs_equation_key_t key,
556  const char *keyval);
557 
558 /*----------------------------------------------------------------------------*/
562 /*----------------------------------------------------------------------------*/
563 
564 void
565 cs_equation_set_sles(void);
566 
567 /*----------------------------------------------------------------------------*/
582 /*----------------------------------------------------------------------------*/
583 
584 void
585 cs_equation_init_sharing(const cs_cdo_connect_t *connect,
586  const cs_cdo_quantities_t *cdoq,
587  const cs_time_step_t *time_step,
588  cs_flag_t cb_scheme_flag,
589  cs_flag_t eb_scheme_flag,
590  cs_flag_t fb_scheme_flag,
591  cs_flag_t vb_scheme_flag,
592  cs_flag_t vcb_scheme_flag,
593  cs_flag_t hho_scheme_flag);
594 
595 /*----------------------------------------------------------------------------*/
606 /*----------------------------------------------------------------------------*/
607 
608 void
609 cs_equation_finalize_sharing(cs_flag_t cb_scheme_flag,
610  cs_flag_t eb_scheme_flag,
611  cs_flag_t fb_scheme_flag,
612  cs_flag_t vb_scheme_flag,
613  cs_flag_t vcb_scheme_flag,
614  cs_flag_t hho_scheme_flag);
615 
616 /*----------------------------------------------------------------------------*/
625 /*----------------------------------------------------------------------------*/
626 
627 bool
628 cs_equation_set_functions(void);
629 
630 /*----------------------------------------------------------------------------*/
635 /*----------------------------------------------------------------------------*/
636 
637 void
638 cs_equation_lock_settings(void);
639 
640 /*----------------------------------------------------------------------------*/
656 /*----------------------------------------------------------------------------*/
657 
658 void
659 cs_equation_predefined_create_field(int n_previous,
660  cs_equation_t *eq);
661 
662 /*----------------------------------------------------------------------------*/
666 /*----------------------------------------------------------------------------*/
667 
668 void
669 cs_equation_user_create_fields(void);
670 
671 /*----------------------------------------------------------------------------*/
677 /*----------------------------------------------------------------------------*/
678 
679 void
680 cs_equation_define_builders(const cs_mesh_t *mesh);
681 
682 /*----------------------------------------------------------------------------*/
686 /*----------------------------------------------------------------------------*/
687 
688 void
689 cs_equation_define_context_structures(void);
690 
691 /*----------------------------------------------------------------------------*/
699 /*----------------------------------------------------------------------------*/
700 
701 void
702 cs_equation_define_core_structure(const cs_equation_t *eq,
703  cs_equation_core_t **p_core);
704 
705 /*----------------------------------------------------------------------------*/
713 /*----------------------------------------------------------------------------*/
714 
715 void
716 cs_equation_init_field_values(const cs_mesh_t *mesh,
717  const cs_time_step_t *ts);
718 
719 /*----------------------------------------------------------------------------*/
727 /*----------------------------------------------------------------------------*/
728 
729 void
730 cs_equation_solve_steady_state(const cs_mesh_t *mesh,
731  cs_equation_t *eq);
732 
733 /*----------------------------------------------------------------------------*/
742 /*----------------------------------------------------------------------------*/
743 
744 void
745 cs_equation_solve(bool cur2prev,
746  const cs_mesh_t *mesh,
747  cs_equation_t *eq);
748 
749 /*----------------------------------------------------------------------------*/
757 /*----------------------------------------------------------------------------*/
758 
759 void
760 cs_equation_solve_steady_state_wrapper(const char *eqname);
761 
762 /*----------------------------------------------------------------------------*/
771 /*----------------------------------------------------------------------------*/
772 
773 void
774 cs_equation_solve_wrapper(bool cur2prev,
775  const char *eqname);
776 
777 /*----------------------------------------------------------------------------*/
784 /*----------------------------------------------------------------------------*/
785 
786 void
787 cs_equation_build_system(const cs_mesh_t *mesh,
788  cs_equation_t *eq);
789 
790 /*----------------------------------------------------------------------------*/
796 /*----------------------------------------------------------------------------*/
797 
798 void
799 cs_equation_solve_deprecated(cs_equation_t *eq);
800 
801 /*----------------------------------------------------------------------------*/
810 /*----------------------------------------------------------------------------*/
811 
812 cs_property_t *
813 cs_equation_get_diffusion_property(const cs_equation_t *eq);
814 
815 /*----------------------------------------------------------------------------*/
824 /*----------------------------------------------------------------------------*/
825 
826 cs_property_t *
827 cs_equation_get_time_property(const cs_equation_t *eq);
828 
829 /*----------------------------------------------------------------------------*/
840 /*----------------------------------------------------------------------------*/
841 
842 cs_property_t *
843 cs_equation_get_reaction_property(const cs_equation_t *eq,
844  const int reaction_id);
845 
846 /*----------------------------------------------------------------------------*/
855 /*----------------------------------------------------------------------------*/
856 
857 cs_param_time_scheme_t
858 cs_equation_get_time_scheme(const cs_equation_t *eq);
859 
860 /*----------------------------------------------------------------------------*/
870 /*----------------------------------------------------------------------------*/
871 
872 cs_real_t
873 cs_equation_get_theta_time_val(const cs_equation_t *eq);
874 
875 /*----------------------------------------------------------------------------*/
884 /*----------------------------------------------------------------------------*/
885 
886 cs_param_space_scheme_t
887 cs_equation_get_space_scheme(const cs_equation_t *eq);
888 
889 /*----------------------------------------------------------------------------*/
898 /*----------------------------------------------------------------------------*/
899 
900 int
901 cs_equation_get_space_poly_degree(const cs_equation_t *eq);
902 
903 /*----------------------------------------------------------------------------*/
911 /*----------------------------------------------------------------------------*/
912 
913 int
914 cs_equation_get_var_dim(const cs_equation_t *eq);
915 
916 /*----------------------------------------------------------------------------*/
924 /*----------------------------------------------------------------------------*/
925 
926 cs_equation_type_t
927 cs_equation_get_type(const cs_equation_t *eq);
928 
929 /*----------------------------------------------------------------------------*/
939 /*----------------------------------------------------------------------------*/
940 
941 double
942 cs_equation_get_time_eval(const cs_time_step_t *ts,
943  const cs_equation_t *eq);
944 
945 /*----------------------------------------------------------------------------*/
953 /*----------------------------------------------------------------------------*/
954 
955 void
956 cs_equation_current_to_previous(const cs_equation_t *eq);
957 
958 /*----------------------------------------------------------------------------*/
967 /*----------------------------------------------------------------------------*/
968 
969 void
970 cs_equation_get_cellwise_builders(const cs_equation_t *eq,
971  cs_cell_sys_t **csys,
972  cs_cell_builder_t **cb);
973 
974 /*----------------------------------------------------------------------------*/
984 /*----------------------------------------------------------------------------*/
985 
986 cs_real_t *
987 cs_equation_get_cell_values(const cs_equation_t *eq,
988  bool previous);
989 
990 /*----------------------------------------------------------------------------*/
1000 /*----------------------------------------------------------------------------*/
1001 
1002 cs_real_t *
1003 cs_equation_get_face_values(const cs_equation_t *eq,
1004  bool previous);
1005 
1006 /*----------------------------------------------------------------------------*/
1016 /*----------------------------------------------------------------------------*/
1017 
1018 cs_real_t *
1019 cs_equation_get_edge_values(const cs_equation_t *eq,
1020  bool previous);
1021 
1022 /*----------------------------------------------------------------------------*/
1032 /*----------------------------------------------------------------------------*/
1033 
1034 cs_real_t *
1035 cs_equation_get_vertex_values(const cs_equation_t *eq,
1036  bool previous);
1037 
1038 /*----------------------------------------------------------------------------*/
1050 /*----------------------------------------------------------------------------*/
1051 
1052 void
1053 cs_equation_integrate_variable(const cs_cdo_connect_t *connect,
1054  const cs_cdo_quantities_t *cdoq,
1055  const cs_equation_t *eq,
1056  cs_real_t *result);
1057 
1058 /*----------------------------------------------------------------------------*/
1069 /*----------------------------------------------------------------------------*/
1070 
1071 void
1072 cs_equation_compute_boundary_diff_flux(cs_real_t t_eval,
1073  const cs_equation_t *eq,
1074  cs_real_t *diff_flux);
1075 
1076 /*----------------------------------------------------------------------------*/
1087 /*----------------------------------------------------------------------------*/
1088 
1089 void
1090 cs_equation_compute_flux_across_plane(const cs_equation_t *eq,
1091  const char *ml_name,
1092  const cs_real_3_t direction,
1093  cs_real_t *diff_flux,
1094  cs_real_t *conv_flux);
1095 
1096 /*----------------------------------------------------------------------------*/
1108 /*----------------------------------------------------------------------------*/
1109 
1110 void
1111 cs_equation_compute_diffusive_flux(const cs_equation_t *eq,
1112  cs_flag_t location,
1113  cs_real_t t_eval,
1114  cs_real_t *diff_flux);
1115 
1116 /*----------------------------------------------------------------------------*/
1123 /*----------------------------------------------------------------------------*/
1124 
1125 void
1126 cs_equation_compute_vtx_field_gradient(const cs_equation_t *eq,
1127  cs_real_t *v_gradient);
1128 
1129 /*----------------------------------------------------------------------------*/
1138 /*----------------------------------------------------------------------------*/
1139 
1140 void
1141 cs_equation_compute_peclet(const cs_equation_t *eq,
1142  const cs_time_step_t *ts,
1143  cs_real_t peclet[]);
1144 
1145 /*----------------------------------------------------------------------------*/
1152 /*----------------------------------------------------------------------------*/
1153 
1154 void
1155 cs_equation_read_extra_restart(cs_restart_t *restart);
1156 
1157 /*----------------------------------------------------------------------------*/
1164 /*----------------------------------------------------------------------------*/
1165 
1166 void
1167 cs_equation_write_extra_restart(cs_restart_t *restart);
1168 
1169 /*----------------------------------------------------------------------------*/
1178 /*----------------------------------------------------------------------------*/
1179 
1180 void
1181 cs_equation_post_balance(const cs_mesh_t *mesh,
1182  const cs_cdo_connect_t *connect,
1183  const cs_cdo_quantities_t *cdoq,
1184  const cs_time_step_t *ts);
1185 
1186 /*----------------------------------------------------------------------------*/
1198 /*----------------------------------------------------------------------------*/
1199 
1200 void
1201 cs_equation_apply_stiffness(cs_equation_t *eq,
1202  const cs_property_t *property,
1203  const cs_real_t *pot,
1204  cs_flag_t loc_res,
1205  cs_real_t *res);
1206 
1207 /*----------------------------------------------------------------------------*/
1212 /*----------------------------------------------------------------------------*/
1213 
1214 void
1215 cs_equation_extra_post(void);
1216 
1217 /*----------------------------------------------------------------------------*/
1218 
1219 END_C_DECLS
1220 
1221 #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:509
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:332
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:510
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:924
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:472
cs_equation_define_builders
void cs_equation_define_builders(const cs_mesh_t *mesh)
Allocate and define the builder structure.
Definition: cs_equation.c:2601
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:2545
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:1080
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:1006
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:3068
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:2500
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:3868
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:1379
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:506
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:1509
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:3668
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:1911
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:3693
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:1761
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:1958
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:3645
cs_equation_set_sles
void cs_equation_set_sles(void)
Setup the linear algebra requirements.
Definition: cs_equation.c:1791
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:2900
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:900
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:1198
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:1638
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:2864
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:3094
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:878
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:1105
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:1176
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:1709
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:1341
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:3120
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:2630
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:857
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:1660
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:570
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:2672
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:649
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:1034
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:629
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:966
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:3555
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:3146
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:604
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:2701
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:2975
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:785
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:1056
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:1316
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:538
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:3289
cs_equation_compute_diffusive_flux
void cs_equation_compute_diffusive_flux(const cs_equation_t *eq, cs_flag_t location, cs_real_t t_eval, cs_real_t *diff_flux)
Cellwise computation of the diffusive flux across the requested location. If the location is not the ...
Definition: cs_equation.c:3450
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:3374
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:3012
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:3174
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:2752
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:3821
cs_equation_destroy_all
void cs_equation_destroy_all(void)
Destroy all cs_equation_t structures.
Definition: cs_equation.c:1594
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:669
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:709
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:3041
cs_equation_log_setup
void cs_equation_log_setup(void)
Summarize all cs_equation_t structures.
Definition: cs_equation.c:1725
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:2572
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:1128
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:986
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:689
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:1240
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:1558
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:1833
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:2937
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:1263
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:729
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:751
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:1219
cs_equation_get_n_equations
int cs_equation_get_n_equations(void)
Retrieve the number of equations.
Definition: cs_equation.c:455
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:3595
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:2779
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:1211
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:475
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:130
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