My Project
programmer's documentation
Loading...
Searching...
No Matches
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-2019 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_param.h"
38#include "cs_mesh.h"
39#include "cs_restart.h"
40#include "cs_time_step.h"
41
42/*----------------------------------------------------------------------------*/
43
44BEGIN_C_DECLS
45
46/*============================================================================
47 * Macro definitions
48 *============================================================================*/
49
50/*============================================================================
51 * Type definitions
52 *============================================================================*/
53
54typedef struct _cs_equation_t cs_equation_t;
55
56/*============================================================================
57 * Public function prototypes
58 *============================================================================*/
59
60/*----------------------------------------------------------------------------*/
66/*----------------------------------------------------------------------------*/
67
68int
69cs_equation_get_n_equations(void);
70
71/*----------------------------------------------------------------------------*/
80/*----------------------------------------------------------------------------*/
81
82cs_equation_t *
83cs_equation_by_name(const char *eqname);
84
85/*----------------------------------------------------------------------------*/
96/*----------------------------------------------------------------------------*/
97
98bool
99cs_equation_has_field_name(const cs_equation_t *eq,
100 const char *fld_name);
101
102/*----------------------------------------------------------------------------*/
111/*----------------------------------------------------------------------------*/
112
113cs_equation_param_t *
114cs_equation_param_by_name(const char *eqname);
115
116/*----------------------------------------------------------------------------*/
125/*----------------------------------------------------------------------------*/
126
127cs_equation_param_t *
128cs_equation_get_param(const cs_equation_t *eq);
129
130/*----------------------------------------------------------------------------*/
139/*----------------------------------------------------------------------------*/
140
141cs_equation_t *
142cs_equation_by_id(int eq_id);
143
144/*----------------------------------------------------------------------------*/
152/*----------------------------------------------------------------------------*/
153
154const char *
155cs_equation_get_name(const cs_equation_t *eq);
156
157/*----------------------------------------------------------------------------*/
165/*----------------------------------------------------------------------------*/
166
167int
168cs_equation_get_id(const cs_equation_t *eq);
169
170/*----------------------------------------------------------------------------*/
178/*----------------------------------------------------------------------------*/
179
180cs_field_t *
181cs_equation_get_field(const cs_equation_t *eq);
182
183/*----------------------------------------------------------------------------*/
192/*----------------------------------------------------------------------------*/
193
194int
195cs_equation_get_field_id(const cs_equation_t *eq);
196
197/*----------------------------------------------------------------------------*/
206/*----------------------------------------------------------------------------*/
207
208cs_field_t *
209cs_equation_get_boundary_flux(const cs_equation_t *eq);
210
211/*----------------------------------------------------------------------------*/
219/*----------------------------------------------------------------------------*/
220
221cs_flag_t
222cs_equation_get_flag(const cs_equation_t *eq);
223
224/*----------------------------------------------------------------------------*/
231/*----------------------------------------------------------------------------*/
232
233void
234cs_equation_set_flag(cs_equation_t *eq,
235 cs_flag_t flag);
236
237/*----------------------------------------------------------------------------*/
246/*----------------------------------------------------------------------------*/
247
248cs_equation_builder_t *
249cs_equation_get_builder(const cs_equation_t *eq);
250
251/*----------------------------------------------------------------------------*/
260/*----------------------------------------------------------------------------*/
261
262void *
263cs_equation_get_scheme_context(const cs_equation_t *eq);
264
265/*----------------------------------------------------------------------------*/
273/*----------------------------------------------------------------------------*/
274
275bool
276cs_equation_is_steady(const cs_equation_t *eq);
277
278/*----------------------------------------------------------------------------*/
286/*----------------------------------------------------------------------------*/
287
288bool
289cs_equation_uses_new_mechanism(const cs_equation_t *eq);
290
291/*----------------------------------------------------------------------------*/
303/*----------------------------------------------------------------------------*/
304
305cs_equation_t *
306cs_equation_add(const char *eqname,
307 const char *varname,
308 cs_equation_type_t eqtype,
309 int dim,
310 cs_param_bc_type_t default_bc);
311
312/*----------------------------------------------------------------------------*/
323/*----------------------------------------------------------------------------*/
324
325cs_equation_t *
326cs_equation_add_user(const char *eqname,
327 const char *varname,
328 int dim,
329 cs_param_bc_type_t default_bc);
330
331/*----------------------------------------------------------------------------*/
335/*----------------------------------------------------------------------------*/
336
337void
338cs_equation_destroy_all(void);
339
340/*----------------------------------------------------------------------------*/
347/*----------------------------------------------------------------------------*/
348
349bool
350cs_equation_needs_steady_state_solve(void);
351
352/*----------------------------------------------------------------------------*/
357/*----------------------------------------------------------------------------*/
358
359void
360cs_equation_log_monitoring(void);
361
362/*----------------------------------------------------------------------------*/
370/*----------------------------------------------------------------------------*/
371
372void
373cs_equation_get_count(int *n_equations,
374 int *n_predef_equations,
375 int *n_user_equations);
376
377/*----------------------------------------------------------------------------*/
381/*----------------------------------------------------------------------------*/
382
383void
384cs_equation_log_setup(void);
385
386/*----------------------------------------------------------------------------*/
393/*----------------------------------------------------------------------------*/
394
395void
396cs_equation_set_default_param(cs_equation_key_t key,
397 const char *keyval);
398
399/*----------------------------------------------------------------------------*/
403/*----------------------------------------------------------------------------*/
404
405void
406cs_equation_set_sles(void);
407
408/*----------------------------------------------------------------------------*/
421/*----------------------------------------------------------------------------*/
422
423void
424cs_equation_set_shared_structures(const cs_cdo_connect_t *connect,
425 const cs_cdo_quantities_t *quant,
426 const cs_time_step_t *time_step,
427 cs_flag_t vb_scheme_flag,
428 cs_flag_t vcb_scheme_flag,
429 cs_flag_t fb_scheme_flag,
430 cs_flag_t hho_scheme_flag);
431
432/*----------------------------------------------------------------------------*/
442/*----------------------------------------------------------------------------*/
443
444void
445cs_equation_unset_shared_structures(cs_flag_t vb_scheme_flag,
446 cs_flag_t vcb_scheme_flag,
447 cs_flag_t fb_scheme_flag,
448 cs_flag_t hho_scheme_flag);
449
450/*----------------------------------------------------------------------------*/
457/*----------------------------------------------------------------------------*/
458
459void
460cs_equation_set_range_set(const cs_cdo_connect_t *connect);
461
462/*----------------------------------------------------------------------------*/
471/*----------------------------------------------------------------------------*/
472
473bool
474cs_equation_set_functions(void);
475
476/*----------------------------------------------------------------------------*/
480/*----------------------------------------------------------------------------*/
481
482void
483cs_equation_create_fields(void);
484
485/*----------------------------------------------------------------------------*/
496/*----------------------------------------------------------------------------*/
497
498void
499cs_equation_initialize(const cs_mesh_t *mesh,
500 const cs_cdo_connect_t *connect,
501 const cs_cdo_quantities_t *quant,
502 const cs_time_step_t *ts);
503
504/*----------------------------------------------------------------------------*/
512/*----------------------------------------------------------------------------*/
513
514void
515cs_equation_solve_steady_state(const cs_mesh_t *mesh,
516 cs_equation_t *eq);
517
518/*----------------------------------------------------------------------------*/
526/*----------------------------------------------------------------------------*/
527
528void
529cs_equation_solve(const cs_mesh_t *mesh,
530 cs_equation_t *eq);
531
532/*----------------------------------------------------------------------------*/
539/*----------------------------------------------------------------------------*/
540
541void
542cs_equation_build_system(const cs_mesh_t *mesh,
543 cs_equation_t *eq);
544
545/*----------------------------------------------------------------------------*/
551/*----------------------------------------------------------------------------*/
552
553void
554cs_equation_solve_deprecated(cs_equation_t *eq);
555
556/*----------------------------------------------------------------------------*/
565/*----------------------------------------------------------------------------*/
566
567cs_property_t *
568cs_equation_get_diffusion_property(const cs_equation_t *eq);
569
570/*----------------------------------------------------------------------------*/
579/*----------------------------------------------------------------------------*/
580
581cs_property_t *
582cs_equation_get_time_property(const cs_equation_t *eq);
583
584/*----------------------------------------------------------------------------*/
596/*----------------------------------------------------------------------------*/
597
598cs_property_t *
599cs_equation_get_reaction_property(const cs_equation_t *eq,
600 const int reaction_id);
601
602/*----------------------------------------------------------------------------*/
611/*----------------------------------------------------------------------------*/
612
613cs_param_time_scheme_t
614cs_equation_get_time_scheme(const cs_equation_t *eq);
615
616/*----------------------------------------------------------------------------*/
626/*----------------------------------------------------------------------------*/
627
628cs_real_t
629cs_equation_get_theta_time_val(const cs_equation_t *eq);
630
631/*----------------------------------------------------------------------------*/
640/*----------------------------------------------------------------------------*/
641
642cs_param_space_scheme_t
643cs_equation_get_space_scheme(const cs_equation_t *eq);
644
645/*----------------------------------------------------------------------------*/
654/*----------------------------------------------------------------------------*/
655
656int
657cs_equation_get_space_poly_degree(const cs_equation_t *eq);
658
659/*----------------------------------------------------------------------------*/
667/*----------------------------------------------------------------------------*/
668
669int
670cs_equation_get_var_dim(const cs_equation_t *eq);
671
672/*----------------------------------------------------------------------------*/
680/*----------------------------------------------------------------------------*/
681
682cs_equation_type_t
683cs_equation_get_type(const cs_equation_t *eq);
684
685/*----------------------------------------------------------------------------*/
694/*----------------------------------------------------------------------------*/
695
696cs_real_t *
697cs_equation_get_face_values(const cs_equation_t *eq);
698
699/*----------------------------------------------------------------------------*/
708/*----------------------------------------------------------------------------*/
709
710cs_real_t *
711cs_equation_get_cell_values(const cs_equation_t *eq);
712
713/*----------------------------------------------------------------------------*/
722/*----------------------------------------------------------------------------*/
723
724cs_real_t *
725cs_equation_get_vertex_values(const cs_equation_t *eq);
726
727/*----------------------------------------------------------------------------*/
738/*----------------------------------------------------------------------------*/
739
740void
741cs_equation_compute_boundary_diff_flux(cs_real_t t_eval,
742 const cs_equation_t *eq,
743 cs_real_t *diff_flux);
744
745/*----------------------------------------------------------------------------*/
756/*----------------------------------------------------------------------------*/
757
758void
759cs_equation_compute_flux_across_plane(const cs_equation_t *eq,
760 const char *ml_name,
761 const cs_real_3_t direction,
762 cs_real_t *diff_flux,
763 cs_real_t *conv_flux);
764
765/*----------------------------------------------------------------------------*/
775/*----------------------------------------------------------------------------*/
776
777void
778cs_equation_compute_diff_flux_cellwise(const cs_equation_t *eq,
779 cs_flag_t location,
780 cs_real_t t_eval,
781 cs_real_t *diff_flux);
782
783/*----------------------------------------------------------------------------*/
790/*----------------------------------------------------------------------------*/
791
792void
793cs_equation_compute_vtx_field_gradient(const cs_equation_t *eq,
794 cs_real_t *v_gradient);
795
796/*----------------------------------------------------------------------------*/
805/*----------------------------------------------------------------------------*/
806
807void
808cs_equation_compute_peclet(const cs_equation_t *eq,
809 const cs_time_step_t *ts,
810 cs_real_t peclet[]);
811
812/*----------------------------------------------------------------------------*/
819/*----------------------------------------------------------------------------*/
820
821void
822cs_equation_read_extra_restart(cs_restart_t *restart);
823
824/*----------------------------------------------------------------------------*/
831/*----------------------------------------------------------------------------*/
832
833void
834cs_equation_write_extra_restart(cs_restart_t *restart);
835
836/*----------------------------------------------------------------------------*/
845/*----------------------------------------------------------------------------*/
846
847void
848cs_equation_post_balance(const cs_mesh_t *mesh,
849 const cs_cdo_connect_t *connect,
850 const cs_cdo_quantities_t *cdoq,
851 const cs_time_step_t *ts);
852
853/*----------------------------------------------------------------------------*/
858/*----------------------------------------------------------------------------*/
859
860void
861cs_equation_extra_post(void);
862
863/*----------------------------------------------------------------------------*/
864
865END_C_DECLS
866
867#endif /* __CS_EQUATION_H__ */
cs_cdo_connect.h
cs_cdo_quantities.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition cs_defs.h:467
cs_real_t
double cs_real_t
Floating-point value.
Definition cs_defs.h:302
cs_real_3_t
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition cs_defs.h:315
END_C_DECLS
#define END_C_DECLS
Definition cs_defs.h:468
cs_flag_t
unsigned short int cs_flag_t
Definition cs_defs.h:304
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:463
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:2921
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:2783
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:690
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:2808
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:443
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:1078
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:1264
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:1672
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:2760
cs_equation_set_sles
void cs_equation_set_sles(void)
Setup the linear algebra requirements.
Definition cs_equation.c:1294
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:606
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:832
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:1160
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:1479
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:2303
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:648
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:584
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:740
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:523
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:2001
cs_equation_get_vertex_values
cs_real_t * cs_equation_get_vertex_values(const cs_equation_t *eq)
For a given equation, retrieve an array of values related to each vertex of the mesh for the unknowns...
Definition cs_equation.c:2409
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:810
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:414
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:1211
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:919
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:2590
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:1182
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:483
cs_equation_get_cell_values
cs_real_t * cs_equation_get_cell_values(const cs_equation_t *eq)
Get the values at each cell centers for the field unknowns related to this equation.
Definition cs_equation.c:2385
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:2671
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:628
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:895
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:668
cs_equation_solve
void cs_equation_solve(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:2331
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:386
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:715
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:2435
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:2517
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:350
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:2151
cs_equation_destroy_all
void cs_equation_destroy_all(void)
Destroy all cs_equation_t structures.
Definition cs_equation.c:1113
cs_equation_get_face_values
cs_real_t * cs_equation_get_face_values(const cs_equation_t *eq)
For a given equation, retrieve an array of values related to each face of the mesh for the unknowns.
Definition cs_equation.c:2361
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 vb_scheme_flag, cs_flag_t vcb_scheme_flag, cs_flag_t fb_scheme_flag, cs_flag_t hho_scheme_flag)
Set shared structures among the activated class of discretization schemes.
Definition cs_equation.c:1333
cs_equation_log_setup
void cs_equation_log_setup(void)
Summarize all cs_equation_t structures.
Definition cs_equation.c:1227
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:763
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:563
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:503
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:874
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 fb_scheme_flag, cs_flag_t hho_scheme_flag)
Release shared structures among the activated class of discretization schemes.
Definition cs_equation.c:1441
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:955
cs_equation_initialize
void cs_equation_initialize(const cs_mesh_t *mesh, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_time_step_t *ts)
Allocate and initialize the builder of the algebraic system. Set the initialize condition to all vari...
Definition cs_equation.c:2104
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:543
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:853
cs_equation_get_n_equations
int cs_equation_get_n_equations(void)
Retrieve the number of equations.
Definition cs_equation.c:333
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:2712
cs_equation_solve_deprecated
void cs_equation_solve_deprecated(cs_equation_t *eq)
Solve the linear system for this equation.
Definition cs_equation.c:2192
cs_equation_common.h
cs_equation_param.h
Structure and routines handling the specific settings related to a cs_equation_t structure.
cs_equation_key_t
cs_equation_key_t
List of available keys for setting the parameters of an equation.
Definition cs_equation_param.h:643
cs_equation_type_t
cs_equation_type_t
Type of equations managed by the solver.
Definition cs_equation_param.h:133
cs_field.h
cs_mesh.h
cs_param.h
cs_param_space_scheme_t
cs_param_space_scheme_t
Type of numerical scheme for the discretization in space.
Definition cs_param.h:125
cs_param_bc_type_t
cs_param_bc_type_t
Definition cs_param.h:302
cs_param_time_scheme_t
cs_param_time_scheme_t
Definition cs_param.h:183
cs_restart.h
cs_restart_t
struct _cs_restart_t cs_restart_t
Definition cs_restart.h:87
cs_time_step.h
mesh
Definition mesh.f90:26
_cs_equation_t
Definition cs_equation_priv.h:310
_cs_equation_t::varname
char *restrict varname
Definition cs_equation_priv.h:317
cs_cdo_connect_t
Definition cs_cdo_connect.h:74
cs_cdo_quantities_t
Definition cs_cdo_quantities.h:94
cs_equation_builder_t
Store common elements used when building an algebraic system related to an equation.
Definition cs_equation_common.h:61
cs_equation_param_t
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources.
Definition cs_equation_param.h:148
cs_equation_t
Main structure to handle the discretization and the resolution of an equation.
cs_field_t
Field descriptor.
Definition cs_field.h:124
cs_mesh_t
Definition cs_mesh.h:63
cs_property_t
Definition cs_property.h:104
cs_time_step_t
time step descriptor
Definition cs_time_step.h:51
Generated on Wed Mar 13 2024 18:14:52 for My Project by doxygen 1.9.8