Code_Saturne
CFD tool
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-2012 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  * BFT library headers
40  *----------------------------------------------------------------------------*/
41 
42 /*----------------------------------------------------------------------------
43  * FVM library headers
44  *----------------------------------------------------------------------------*/
45 
46 /*----------------------------------------------------------------------------
47  * Local headers
48  *----------------------------------------------------------------------------*/
49 
50 #include "cs_base.h"
51 
52 /*----------------------------------------------------------------------------*/
53 
55 
56 /*=============================================================================
57  * Macro Definitions
58  *============================================================================*/
59 
60 /*=============================================================================
61  * Type Definitions
62  *============================================================================*/
63 
64 /*============================================================================
65  * Global variables
66  *============================================================================*/
67 
68 /*============================================================================
69  * Public function prototypes for Fortran API
70  *============================================================================*/
71 
72 /*----------------------------------------------------------------------------
73  * Limit number of remaining time steps if the remaining allocated time is
74  * too small to attain the requested number of steps.
75  *
76  * Fortran interface:
77  *
78  * subroutine armtsp (ntcabs, ntmabs)
79  * *****************
80  *
81  * integer ntcabs : <-- : current time step number
82  * integer ntmabs : <-> : maximum time step number
83  *----------------------------------------------------------------------------*/
84 
85 void CS_PROCF (armtps, ARMTPS)
86 (
87  const cs_int_t *ntcabs,
89 );
90 
91 /*============================================================================
92  * Public function prototypes
93  *============================================================================*/
94 
95 /*----------------------------------------------------------------------------
96  * Limit number of remaining time steps if the remaining allocated time is
97  * too small to attain the requested number of steps.
98  *
99  * parameters:
100  * ts_cur <-- current time step number
101  * ts_max <-> maximum time step number
102  *----------------------------------------------------------------------------*/
103 
104 void
106  int *ts_max);
107 
108 /*----------------------------------------------------------------------------*/
109 
111 
112 #endif /* __CS_RESOURCE_H__ */
BEGIN_C_DECLS void armtps(const cs_int_t *ntcabs, cs_int_t *ntmabs)
Definition: cs_resource.c:219
#define BEGIN_C_DECLS
Definition: cs_defs.h:365
int cs_int_t
Definition: cs_defs.h:263
integer, save ntcabs
Definition: optcal.f90:277
void cs_resource_get_max_timestep(int ts_cur, int *ts_max)
Definition: cs_resource.c:245
integer, save ntmabs
Definition: optcal.f90:277
#define END_C_DECLS
Definition: cs_defs.h:366
#define CS_PROCF(x, y)
Definition: cs_defs.h:379