7.0
general documentation
•All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
cs_equation.h
Go to the documentation of this file.
1 #ifndef __CS_EQUATION_H__
2 #define __CS_EQUATION_H__
3 
4 /*============================================================================
5  * Routines to handle 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-2021 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_equation_param.h"
35 #include "cs_equation_common.h"
36 #include "cs_field.h"
37 #include "cs_mesh.h"
38 #include "cs_restart.h"
39 #include "cs_time_step.h"
40 
41 /*----------------------------------------------------------------------------*/
42 
43 BEGIN_C_DECLS
44 
45 /*============================================================================
46  * Macro definitions
47  *============================================================================*/
48 
49 /*============================================================================
50  * Type definitions
51  *============================================================================*/
52 
53 typedef struct _cs_equation_t cs_equation_t;
54 
55 /*============================================================================
56  * Public function prototypes
57  *============================================================================*/
58 
59 /*----------------------------------------------------------------------------*/
65 /*----------------------------------------------------------------------------*/
66 
67 int
68 cs_equation_get_n_equations(void);
69 
70 /*----------------------------------------------------------------------------*/
79 /*----------------------------------------------------------------------------*/
80 
81 cs_equation_t *
82 cs_equation_by_name(const char *eqname);
83 
84 /*----------------------------------------------------------------------------*/
93 /*----------------------------------------------------------------------------*/
94 
95 cs_equation_t *
96 cs_equation_by_field_name(const char *field_name);
97 
98 /*----------------------------------------------------------------------------*/
109 /*----------------------------------------------------------------------------*/
110 
111 bool
112 cs_equation_has_field_name(const cs_equation_t *eq,
113  const char *fld_name);
114 
115 /*----------------------------------------------------------------------------*/
124 /*----------------------------------------------------------------------------*/
125 
126 cs_equation_param_t *
127 cs_equation_param_by_name(const char *eqname);
128 
129 /*----------------------------------------------------------------------------*/
139 /*----------------------------------------------------------------------------*/
140 
141 cs_equation_param_t *
142 cs_equation_param_by_field_name(const char *field_name);
143 
144 /*----------------------------------------------------------------------------*/
153 /*----------------------------------------------------------------------------*/
154 
155 cs_equation_param_t *
156 cs_equation_get_param(const cs_equation_t *eq);
157 
158 /*----------------------------------------------------------------------------*/
167 /*----------------------------------------------------------------------------*/
168 
169 cs_equation_t *
170 cs_equation_by_id(int eq_id);
171 
172 /*----------------------------------------------------------------------------*/
180 /*----------------------------------------------------------------------------*/
181 
182 const char *
183 cs_equation_get_name(const cs_equation_t *eq);
184 
185 /*----------------------------------------------------------------------------*/
193 /*----------------------------------------------------------------------------*/
194 
195 int
196 cs_equation_get_id(const cs_equation_t *eq);
197 
198 /*----------------------------------------------------------------------------*/
206 /*----------------------------------------------------------------------------*/
207 
208 cs_field_t *
209 cs_equation_get_field(const cs_equation_t *eq);
210 
211 /*----------------------------------------------------------------------------*/
220 /*----------------------------------------------------------------------------*/
221 
222 int
223 cs_equation_get_field_id(const cs_equation_t *eq);
224 
225 /*----------------------------------------------------------------------------*/
234 /*----------------------------------------------------------------------------*/
235 
236 const cs_range_set_t *
237 cs_equation_get_range_set(const cs_equation_t *eq);
238 
239 /*----------------------------------------------------------------------------*/
249 /*----------------------------------------------------------------------------*/
250 
251 cs_gnum_t
252 cs_equation_get_global_n_dofs(const cs_equation_t *eq,
253  const cs_cdo_quantities_t *cdoq);
254 
255 /*----------------------------------------------------------------------------*/
264 /*----------------------------------------------------------------------------*/
265 
266 cs_field_t *
267 cs_equation_get_boundary_flux(const cs_equation_t *eq);
268 
269 /*----------------------------------------------------------------------------*/
277 /*----------------------------------------------------------------------------*/
278 
279 cs_flag_t
280 cs_equation_get_flag(const cs_equation_t *eq);
281 
282 /*----------------------------------------------------------------------------*/
289 /*----------------------------------------------------------------------------*/
290 
291 void
292 cs_equation_set_flag(cs_equation_t *eq,
293  cs_flag_t flag);
294 
295 /*----------------------------------------------------------------------------*/
306 /*----------------------------------------------------------------------------*/
307 
308 void
309 cs_equation_add_user_hook(cs_equation_t *eq,
310  void *context,
311  cs_equation_user_hook_t *func);
312 
313 /*----------------------------------------------------------------------------*/
322 /*----------------------------------------------------------------------------*/
323 
324 cs_equation_builder_t *
325 cs_equation_get_builder(const cs_equation_t *eq);
326 
327 /*----------------------------------------------------------------------------*/
336 /*----------------------------------------------------------------------------*/
337 
338 void *
339 cs_equation_get_scheme_context(const cs_equation_t *eq);
340 
341 /*----------------------------------------------------------------------------*/
349 /*----------------------------------------------------------------------------*/
350 
351 bool
352 cs_equation_is_steady(const cs_equation_t *eq);
353 
354 /*----------------------------------------------------------------------------*/
362 /*----------------------------------------------------------------------------*/
363 
364 bool
365 cs_equation_uses_new_mechanism(const cs_equation_t *eq);
366 
367 /*----------------------------------------------------------------------------*/
379 /*----------------------------------------------------------------------------*/
380 
381 cs_equation_t *
382 cs_equation_add(const char *eqname,
383  const char *varname,
384  cs_equation_type_t eqtype,
385  int dim,
386  cs_param_bc_type_t default_bc);
387 
388 /*----------------------------------------------------------------------------*/
399 /*----------------------------------------------------------------------------*/
400 
401 cs_equation_t *
402 cs_equation_add_user(const char *eqname,
403  const char *varname,
404  int dim,
405  cs_param_bc_type_t default_bc);
406 
407 /*----------------------------------------------------------------------------*/
411 /*----------------------------------------------------------------------------*/
412 
413 void
414 cs_equation_destroy_all(void);
415 
416 /*----------------------------------------------------------------------------*/
423 /*----------------------------------------------------------------------------*/
424 
425 bool
426 cs_equation_needs_steady_state_solve(void);
427 
428 /*----------------------------------------------------------------------------*/
433 /*----------------------------------------------------------------------------*/
434 
435 void
436 cs_equation_log_monitoring(void);
437 
438 /*----------------------------------------------------------------------------*/
446 /*----------------------------------------------------------------------------*/
447 
448 void
449 cs_equation_get_count(int *n_equations,
450  int *n_predef_equations,
451  int *n_user_equations);
452 
453 /*----------------------------------------------------------------------------*/
457 /*----------------------------------------------------------------------------*/
458 
459 void
460 cs_equation_log_setup(void);
461 
462 /*----------------------------------------------------------------------------*/
469 /*----------------------------------------------------------------------------*/
470 
471 void
472 cs_equation_set_default_param(cs_equation_key_t key,
473  const char *keyval);
474 
475 /*----------------------------------------------------------------------------*/
479 /*----------------------------------------------------------------------------*/
480 
481 void
482 cs_equation_set_sles(void);
483 
484 /*----------------------------------------------------------------------------*/
498 /*----------------------------------------------------------------------------*/
499 
500 void
501 cs_equation_set_shared_structures(const cs_cdo_connect_t *connect,
502  const cs_cdo_quantities_t *quant,
503  const cs_time_step_t *time_step,
504  cs_flag_t eb_scheme_flag,
505  cs_flag_t fb_scheme_flag,
506  cs_flag_t vb_scheme_flag,
507  cs_flag_t vcb_scheme_flag,
508  cs_flag_t hho_scheme_flag);
509 
510 /*----------------------------------------------------------------------------*/
521 /*----------------------------------------------------------------------------*/
522 
523 void
524 cs_equation_unset_shared_structures(cs_flag_t vb_scheme_flag,
525  cs_flag_t vcb_scheme_flag,
526  cs_flag_t eb_scheme_flag,
527  cs_flag_t fb_scheme_flag,
528  cs_flag_t hho_scheme_flag);
529 
530 /*----------------------------------------------------------------------------*/
537 /*----------------------------------------------------------------------------*/
538 
539 void
540 cs_equation_set_range_set(const cs_cdo_connect_t *connect);
541 
542 /*----------------------------------------------------------------------------*/
551 /*----------------------------------------------------------------------------*/
552 
553 bool
554 cs_equation_set_functions(void);
555 
556 /*----------------------------------------------------------------------------*/
560 /*----------------------------------------------------------------------------*/
561 
562 void
563 cs_equation_create_fields(void);
564 
565 /*----------------------------------------------------------------------------*/
576 /*----------------------------------------------------------------------------*/
577 
578 void
579 cs_equation_initialize(const cs_mesh_t *mesh,
580  const cs_time_step_t *ts,
581  const cs_cdo_quantities_t *quant,
582  cs_cdo_connect_t *connect);
583 
584 /*----------------------------------------------------------------------------*/
592 /*----------------------------------------------------------------------------*/
593 
594 void
595 cs_equation_solve_steady_state(const cs_mesh_t *mesh,
596  cs_equation_t *eq);
597 
598 /*----------------------------------------------------------------------------*/
607 /*----------------------------------------------------------------------------*/
608 
609 void
610 cs_equation_solve(bool cur2prev,
611  const cs_mesh_t *mesh,
612  cs_equation_t *eq);
613 
614 /*----------------------------------------------------------------------------*/
621 /*----------------------------------------------------------------------------*/
622 
623 void
624 cs_equation_build_system(const cs_mesh_t *mesh,
625  cs_equation_t *eq);
626 
627 /*----------------------------------------------------------------------------*/
633 /*----------------------------------------------------------------------------*/
634 
635 void
636 cs_equation_solve_deprecated(cs_equation_t *eq);
637 
638 /*----------------------------------------------------------------------------*/
647 /*----------------------------------------------------------------------------*/
648 
649 cs_property_t *
650 cs_equation_get_diffusion_property(const cs_equation_t *eq);
651 
652 /*----------------------------------------------------------------------------*/
661 /*----------------------------------------------------------------------------*/
662 
663 cs_property_t *
664 cs_equation_get_time_property(const cs_equation_t *eq);
665 
666 /*----------------------------------------------------------------------------*/
678 /*----------------------------------------------------------------------------*/
679 
680 cs_property_t *
681 cs_equation_get_reaction_property(const cs_equation_t *eq,
682  const int reaction_id);
683 
684 /*----------------------------------------------------------------------------*/
693 /*----------------------------------------------------------------------------*/
694 
695 cs_param_time_scheme_t
696 cs_equation_get_time_scheme(const cs_equation_t *eq);
697 
698 /*----------------------------------------------------------------------------*/
708 /*----------------------------------------------------------------------------*/
709 
710 cs_real_t
711 cs_equation_get_theta_time_val(const cs_equation_t *eq);
712 
713 /*----------------------------------------------------------------------------*/
722 /*----------------------------------------------------------------------------*/
723 
724 cs_param_space_scheme_t
725 cs_equation_get_space_scheme(const cs_equation_t *eq);
726 
727 /*----------------------------------------------------------------------------*/
736 /*----------------------------------------------------------------------------*/
737 
738 int
739 cs_equation_get_space_poly_degree(const cs_equation_t *eq);
740 
741 /*----------------------------------------------------------------------------*/
749 /*----------------------------------------------------------------------------*/
750 
751 int
752 cs_equation_get_var_dim(const cs_equation_t *eq);
753 
754 /*----------------------------------------------------------------------------*/
762 /*----------------------------------------------------------------------------*/
763 
764 cs_equation_type_t
765 cs_equation_get_type(const cs_equation_t *eq);
766 
767 /*----------------------------------------------------------------------------*/
775 /*----------------------------------------------------------------------------*/
776 
777 void
778 cs_equation_current_to_previous(const cs_equation_t *eq);
779 
780 /*----------------------------------------------------------------------------*/
789 /*----------------------------------------------------------------------------*/
790 
791 void
792 cs_equation_get_cellwise_builders(const cs_equation_t *eq,
793  cs_cell_sys_t **csys,
794  cs_cell_builder_t **cb);
795 
796 /*----------------------------------------------------------------------------*/
806 /*----------------------------------------------------------------------------*/
807 
808 cs_real_t *
809 cs_equation_get_cell_values(const cs_equation_t *eq,
810  bool previous);
811 
812 /*----------------------------------------------------------------------------*/
822 /*----------------------------------------------------------------------------*/
823 
824 cs_real_t *
825 cs_equation_get_face_values(const cs_equation_t *eq,
826  bool previous);
827 
828 /*----------------------------------------------------------------------------*/
838 /*----------------------------------------------------------------------------*/
839 
840 cs_real_t *
841 cs_equation_get_edge_values(const cs_equation_t *eq,
842  bool previous);
843 
844 /*----------------------------------------------------------------------------*/
854 /*----------------------------------------------------------------------------*/
855 
856 cs_real_t *
857 cs_equation_get_vertex_values(const cs_equation_t *eq,
858  bool previous);
859 
860 /*----------------------------------------------------------------------------*/
870 /*----------------------------------------------------------------------------*/
871 
872 void
873 cs_equation_integrate_variable(const cs_cdo_connect_t *connect,
874  const cs_cdo_quantities_t *cdoq,
875  const cs_equation_t *eq,
876  cs_real_t *result);
877 
878 /*----------------------------------------------------------------------------*/
889 /*----------------------------------------------------------------------------*/
890 
891 void
892 cs_equation_compute_boundary_diff_flux(cs_real_t t_eval,
893  const cs_equation_t *eq,
894  cs_real_t *diff_flux);
895 
896 /*----------------------------------------------------------------------------*/
907 /*----------------------------------------------------------------------------*/
908 
909 void
910 cs_equation_compute_flux_across_plane(const cs_equation_t *eq,
911  const char *ml_name,
912  const cs_real_3_t direction,
913  cs_real_t *diff_flux,
914  cs_real_t *conv_flux);
915 
916 /*----------------------------------------------------------------------------*/
926 /*----------------------------------------------------------------------------*/
927 
928 void
929 cs_equation_compute_diff_flux_cellwise(const cs_equation_t *eq,
930  cs_flag_t location,
931  cs_real_t t_eval,
932  cs_real_t *diff_flux);
933 
934 /*----------------------------------------------------------------------------*/
941 /*----------------------------------------------------------------------------*/
942 
943 void
944 cs_equation_compute_vtx_field_gradient(const cs_equation_t *eq,
945  cs_real_t *v_gradient);
946 
947 /*----------------------------------------------------------------------------*/
956 /*----------------------------------------------------------------------------*/
957 
958 void
959 cs_equation_compute_peclet(const cs_equation_t *eq,
960  const cs_time_step_t *ts,
961  cs_real_t peclet[]);
962 
963 /*----------------------------------------------------------------------------*/
970 /*----------------------------------------------------------------------------*/
971 
972 void
973 cs_equation_read_extra_restart(cs_restart_t *restart);
974 
975 /*----------------------------------------------------------------------------*/
982 /*----------------------------------------------------------------------------*/
983 
984 void
985 cs_equation_write_extra_restart(cs_restart_t *restart);
986 
987 /*----------------------------------------------------------------------------*/
996 /*----------------------------------------------------------------------------*/
997 
998 void
999 cs_equation_post_balance(const cs_mesh_t *mesh,
1000  const cs_cdo_connect_t *connect,
1001  const cs_cdo_quantities_t *cdoq,
1002  const cs_time_step_t *ts);
1003 
1004 /*----------------------------------------------------------------------------*/
1009 /*----------------------------------------------------------------------------*/
1010 
1011 void
1012 cs_equation_extra_post(void);
1013 
1014 /*----------------------------------------------------------------------------*/
1015 
1016 END_C_DECLS
1017 
1018 #endif /* __CS_EQUATION_H__ */
cs_equation_builder_t
Store common elements used when building an algebraic system related to an equation.
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:3351
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:64
cs_gnum_t
unsigned long cs_gnum_t
global mesh entity number
Definition: cs_defs.h:286
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:882
cs_restart.h
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:3303
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:755
cs_field_t
Field descriptor.
Definition: cs_field.h:125
cs_equation_param_t
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources...
Definition: cs_equation_param.h:202
cs_cdo_connect.h
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:1913
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:3059
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. Only for an advanced usage.
Definition: cs_equation.c:820
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:2812
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:495
cs_equation_set_sles
void cs_equation_set_sles(void)
Setup the linear algebra requirements.
Definition: cs_equation.c:1493
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:2974
cs_equation_uses_new_mechanism
bool cs_equation_uses_new_mechanism(const cs_equation_t *eq)
Return true is the given equation is steady otherwise false.
Definition: cs_equation.c:1112
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:2704
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:2733
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:1463
cs_cdo_connect_t
Definition: cs_cdo_connect.h:76
cs_equation_compute_diff_flux_cellwise
void cs_equation_compute_diff_flux_cellwise(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 all cell faces. Primal or dual faces are considered...
Definition: cs_equation.c:3132
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.
Definition: cs_equation.c:2482
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:307
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:2864
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:124
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:107
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:907
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:473
cs_mesh_t
Definition: cs_mesh.h:84
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:2838
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:518
cs_equation_log_setup
void cs_equation_log_setup(void)
Summarize all cs_equation_t structures.
Definition: cs_equation.c:1426
cs_equation_common.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:172
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:498
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:387
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:1003
cs_equation_initialize
void cs_equation_initialize(const cs_mesh_t *mesh, const cs_time_step_t *ts, const cs_cdo_quantities_t *quant, cs_cdo_connect_t *connect)
Allocate and initialize the builder of the algebraic system. Set the initialize condition to all vari...
Definition: cs_equation.c:2427
cs_equation_unset_shared_structures
void cs_equation_unset_shared_structures(cs_flag_t vb_scheme_flag, cs_flag_t vcb_scheme_flag, cs_flag_t eb_scheme_flag, cs_flag_t fb_scheme_flag, cs_flag_t hho_scheme_flag)
Release shared structures among the activated class of discretization schemes.
Definition: cs_equation.c:1658
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:932
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:2786
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:840
cs_restart_t
struct _cs_restart_t cs_restart_t
Definition: cs_restart.h:93
cs_range_set_t
Definition: cs_range_set.h:57
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:3464
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:712
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:3213
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:860
cs_equation_solve_deprecated
void cs_equation_solve_deprecated(cs_equation_t *eq)
Solve the linear system for this equation.
Definition: cs_equation.c:2523
cs_cell_builder_t
Set of local and temporary buffers useful for building the algebraic system with a cellwise process...
Definition: cs_cdo_local.h:69
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:558
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:1279
cs_equation_key_t
cs_equation_key_t
List of available keys for setting the parameters of an equation.
Definition: cs_equation_param.h:1074
cs_real_3_t
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:320
cs_equation_type_t
cs_equation_type_t
Type of equations managed by the solver.
Definition: cs_equation_param.h:181
_cs_equation_t::varname
char *restrict varname
Definition: cs_equation_priv.h:330
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:598
cs_cdo_quantities.h
cs_equation_create_fields
void cs_equation_create_fields(void)
Create a field structure related to all cs_equation_t structures.
Definition: cs_equation.c:2322
cs_field.h
cs_mesh.h
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:419
cs_time_step.h
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:1067
cs_equation_add_user_hook
void cs_equation_add_user_hook(cs_equation_t *eq, void *context, cs_equation_user_hook_t *func)
Add a user hook to enable an advanced user to get a fine control of the cellwise system building...
Definition: cs_equation.c:779
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:496
cs_flag_t
unsigned short int cs_flag_t
Definition: cs_defs.h:309
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:2669
cs_param_bc_type_t
cs_param_bc_type_t
Definition: cs_param_types.h:431
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:733
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:639
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:1361
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:578
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.
Definition: cs_equation.c:618
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:1149
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:3255
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 thanks to the equati...
Definition: cs_equation.c:447
cs_equation_set_shared_structures
void cs_equation_set_shared_structures(const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_time_step_t *time_step, 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 structures among the activated class of discretization schemes.
Definition: cs_equation.c:1533
cs_equation_user_hook_t
void() cs_equation_user_hook_t(const cs_equation_param_t *eqp, const cs_equation_builder_t *eqb, const void *eq_context, const cs_cell_mesh_t *cm, 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_common.h:92
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:1046
cs_equation_set_range_set
void cs_equation_set_range_set(const cs_cdo_connect_t *connect)
Assign a cs_range_set_t structures for synchronization when computing in parallel mode...
Definition: cs_equation.c:1700
cs_equation_destroy_all
void cs_equation_destroy_all(void)
Destroy all cs_equation_t structures.
Definition: cs_equation.c:1314
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:1410
cs_equation_t
Main structure to handle the discretization and the resolution of an equation.
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:2634
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:2760
cs_param_time_scheme_t
cs_param_time_scheme_t
Definition: cs_param_types.h:234
cs_equation_param.h
Structure and routines handling the specific settings related to a cs_equation_t structure.
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:538
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:353
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:1025
cs_property_t
Structure associated to the definition of a property relying on the cs_xdef_t structure.
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:3326
_cs_equation_t
Definition: cs_equation_priv.h:323
cs_equation_get_n_equations
int cs_equation_get_n_equations(void)
Retrieve the number of equations.
Definition: cs_equation.c:336
mesh
Definition: mesh.f90:26
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:955
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:1383
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:1088