8.0
general documentation
cs_runaway_check.h
Go to the documentation of this file.
1 #ifndef __CS_RUNAWAY_H__
2 #define __CS_RUNAWAY_H__
3 
4 /*============================================================================
5  * Runaway (diverging) computation detection.
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 
30 /*----------------------------------------------------------------------------
31  * Standard C library headers
32  *----------------------------------------------------------------------------*/
33 
34 /*----------------------------------------------------------------------------
35  * Local headers
36  *----------------------------------------------------------------------------*/
37 
38 #include "cs_base.h"
39 #include "cs_mesh_location.h"
40 #include "cs_time_step.h"
41 
42 /*----------------------------------------------------------------------------*/
43 
44 BEGIN_C_DECLS
45 
46 /*============================================================================
47  * Macro definitions
48  *============================================================================*/
49 
50 /*============================================================================
51  * Local type definitions
52  *============================================================================*/
53 
54 /*=============================================================================
55  * Global variables
56  *============================================================================*/
57 
58 /*============================================================================
59  * Public function prototypes
60  *============================================================================*/
61 
62 /*----------------------------------------------------------------------------*/
68 /*----------------------------------------------------------------------------*/
69 
70 int
71 cs_runaway_check(void);
72 
73 /*----------------------------------------------------------------------------*/
81 /*----------------------------------------------------------------------------*/
82 
83 void
84 cs_runaway_check_define_field_max(int f_id,
85  cs_real_t max_allowed);
86 
87 /*----------------------------------------------------------------------------*/
91 /*----------------------------------------------------------------------------*/
92 
93 void
94 cs_runaway_check_finalize(void);
95 
96 /*----------------------------------------------------------------------------*/
97 
98 END_C_DECLS
99 
100 #endif /* __CS_RUNAWAY_H__ */
cs_base.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
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:510
cs_mesh_location.h
cs_runaway_check_finalize
void cs_runaway_check_finalize(void)
Check that defined field bounds are not exceeded.
Definition: cs_runaway_check.c:230
cs_runaway_check
int cs_runaway_check(void)
Check that defined field bounds are not exceeded.
Definition: cs_runaway_check.c:186
cs_runaway_check_define_field_max
void cs_runaway_check_define_field_max(int f_id, cs_real_t max_allowed)
Define maximum value for a field, beyon which computation is aborted.
Definition: cs_runaway_check.c:216
cs_time_step.h