Functions to write dumps of scalar "history" variables in a formatted table. More...

Functions
void	dump_history (MeshS pM, OutputS pOut)
	Function to write dumps of scalar "history" variables in a formatted table.
void	dump_history_enroll (const ConsFun_t pfun, const char *label)
	Adds new user-defined history variables.
Variables
static char *	usr_label [MAX_USR_H_COUNT]
static ConsFun_t	phst_fun [MAX_USR_H_COUNT]
static int	usr_hst_cnt = 0

Detailed Description

Functions to write dumps of scalar "history" variables in a formatted table.

PURPOSE: Functions to write dumps of scalar "history" variables in a formatted table. "History" variables are mostly VOLUME AVERAGES, e.g.

S = {ijk} q[k][j][i]*dx1[i]*dx2[j]*dx3[k] / {ijk} dx1[i]*dx2[j]*dx3[k],

although other quantities like time and dt are also output. To compute TOTAL, VOLUME INTEGRATED quantities, just multiply by the Domain volume, which is output in the first line of the history file. History data is written periodically, giving the time-evolution of that quantitity. Default (hardwired) values are:

scal[0] = time
scal[1] = dt
scal[2] = mass
scal[3] = total energy
scal[4] = d*v1
scal[5] = d*v2
scal[6] = d*v3
scal[7] = 0.5*d*v1**2
scal[8] = 0.5*d*v2**2
scal[9] = 0.5*d*v3**2
scal[10] = 0.5*b1**2
scal[11] = 0.5*b2**2
scal[12] = 0.5*b3**2
scal[13] = d*Phi
scal[14+NSCALARS] = passively advected scalars
scal[15+NSCALARS] = angular momentum

More variables can be hardwired by increasing NSCAL=number of variables, and adding calculation of desired quantities below.

Alternatively, up to MAX_USR_H_COUNT new history variables can be added using dump_history_enroll() in the problem generator.

With SMR, data is averaged over each Domain separately, and dumped to separate files with the level and domain number encoded in the filename. Dumps are always made for all levels and domains, and are written in lev# directories of the root (rank=0) process FOR THAT DOMAIN COMMUNICATOR.

With SR, the default (hardwired) variables are: