8.0
general documentation
Loading...
Searching...
No Matches
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
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
77void CS_PROCF (armtps, ARMTPS)
78(
79 const int *ntcabs,
80 int *ntmabs
81);
82
83/*============================================================================
84 * Public function prototypes
85 *============================================================================*/
86
87/*----------------------------------------------------------------------------*/
93/*----------------------------------------------------------------------------*/
94
95double
97
98/*----------------------------------------------------------------------------*/
104/*----------------------------------------------------------------------------*/
105
106void
107cs_resource_set_wt_limit(double wt);
108
109/*----------------------------------------------------------------------------*/
117/*----------------------------------------------------------------------------*/
118
119void
121 int *ts_max);
122
123/*----------------------------------------------------------------------------*/
124
126
127#endif /* __CS_RESOURCE_H__ */
#define BEGIN_C_DECLS
Definition cs_defs.h:509
#define CS_PROCF(x, y)
Definition cs_defs.h:523
#define END_C_DECLS
Definition cs_defs.h:510
void armtps(const int *ntcabs, int *ntmabs)
Definition cs_resource.c:220
void cs_resource_set_wt_limit(double wt)
Set wall-clock time limit.
Definition cs_resource.c:259
double cs_resource_get_wt_limit(void)
Get current wall-clock time limit.
Definition cs_resource.c:245
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
integer(c_int), pointer, save ntmabs
Maximum absolute time step number.
Definition optcal.f90:205
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