KTH Toolbox: stat

Files
file	stat.f
	2D and 3D statistics module
file	stat_IO.f
	IO routines for 2D/3D statistics module.

Functions/Subroutines
subroutine	stat_register ()
	Register 2D and 3D statistics module. More...
subroutine	stat_init ()
	Initilise statistics module. More...
logical function	stat_is_initialised ()
	Check if module was initialised. More...
subroutine	stat_avg
	Main interface of statistics module. More...
subroutine	stat_init_int1d ()
	Get local integration coefficients. More...
subroutine	stat_reshufflev (rvar, var, nl)
	Array reshuffle. More...
subroutine	stat_compute_1dav1 (lvar, npos, alpha, beta)
	Perform local 1D integration on 1 variable. More...
subroutine	stat_compute_1dav2 (lvar1, lvar2, npos, alpha, beta)
	Perform local 1D integration on multiplication of 2 variables. More...
subroutine	stat_gs_sum
	Global statistics summation. More...
subroutine	stat_compute ()
	Compute statistics. More...
subroutine	stat_mfo ()
	Main interface for saving statistics. More...
subroutine	stat_mfo_outfld3d ()
	Statistics muti-file output of 3D data. More...
subroutine	stat_mfo_outfld2d ()
	Statistics muti-file output of 2D data. More...
subroutine	stat_mfo_write_hdr2d
	Write hdr, byte key, global ordering of 2D data. More...
subroutine	stat_mfo_write_stat2d
	Write additional data at the end of the file. More...
subroutine	stat_mfo_crd2d
	Write element centres to the file (in case of AMR level as well) More...

Detailed Description

Function/Subroutine Documentation

stat_avg()

subroutine stat_avg

Main interface of statistics module.

This routine performs time averaging and file writing.

Note

This routine should be called in userchk during every step

stat_compute()

subroutine stat_compute

Compute statistics.

Remarks

This routine uses global scratch space SCRMG, SCRUZ, SCRNS, SCRSF

stat_compute_1dav1()

subroutine stat_compute_1dav1	(	real, dimension(lx1,ly1,lz1,lelt)	lvar,
		integer	npos,
		real	alpha,
		real	beta
	)

Perform local 1D integration on 1 variable.

Parameters

[in]	lvar	integrated variable
[in]	npos	position in stat_ruavg
[in]	alpha,beta	time averaging parameters

Remarks

This routine uses global scratch space CTMP0

stat_compute_1dav2()

subroutine stat_compute_1dav2	(	real, dimension(lx1,ly1,lz1,lelt)	lvar1,
		real, dimension(lx1,ly1,lz1,lelt)	lvar2,
		integer	npos,
		real	alpha,
		real	beta
	)

Perform local 1D integration on multiplication of 2 variables.

Parameters

[in]	lvar1,lvar2	integrated variable
[in]	npos	position in stat_ruavg
[in]	alpha,beta	time averaging parameters

Remarks

This routine uses global scratch space CTMP0

stat_gs_sum()

subroutine stat_gs_sum

Global statistics summation.

stat_init()

subroutine stat_init

Initilise statistics module.

Note

This routine should be called in frame_usr_init

stat_init_int1d()

subroutine stat_init_int1d

Get local integration coefficients.

This version does 1D integration over one of the directions R,S,T. It supports curved coordinate systems, however axisymmetric 2.5D cases are not supported

Remarks

This routine uses global scratch space SCRSF

stat_is_initialised()

logical function stat_is_initialised

Check if module was initialised.

Returns

stat_is_initialised

stat_mfo()

subroutine stat_mfo

Main interface for saving statistics.

Todo:

Implement stat_mfo_outfld1D and 1D coords like map2d_{xm1,ym1}

stat_mfo_crd2d()

subroutine stat_mfo_crd2d

Write element centres to the file (in case of AMR level as well)

stat_mfo_outfld2d()

subroutine stat_mfo_outfld2d

Statistics muti-file output of 2D data.

This routine is just modification of mfo_outfld

Remarks

This routine uses global scratch space SCRUZ

stat_mfo_outfld3d()

subroutine stat_mfo_outfld3d

Statistics muti-file output of 3D data.

stat_mfo_write_hdr2d()

subroutine stat_mfo_write_hdr2d

Write hdr, byte key, global ordering of 2D data.

This routine is just modification of mfo_write_hdr

Remarks

This routine uses global scratch space CTMP0

stat_mfo_write_stat2d()

subroutine stat_mfo_write_stat2d

Write additional data at the end of the file.

stat_register()

subroutine stat_register

Register 2D and 3D statistics module.

Note

This routine should be called in frame_usr_register

stat_reshufflev()

subroutine stat_reshufflev	(	real, dimension(lx1,ly1,lz1,lelt)	rvar,
		real, dimension(lx1,ly1,lz1,lelt)	var,
		integer	nl
	)

Array reshuffle.

Reorder directions in such a way that the uniform direction corresponds to the the first index

Parameters

[out]	rvar	reshuffled array
[in]	var	input array
[in]	nl	element number to reshuffle