programmer's documentation
cs_gui_output.h
Go to the documentation of this file.
1 #ifndef __CS_GUI_OUTPUT_H__
2 #define __CS_GUI_OUTPUT_H__
3 
4 /*============================================================================
5  * Management of the GUI parameters file: main parameters
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2016 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  * Local headers
32  *----------------------------------------------------------------------------*/
33 
34 #include "cs_base.h"
35 
36 /*----------------------------------------------------------------------------*/
37 
39 
40 /*============================================================================
41  * Type definitions
42  *============================================================================*/
43 
44 /*============================================================================
45  * Public function prototypes for Fortran API
46  *============================================================================*/
47 
48 /*----------------------------------------------------------------------------
49  * Activation of a writer depending of a formula
50  *
51  * Fortran Interface:
52  *
53  * subroutine uinpst (ttcabs, ntcabs)
54  * *****************
55  *
56  * integer uref <-- reference velocity
57  * double almax <-- reference length
58  *----------------------------------------------------------------------------*/
59 
60 void CS_PROCF (uinpst, UINPST) (const cs_int_t *ntcabs,
61  const cs_real_t *ttcabs);
62 
63 
64 /*----------------------------------------------------------------------------
65  * Determine output boundary fields
66  *----------------------------------------------------------------------------*/
67 
68 void CS_PROCF (cspstb, CSPSTB) (cs_int_t *ipstdv);
69 
70 /*----------------------------------------------------------------------------
71  * Determine output options
72  *----------------------------------------------------------------------------*/
73 
74 void CS_PROCF (csenso, CSENSO) (const cs_int_t *nvppmx,
75  cs_int_t *ncapt,
81  cs_real_t *xyzcap);
82 
83 /*============================================================================
84  * Public function prototypes
85  *============================================================================*/
86 
87 /*----------------------------------------------------------------------------
88  * Define postprocessing meshes using an XML file.
89  *----------------------------------------------------------------------------*/
90 
91 void
93 
94 /*----------------------------------------------------------------------------
95  * Define postprocessing writers using an XML file.
96  *----------------------------------------------------------------------------*/
97 
98 void
100 
101 /*-----------------------------------------------------------------------------
102  * Post-processing options for fields
103  *
104  * These options are used for fields not mapped to variables or properties.
105  *----------------------------------------------------------------------------*/
106 
107 void
109 
110 /*----------------------------------------------------------------------------*/
111 
113 
114 #endif /* __CS_GUI_OUTPUT_H__ */
void cs_gui_postprocess_meshes(void)
Definition: cs_gui_output.c:1280
double precision, dimension(3, ncaptm), save xyzcap
xyzcap : required position for a probe 3D-coordinates of the probes. the coordinates are written: xyz...
Definition: entsor.f90:238
double precision, save frhist
frhist : output frequency in seconds
Definition: entsor.f90:189
#define BEGIN_C_DECLS
Definition: cs_defs.h:448
int cs_int_t
Fortran-compatible integer.
Definition: cs_defs.h:295
void uinpst(const cs_int_t *ntcabs, const cs_real_t *ttcabs)
Definition: cs_gui_output.c:1077
void csenso(const cs_int_t *nvppmx, cs_int_t *ncapt, cs_int_t *nthist, cs_real_t *frhist, cs_int_t *iecaux, cs_int_t *ihisvr, cs_int_t *tplfmt, cs_real_t *xyzcap)
Definition: cs_gui_output.c:1153
integer nvppmx
number of displayed variables. = ngrdmx + 20 (20 > dt, tpucou, increased by 16 ...)
Definition: paramx.f90:73
double cs_real_t
Floating-point value.
Definition: cs_defs.h:296
real(c_double), pointer, save ttcabs
Current absolute time. In case of restart, this is equal to ttpabs + additional computed time...
Definition: optcal.f90:405
void cspstb(cs_int_t *ipstdv)
Definition: cs_gui_output.c:1112
integer, dimension(nvppmx, ncaptm+1), save ihisvr
number ihisvr(n, 1) and index-numbers ihisvr(n, j>1) of the record probes to be used for each variabl...
Definition: entsor.f90:222
integer, save iecaux
Definition: optcal.f90:375
integer, save tplfmt
time plot format (1: .dat, 2: .csv, 3: both)
Definition: entsor.f90:168
void cs_gui_postprocess_writers(void)
Definition: cs_gui_output.c:1359
integer, save ncapt
total number of probes (limited to ncaptm=200)
Definition: entsor.f90:171
#define END_C_DECLS
Definition: cs_defs.h:449
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:392
integer, dimension(5), save ipstdv
indicates the data to post-process on the boundary mesh (the boundary mesh must be associated with an...
Definition: entsor.f90:309
#define CS_PROCF(x, y)
Definition: cs_defs.h:472
integer, save nthist
output period of the chronological record files:
Definition: entsor.f90:186
void cs_gui_postprocess_fields(void)
Definition: cs_gui_output.c:1444