KTH Framework: user-file subroutines

Register user specified modules. More...

Functions/Subroutines
subroutine	frame_usr_register
subroutine	frame_usr_init
	Initialise user specified modules. More...
subroutine	frame_usr_end
	Finalise user specified modules. More...
subroutine	user_map2d_get (idir, ctrs, cell, lctrs1, lctrs2, nelsort, map_xm1, map_ym1, ierr)
	Provide element coordinates and local numbers (user interface) More...
subroutine	user_stat_trnsv (lvel, dudx, dvdx, dwdx, vort)
	Provide velocity, deriv. and vort. in required coordinates. More...
subroutine	spatial_means
	Calculate spatial averaged quantities and write it into a text file. More...
subroutine	bounds_check (x)
	Check for nan or infinity. More...

Detailed Description

Register user specified modules.

Function/Subroutine Documentation

bounds_check()

subroutine bounds_check

(

real

x

)

Check for nan or infinity.

Parameters

[in]

x

real, variable to be checked

Todo:

Why are the error messages not displayed?

frame_usr_end()

subroutine frame_usr_end

Finalise user specified modules.

frame_usr_init()

subroutine frame_usr_init

Initialise user specified modules.

Todo:

The spng_init reference velocities are ignored at the moment. See also spng_forcing()

frame_usr_register()

subroutine frame_usr_register

spatial_means()

subroutine spatial_means

Calculate spatial averaged quantities and write it into a text file.

user_map2d_get()

subroutine user_map2d_get	(	integer	idir,
		real, dimension(lctrs1,lctrs2)	ctrs,
		integer, dimension(lctrs2)	cell,
		integer	lctrs1,
		integer	lctrs2,
		integer	nelsort,
		real, dimension(lx1,lz1,lelt)	map_xm1,
		real, dimension(lx1,lz1,lelt)	map_ym1,
		integer	ierr
	)

Provide element coordinates and local numbers (user interface)

Parameters

[out]	idir	mapping (uniform) direction
[out]	ctrs	2D element centres
[out]	cell	local element numberring
[in]	lctrs1,lctrs2	array sizes
[out]	nelsort	number of local 3D elements to sort
[out]	map_xm1,map_ym1	2D coordinates of mapped elements
[out]	ierr	error flag

user_stat_trnsv()

subroutine user_stat_trnsv	(	real, dimension(lx1,ly1,lz1,lelt,3)	lvel,
		real, dimension(lx1,ly1,lz1,lelt,3)	dudx,
		real, dimension(lx1,ly1,lz1,lelt,3)	dvdx,
		real, dimension(lx1,ly1,lz1,lelt,3)	dwdx,
		real, dimension(lx1,ly1,lz1,lelt,3)	vort
	)

Provide velocity, deriv. and vort. in required coordinates.

Parameters

[out]	lvel	velocity
[out]	dudx,dvdx,dwdx	velocity derivatives
[out]	vort	vorticity

NOTE: Coordinates swapped done for statistics! VY (numerical) -> w (physical, wall-normal direction) VZ (numerical) -> v (physical, spanwise direction)

NOTE: d/dy (numerical, gradm1) -> d/dz (wall-normal direction) d/dz (numerical, gradm1) -> d/dy (physical spanwise direction)