9.1
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-2025 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#include "base/cs_defs.h"
31
32/*----------------------------------------------------------------------------
33 * Standard C library headers
34 *----------------------------------------------------------------------------*/
35
36/*----------------------------------------------------------------------------
37 * Local headers
38 *----------------------------------------------------------------------------*/
39
40#include "base/cs_base.h"
41
42/*----------------------------------------------------------------------------*/
43
44BEGIN_C_DECLS
45
46/*=============================================================================
47 * Macro Definitions
48 *============================================================================*/
49
50/*=============================================================================
51 * Type Definitions
52 *============================================================================*/
53
54/*============================================================================
55 * Global variables
56 *============================================================================*/
57
58/*============================================================================
59 * Public function prototypes
60 *============================================================================*/
61
62/*----------------------------------------------------------------------------*/
68/*----------------------------------------------------------------------------*/
69
70double
71cs_resource_get_wt_limit(void);
72
73/*----------------------------------------------------------------------------*/
79/*----------------------------------------------------------------------------*/
80
81void
82cs_resource_set_wt_limit(double wt);
83
84/*----------------------------------------------------------------------------*/
92/*----------------------------------------------------------------------------*/
93
94void
95cs_resource_get_max_timestep(int ts_cur,
96 int *ts_max);
97
98/*----------------------------------------------------------------------------*/
99
100END_C_DECLS
101
102#endif /* __CS_RESOURCE_H__ */
cs_base.h
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:554
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:555
cs_resource_set_wt_limit
void cs_resource_set_wt_limit(double wt)
Set wall-clock time limit.
Definition: cs_resource.cpp:234
cs_resource_get_wt_limit
double cs_resource_get_wt_limit(void)
Get current wall-clock time limit.
Definition: cs_resource.cpp:220
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.cpp:250