8.0
general documentation
cs_resource.h
Go to the documentation of this file.
1 #ifndef __CS_RESOURCE_H__
2 #define __CS_RESOURCE_H__
3 
4 /*============================================================================
5  * Resource allocation management (available time).
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 #if defined(HAVE_CONFIG_H)
31 #include "cs_config.h"
32 #endif
33 
34 /*----------------------------------------------------------------------------
35  * Standard C library headers
36  *----------------------------------------------------------------------------*/
37 
38 /*----------------------------------------------------------------------------
39  * Local headers
40  *----------------------------------------------------------------------------*/
41 
42 #include "cs_base.h"
43 
44 /*----------------------------------------------------------------------------*/
45 
46 BEGIN_C_DECLS
47 
48 /*=============================================================================
49  * Macro Definitions
50  *============================================================================*/
51 
52 /*=============================================================================
53  * Type Definitions
54  *============================================================================*/
55 
56 /*============================================================================
57  * Global variables
58  *============================================================================*/
59 
60 /*============================================================================
61  * Public function prototypes for Fortran API
62  *============================================================================*/
63 
64 /*----------------------------------------------------------------------------
65  * Limit number of remaining time steps if the remaining allocated time is
66  * too small to attain the requested number of steps.
67  *
68  * Fortran interface:
69  *
70  * subroutine armtsp (ntcabs, ntmabs)
71  * *****************
72  *
73  * integer ntcabs : <-- : current time step number
74  * integer ntmabs : <-> : maximum time step number
75  *----------------------------------------------------------------------------*/
76 
77 void CS_PROCF (armtps, ARMTPS)
78 (
79  const int *ntcabs,
80  int *ntmabs
81 );
82 
83 /*============================================================================
84  * Public function prototypes
85  *============================================================================*/
86 
87 /*----------------------------------------------------------------------------*/
93 /*----------------------------------------------------------------------------*/
94 
95 double
96 cs_resource_get_wt_limit(void);
97 
98 /*----------------------------------------------------------------------------*/
104 /*----------------------------------------------------------------------------*/
105 
106 void
107 cs_resource_set_wt_limit(double wt);
108 
109 /*----------------------------------------------------------------------------*/
117 /*----------------------------------------------------------------------------*/
118 
119 void
120 cs_resource_get_max_timestep(int ts_cur,
121  int *ts_max);
122 
123 /*----------------------------------------------------------------------------*/
124 
125 END_C_DECLS
126 
127 #endif /* __CS_RESOURCE_H__ */
cs_base.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:509
CS_PROCF
#define CS_PROCF(x, y)
Definition: cs_defs.h:523
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:510
cs_resource_set_wt_limit
void cs_resource_set_wt_limit(double wt)
Set wall-clock time limit.
Definition: cs_resource.c:259
cs_resource_get_wt_limit
double cs_resource_get_wt_limit(void)
Get current wall-clock time limit.
Definition: cs_resource.c:245
cs_resource_get_max_timestep
void cs_resource_get_max_timestep(int ts_cur, int *ts_max)
Limit number of remaining time steps if the remaining allocated time is too small to attain the reque...
Definition: cs_resource.c:275
armtps
void armtps(const int *ntcabs, int *ntmabs)
Definition: cs_resource.c:220
optcal::ntmabs
integer(c_int), pointer, save ntmabs
Maximum absolute time step number.
Definition: optcal.f90:205
optcal::ntcabs
integer(c_int), pointer, save ntcabs
Current absolute time step number. In case of restart, this is equal to ntpabs + number of new iterat...
Definition: optcal.f90:196