time step descriptor More...

#include <cs_time_step.h>

Collaboration diagram for cs_time_step_t:

Data Fields
int	is_variable

int	is_local

int	nt_prev

int	nt_cur

int	nt_max

int	nt_ini

double	t_prev

double	t_cur

double	t_max

double	dt [3]

double	dt_ref

double	dt_next

Detailed Description

time step descriptor

Members of this time step are publicly accessible, to allow for concise syntax, as it is expected to be used in many places.

Field Documentation

◆ dt

double dt[3]

◆ dt_next

double dt_next

◆ dt_ref

dt_ref

Reference time step.
This is the time step value used in the case of a calculation run with a uniform and constant time step, i.e. idtvar =0 (restart calculation or not). It is the value used to initialize the time step in the case of an initial calculation run with a non-constant time step(idtvar=1 or 2). It is also the value used to initialise the time step in the case of a restart calculation in which the type of time step has been changed (for instance, idtvar=1 in the new calculation and idtvar = 0 or 2 in the previous calculation).
See Time step modification for examples.

◆ is_local

is_local

0 if time step is uniform in space, 0 if is is local (in which case the time value is only a reference)

◆ is_variable

is_variable

0 if time step is fixed in time, 1 otherwise

◆ nt_cur

nt_cur

current absolute time step number In case of restart, this is equal to nt_prev + number of new iterations.

◆ nt_ini

nt_ini

number of time step for initialization

◆ nt_max

nt_max

maximum absolute time step number For the restart calculations, nt_max takes into account the number of time steps of the previous calculations. For instance, after a first calculation of 3 time steps, a restart file of 2 time steps is realised by setting nt_max = 3+2 = 5

◆ nt_prev

nt_prev

Absolute time step number for previous calculation. In the case of a restart calculation, nt_prev is read from the restart file. Otherwise, it is initialised to 0 nt_prev is initialised automatically by the code, its value is not to be modified by the user.

◆ t_cur

t_cur

Current absolute time. For the restart calculations, t_cur takes into account the physical time of the previous calculations.
If the time step is uniform (idtvar = 0 or 1), t_cur increases of dt (value of the time step) at each iteration. If the time step is non-uniform (idtvar=2), t_cur increases of dt_ref at each time step.
t_cur is initialised and updated automatically by the code, its value is not to be modified by the user.

◆ t_max

t_max

maximum absolute time

◆ t_prev

t_prev

Absolute time value for previous calculation. In the case of a restart calculation, t_prev is read from the restart file. Otherwise it is initialised to 0.
t_prev is initialised automatically by the code, its value is not to be modified by the user.

The documentation for this struct was generated from the following files:

src/base/cs_time_step.h
src/base/cs_time_step.c

Data Fields