tem_spatial_module

Spatial functions let you describe functions that may vary in space. The are needed for initial conditions and volumetric information like source terms. A space-time function that depends also on time can be constructed by the space-time function of kind combined, see the tem_spacetime_fun_module.

The spatial functions may be constants, various predefined functions, or arbitrary Lua functions that depend on the three space coordinates. In the Lua script, the spatial function is either a constant scalar number, a Lua function, or a table.

If it is a table, it either is a constant definition for a vector value, for example a velocity definition, or it is a table that contains a definition of either a fun, const or predefined key. Here, fun would in turn need to be a Lua function, and const the definition of constant values (either a scalar, or a vector in a table). The predefined key signals the use of one of the available predefined functions and further parameters for their definition depend on the respective functions.

Available predefined functions are:

'crvpx' load_ic_2dcrvp
'crvpy' load_ic_2dcrvp
'crvppressure' load_ic_2dcrvp
'cylindricalwave' tem_cylindricalWave_module
'gausspulse' tem_ic_predefs_module
'heaviside_gibbs' tem_load_heaviside_gibbs
'miescatter_magneticfieldx' tem_load_miescatter
'miescatter_magneticfieldy' tem_load_miescatter
'parabol' load_spatial_parabol
'pml' tem_pmlLayer_module
'polygon_material' tem_polygon_material_module
'polygon_material_3d' tem_polygon_material_module
'random' load_spatial_random
'rectangular'
'spongelayer_plane' tem_spongeLayer_module
'spongelayer_plane_1d' tem_spongeLayer_module
'viscous_spongelayer_radial' tem_load_spongeLayer_radial
'viscous_spongelayer_radial_2d' tem_load_spongeLayer_radial
'viscous_spongelayer_box' tem_load_spongeLayer_box
'viscous_spongelayer_box_2d' tem_load_spongeLayer_box
'spongelayer_box' tem_load_spongeLayer_box
'spongelayer_box' tem_load_spongeLayer_box
'spongelayer_box_2d' tem_load_spongeLayer_box
'spongelayer_radial' tem_load_spongeLayer_radial
'tgv_p' load_ic_tgv
'tgv_ux' load_ic_tgv
'tgv_uy' load_ic_tgv
'tgv_sxx' load_ic_tgv
'tgv_sxz' load_ic_tgv
'tgv_syy' load_ic_tgv
'tgv_syz' load_ic_tgv

The simplest spatial function definition is just a constant scalar number:

  spatial = 1.0

Similarly the definition of a spatial function by a Lua function can simply be written as

  spatial = fun(x,y,z)
    return x*y*z
  end fun

The Lua function needs to take 3 arguments, representing the three spatial coordinates.

An example for the definition of a predefined function can take the following form:

  spatial = {
    predefined = 'random',
    min = 0,
    max = 1
  }

Uses

Variables

ref_amp

Variables

Type	Visibility	Attributes		Name		Initial
real(kind=rk),	private		::	ref_amp	=	1.0_rk

Interfaces

public interface tem_spatial_lua_for

private function tem_spatial_lua_for_treeIds(fun_ref, conf, treeIds, tree, n) result(res)

This function invokes the Lua function, in which the barycentric coordinates are computed from treeIds of an element.

Type	Intent		Name
integer,	intent(in)	::	fun_ref	Lua reference to the function to evaluate.
type(flu_State)		::	conf	lua state
integer(kind=long_k),	intent(in)	::	treeIds(n)	treeIds of elements in given level
type(treelmesh_type),	intent(in)	::	tree	global treelm mesh
integer,	intent(in)	::	n	number of return values

Type	Intent		Name
type(tem_canonicalND_type)		::	me	contains parameters for 2d parabola
integer(kind=long_k),	intent(in)	::	treeIds(n)	treeIds of elements in given level
type(treelmesh_type),	intent(in)	::	tree	global treelm mesh
integer,	intent(in)	::	n	number of return values

Type	Intent		Name
type(tem_canonicalND_type)		::	me	contains line parameters for 2d parabola
real(kind=rk),	intent(in)	::	coord(n,3)	barycentric Ids of an elements. 1st index goes over number of elements and 2nd index goes over x,y,z coordinates
integer,	intent(in)	::	n	number of return values

Type	Intent		Name
type(tem_canonicalND_type)		::	me	contains plane parameter for 3d parabola
integer(kind=long_k),	intent(in)	::	treeIds(n)	treeIds of elements in given level
type(treelmesh_type),	intent(in)	::	tree	global treelm mesh
integer,	intent(in)	::	n	number of return values

Type	Intent		Name
type(tem_canonicalND_type)		::	me	contains parameter for 3d parabola
real(kind=rk),	intent(in)	::	coord(n,3)	barycentric Ids of an elements. 1st index goes over number of elements and 2nd index goes over x,y,z coordinates
integer,	intent(in)	::	n	the number of return values

Type	Intent		Name
type(tem_spatial_type)		::	me	spatial type for given boundary state
integer(kind=long_k),	intent(in)	::	treeIds(n)	treeIds of elements in given level
type(treelmesh_type),	intent(in)	::	tree	global treelm mesh
integer,	intent(in)	::	n	number of return values

Type	Intent		Name
type(tem_spatial_type),	intent(in)	::	me	spatial type for given boundary state
real(kind=rk),	intent(in)	::	coord(n,3)	barycentric Ids of an elements. 1st index goes over number of elements and 2nd index goes over x,y,z coordinates
integer,	intent(in)	::	n	number of return values

Type	Intent		Name
type(tem_spatial_type),	intent(in)	::	me	spatial type
type(tem_grwPoints_type),	intent(in)	::	grwPnt	growing array of all spatial point of a variable
integer,	intent(in)	::	idx(nVals)	Index position to return a pre-store value or to compute
integer,	intent(in)	::	nVals	number of return values
integer,	intent(in)	::	iLevel	Level to which the evaluated values to be returned

Type	Intent		Name
type(tem_spatial_type),	intent(inout)	::	me	spatial type for given boundary state
real(kind=rk),	intent(in)	::	coord(nVals,3)	barycentric Ids of an elements. 1st index goes over number of elements and 2nd index goes over x,y,z coordinates
integer,	intent(in)	::	nVals	number of return values
integer,	intent(in)	::	iLevel	Level to which the evaluated values to be stored

Type	Visibility	Attributes		Name		Initial
character(len=LabelLen),	private		::	kind			Read more…
real(kind=rk),	private,	allocatable	::	const(:)			constant spatial value for nComponents
integer,	private		::	lua_fun_ref	=	0	Reference to the Lua function if the spatial function is defined as a Lua function.
type(flu_state),	private		::	conf
type(ic_gausspulse_type),	private		::	gausspulse			defines gausspulse
type(ic_2dcrvp_type),	private		::	crvp			2d co-rotating vortex pair
type(ic_tgv_type),	private		::	tgv			Taylor-Green vortex type
type(spatial_parabol_type),	private		::	parabol			Parabol type
type(spatial_random_type),	private		::	random			Random type
type(spatial_hopf_type),	private		::	hopf			Hopf Fibration type
type(tem_miescatter_field_type),	private		::	mie_fun			Spatial function for Mie-series solution of electrodynamic scattering at dielectric sphere.
type(tem_heaviside_gibbs_type),	private		::	heaviside_gibbs_fun			Spatial function for Heaviside function including Gibbs oscillations.
type(spatial_value_type),	private		::	valOnLvl(globalMaxLevels)			store spatial value on each level
type(tem_spongeLayer_plane_type),	private		::	spongePlane			type for the plane sponge layer
type(tem_spongeLayer_box_type),	private		::	spongeBox			type for the box sponge layer
type(tem_spongeLayer_radial_type),	private		::	spongeRadial			type for the radial sponge layer
type(tem_pmlLayer_type),	private		::	pml			type for the pml damping medium
type(tem_cylindricalWave_type),	private		::	cylindricalWave			type for a scalar cylindrical wave.
type(tem_polygon_material_type),	private		::	polygon_material			Description of a material definition by a polygon.
real(kind=rk),	private		::	rect_ly			range of x and y dimention for rectangular function
real(kind=rk),	private		::	rect_lz
logical,	private		::	isStored	=	.false.	to store spatial values during initialization

Type	Visibility	Attributes		Name		Initial
type(tem_shape_type),	private		::	geometry			define point, line or plane spatial profile
real(kind=rk),	private,	allocatable	::	amplitude(:)			magnitude of the spatial value

Type	Visibility		Name
real(kind=rk),	private	::	val_min	Minimal value to produce
real(kind=rk),	private	::	val_max	Maximal value to produce
real(kind=rk),	private	::	val_range	Length of the value interval

Type	Visibility	Attributes		Name		Initial
real(kind=rk),	private		::	radius			Minimal value to produce
real(kind=rk),	private		::	p0			Maximal value to produce

Type	Intent	Optional	Attributes		Name
type(spatial_random_type),	intent(in)			::	me	Interval definition to get the random values from.
integer,	intent(in)			::	n	number of return values

Type	Intent	Optional		Name
type(tem_spatial_type),	intent(out)		::	me	spatial boundary state type
type(flu_State)			::	conf	lua state type
integer,	intent(in)		::	parent	aotus parent handle
character(len=*),	intent(in),	optional	::	key	state variable key string defined in lua
real(kind=rk),	intent(in),	optional	::	defaultValue	What should be set s a default value for the quantities if no quantity was given in the lua file
integer,	intent(in),	optional	::	nComp	number of components of the variable
integer,	intent(out),	optional	::	errCode	Error code from lua loading

Type	Intent		Name
type(tem_spatial_type),	intent(inout)	::	me	spatial fun information
type(flu_State)		::	conf	lua state type
integer,	intent(in)	::	thandle	spatial function handle
integer,	intent(in)	::	nComp	Number of components

Type	Intent		Name
type(spatial_parabol_type),	intent(out)	::	me	parabola3d spatial datas
type(flu_State)		::	conf	lua state type
integer,	intent(in)	::	thandle	aotus parent handle
integer,	intent(in)	::	nComp	Number of components

Type	Intent		Name
type(spatial_random_type),	intent(out)	::	me	random spatial specification
type(flu_State)		::	conf	lua state type
integer,	intent(in)	::	thandle	aotus parent handle

tem_spatial_module Module

Contents

Uses

Used by

Contents

Variables

Interfaces

public interface tem_spatial_lua_for

private function tem_spatial_lua_for_treeIds(fun_ref, conf, treeIds, tree, n) result(res)

Arguments

Return Value real(kind=rk)(n)

private function tem_spatial_lua_for_coord(fun_ref, conf, coord, n) result(res)

Arguments

Return Value real(kind=rk)(n)

private function tem_spatial_lua_for_index(fun_ref, conf, grwPnt, idx, nVals) result(res)

Arguments

Return Value real(kind=rk)(nVals)

private function tem_spatial_lua_vector_for_treeIds(fun_ref, conf, treeIds, tree, n, ncomp) result(res)

Arguments

Return Value real(kind=rk)(n,ncomp)

private function tem_spatial_lua_vector_for_coord(fun_ref, conf, coord, n, ncomp) result(res)

Arguments

Return Value real(kind=rk)(n,ncomp)

private function tem_spatial_lua_vector_for_index(fun_ref, conf, grwPnt, idx, nVals, nComps) result(res)

Arguments

Return Value real(kind=rk)(nVals,nComps)

public interface tem_spatial_parabol2d_for

private function tem_spatial_parabol2d_for_treeIds(me, treeIds, tree, n) result(res)

Arguments

Return Value real(kind=rk)(n)

private function tem_spatial_parabol2d_for_coord(me, coord, n) result(res)

Arguments

Return Value real(kind=rk)(n)

public interface tem_spatial_parabol3d_for

private function tem_spatial_parabol3d_for_treeIds(me, treeIds, tree, n) result(res)

Arguments

Return Value real(kind=rk)(n)

private function tem_spatial_parabol3d_for_coord(me, coord, n) result(res)

Arguments

Return Value real(kind=rk)(n)

public interface tem_spatial_for

private function tem_spatial_for_treeIDs(me, treeIds, tree, n) result(res)

Arguments

Return Value real(kind=rk)(n)

private function tem_spatial_for_coord(me, coord, n) result(res)

Arguments

Return Value real(kind=rk)(n)

private function tem_spatial_vector_for_treeIDs(me, treeIds, tree, n, ncomp) result(res)

Arguments

Return Value real(kind=rk)(n,ncomp)

private function tem_spatial_vector_for_coord(me, coord, n, ncomp) result(res)

Arguments

Return Value real(kind=rk)(n,ncomp)

private function tem_spatial_scalar_for_index(me, grwPnt, idx, nVals, iLevel) result(res)

Arguments

Return Value real(kind=rk)(nVals)

private function tem_spatial_vector_for_index(me, grwPnt, idx, nVals, iLevel, nComps) result(res)

Arguments

Return Value real(kind=rk)(nVals,nComps)

public interface tem_spatial_storeVal

private subroutine tem_spatial_scalar_storeVal(me, coord, nVals, iLevel)

Arguments

private subroutine tem_spatial_vector_storeVal(me, coord, nVals, iLevel, nComps)

Arguments

Derived Types

type, public :: tem_spatial_type

Components

type, private :: spatial_value_type

Components

type, private :: spatial_parabol_type

Components

type, private :: spatial_random_type

Components

type, private :: spatial_hopf_type

Components

Functions

private function tem_spatial_parabol3d_for_treeIds(me, treeIds, tree, n) result(res)

Arguments

Return Value real(kind=rk)(n)

private function tem_spatial_parabol3d_for_coord(me, coord, n) result(res)