programmer's documentation
Variables
History user files

Variables

integer nushmx
 Maximum number of user chronological files. In the case where ushist is used. More...
 
character(len=80), save emphis
 directory in which the potential chronological record files generated by the Kernel will be written (path related to the execution directory) More...
 
character(len=80), save prehis
 prefix of history files More...
 
integer, dimension(nushmx), save impush
 units of the user chronological record files. Useful if and only if the subroutine ushist is used. More...
 
character(len=13), dimension(nushmx), save ficush
 names of the user chronological record files. In the case of a non-parallel calculation, the suffix applied the file name is a three digit number: $ \texttt{ush001}$, $\texttt{ush002}$, $\texttt{ush003}$... In the case of a parallel-running calculation, the four digit processor index-number is added to the suffix. For instance, for a calculation running on two processors: -from $ \texttt{ush001.n\_0001} $ to $ \texttt{ush010.n\_0001} $ -and $ \texttt{ush001.n\_0002} $ to $ \texttt{ush010.n\_0002} $. More...
 
integer, dimension(2), save impsth
 stock file and mobile structure variables output unit More...
 
integer ncaptm
 maximum number of probes see associated format in ecrhis More...
 
integer, save tplfmt
 time plot format (1: .dat, 2: .csv, 3: both) More...
 
integer, save ncapt
 total number of probes (limited to ncaptm=100) More...
 
integer, save nthist
 output period of the chronological record files: More...
 
double precision, save frhist
 frhist : output frequency in seconds More...
 
integer, save nthsav
 saving period the chronological record files (they are first stored in a temporary file and then saved every nthsav time step): More...
 
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 variable, em i.e. calculation variable or physical property defined at the cell centers. With ihisvr(n, 1)=-999 or -1, ihisvr(n, j>1) is useless. More...
 
integer, save ihistr
 write indicator (O or 1) for history of internal mobile structures More...
 
integer, dimension(ncaptm), save nodcap
 probes corresponding element More...
 
integer, dimension(ncaptm), save ndrcap
 row of process containing nodcap (in parallel processing) More...
 
double precision, dimension(3, ncaptm), save xyzcap
 xyzcap : required position for a probe 3D-coordinates of the probes. the coordinates are written: xyzcap(i,j), with i = 1,2 or 3 and j <= ncapt. Useful if and only if ncapt > 0. More...
 
double precision, save tplflw
 tplflw : time plot flush wall-time interval (none if <= 0) More...
 

Detailed Description

Variable Documentation

character(len=80), save emphis

directory in which the potential chronological record files generated by the Kernel will be written (path related to the execution directory)

  • it is recommended to keep the default value and, if necessary, to modify the launch script to copy the files in the alternate destination directory
  • useful if and only if chronological record files are generated (i.e. there is n for which ihisvr(n, 1) $\ne$ 0)
character(len=13), dimension(nushmx), save ficush

names of the user chronological record files. In the case of a non-parallel calculation, the suffix applied the file name is a three digit number: $ \texttt{ush001}$, $\texttt{ush002}$, $\texttt{ush003}$... In the case of a parallel-running calculation, the four digit processor index-number is added to the suffix. For instance, for a calculation running on two processors: -from $ \texttt{ush001.n\_0001} $ to $ \texttt{ush010.n\_0001} $ -and $ \texttt{ush001.n\_0002} $ to $ \texttt{ush010.n\_0002} $.

  • ush001.n_0002, ush002.n_0002, ush003.n_0002... The opening, closing, format and location of these files must be managed by the user. Useful if and only if the subroutine ushist is used
double precision, save frhist

frhist : output frequency in seconds

integer, save ihistr

write indicator (O or 1) for history of internal mobile structures

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 variable, em i.e. calculation variable or physical property defined at the cell centers. With ihisvr(n, 1)=-999 or -1, ihisvr(n, j>1) is useless.

  • ihisvr(n, 1): number of record probes to use for the variable N.
    • = -999: by default: chronogical records are generated on all the probes if N is one of the main variables (pressure, velocity, turbulence, scalars), the local time step or the turbulent viscosity. For the other quantities, no chronological record is generated.
    • = -1: chronological records are produced on all the probes.
    • = 0: no chronological record on any probe.
    • > 0: chronological record on ihisvr(n, 1) probes to be specified with ihisvr(n, j>1). always useful, must be inferior or equal to ncapt.
  • ihisvr(n, j>1): index-numbers of the probes used for the variable n. (with j <= ihisvr(n,1)+1).
    • = -999: by default: if ihisvr(n, 1) $\ne$ -999 the code stops. Otherwise, refer to the description of the case ihisvr(n, 1)=-999.

Useful if and only if ihisvr(n, 1) > 0 .

The condition ihisvr(n, j) <= ncapt must be respected. For an easier use, it is recommended to simply specify ihisvr(n,1)=-1 for all the interesting variables.

integer, dimension(2), save impsth

stock file and mobile structure variables output unit

integer, dimension(nushmx), save impush

units of the user chronological record files. Useful if and only if the subroutine ushist is used.

integer, save ncapt

total number of probes (limited to ncaptm=100)

integer ncaptm

maximum number of probes see associated format in ecrhis

integer, dimension(ncaptm), save ndrcap

row of process containing nodcap (in parallel processing)

integer, dimension(ncaptm), save nodcap

probes corresponding element

integer, save nthist

output period of the chronological record files:

  • -1: no output
  • >0: period (every nthist time step)

The default value is -1 if there is no chronological record file to generate (if there is no probe, ncapt = 0, or if ihisvr(n, 1)=0 for all the variables) and 1 otherwise. If chronological records are generated, it is usually wise to keep the default value nthist=1, in order to avoid missing any high frequency evolution (unless the total number of time steps is much too big). Useful if and only if chronological record files are generated ( i.e. there are probes (ncapt>0) there is n for which ihisvr(n, 1) $\ne$ 0)

integer, save nthsav

saving period the chronological record files (they are first stored in a temporary file and then saved every nthsav time step):

  • 0: by default (4 times during a calculation)
  • -1: saving at the end of the calculation
  • >0: period (every nthsav time step)

During the calculation, the user can read the chronological record files in the execution directory when they have been saved, i.e. at the first time step, at the tenth time step and when the time step number is a multiple of nthsav (multiple of (ntmabs

  • ntpabs)/4 if nthsav=0).
    Note
    Using the control_file file allows to update the value of ntmabs. Hence, if the calculation is at the time step n, the saving of the chronological record files can be forced by changing ntmabs to ntpabs+4(n+1)
    Using control_file; after the files have been saved, ntmabs can be reset to its original value, still using control_file. Useful if and only if chronological record files are generated (i.e. there are probes (ncapt>0) there is n for which ihisvr(n, 1) $\ne$ 0)
integer nushmx

Maximum number of user chronological files. In the case where ushist is used.

character(len=80), save prehis

prefix of history files

double precision, save tplflw

tplflw : time plot flush wall-time interval (none if <= 0)

integer, save tplfmt

time plot format (1: .dat, 2: .csv, 3: both)

double precision, dimension(3,ncaptm), save xyzcap

xyzcap : required position for a probe 3D-coordinates of the probes. the coordinates are written: xyzcap(i,j), with i = 1,2 or 3 and j <= ncapt. Useful if and only if ncapt > 0.