tem_spacetime_var_module

This module provides variable definitions for space time functions.

Interfaces

public interface tem_varSys_append_stfun

private subroutine tem_varSys_append_stFunVar(stFunVar, varSys, st_funList, solverData_evalElem)

subroutine to add the variables from the input lua script to the varsys

Arguments

Type	Intent	Optional		Name
type(tem_variable_type),	intent(in)		::	stFunVar	variables defined in the lua file
type(tem_varSys_type),	intent(inout)		::	varSys	global variable system to which stFunVar to be appended
type(tem_st_fun_linkedList_type),	intent(inout)		::	st_funList	contains spacetime functions of all variables
type(tem_varSys_solverData_evalElem_type),	intent(in),	optional	::	solverData_evalElem	A setter routine that allows the caller to define routine for the construction of an element representation.

private subroutine tem_varSys_append_stFun_raw(varSys, stFun, varname, nComp, evaltype, st_funList, solverData_evalElem)

subroutine to add the variables from the input lua script to the varsys

Arguments

Type	Intent	Optional	Attributes		Name
type(tem_varSys_type),	intent(inout)			::	varSys	global variable system to which stFunVar to be appended
type(tem_spacetime_fun_type),	intent(in),		pointer	::	stFun(:)	variables defined in the lua file
character(len=*),	intent(in)			::	varname
integer,	intent(in),	optional		::	nComp
character(len=*),	intent(in),	optional		::	evaltype
type(tem_st_fun_linkedList_type),	intent(inout),	optional		::	st_funList	contains spacetime functions of all variables
type(tem_varSys_solverData_evalElem_type),	intent(in),	optional		::	solverData_evalElem	A setter routine that allows the caller to define routine for the construction of an element representation.

Subroutines

public recursive subroutine evaluate_FOAG_spacetime_scalarByCoordinate(fun, varSys, point, time, tree, nPnts, res)

This subroutine directly evaluate spacetime function for given coordinate points on 1st st_fun assuming global shape.

Arguments

Type	Intent		Name
class(tem_varSys_op_type),	intent(in)	::	fun	Description of the method to obtain the variables, here some preset values might be stored, like the space time function to use or the required variables.
type(tem_varSys_type),	intent(in)	::	varSys	The variable system to obtain the variable from.
real(kind=rk),	intent(in)	::	point(:,:)	Three-dimensional coordinates at which the variable should be evaluated. Only useful for variables provided as space-time functions.
type(tem_time_type),	intent(in)	::	time	Point in time at which to evaluate the variable.
type(treelmesh_type),	intent(in)	::	tree	global treelm mesh info
integer,	intent(in)	::	nPnts	Number of values to obtain for this variable (vectorized access).
real(kind=rk),	intent(out)	::	res(:)	Resulting values for the requested variable. Read more…

public recursive subroutine evaluate_add_spacetime_scalarByCoordinate(fun, varSys, point, time, tree, nPnts, res)

This subroutine add multiple spacetime function for given coordinate points. Spacetime function are evaluated only on the coordinate which belong to st_fun shape.

Arguments

Type	Intent		Name
class(tem_varSys_op_type),	intent(in)	::	fun	Description of the method to obtain the variables, here some preset values might be stored, like the space time function to use or the required variables.
type(tem_varSys_type),	intent(in)	::	varSys	The variable system to obtain the variable from.
real(kind=rk),	intent(in)	::	point(:,:)	Three-dimensional coordinates at which the variable should be evaluated. Only useful for variables provided as space-time functions.
type(tem_time_type),	intent(in)	::	time	Point in time at which to evaluate the variable.
type(treelmesh_type),	intent(in)	::	tree	global treelm mesh info
integer,	intent(in)	::	nPnts	Number of values to obtain for this variable (vectorized access).
real(kind=rk),	intent(out)	::	res(:)	Resulting values for the requested variable. Read more…

public recursive subroutine evaluate_first_spacetime_scalarByCoordinate(fun, varSys, point, time, tree, nPnts, res)

This subroutine returns first spacetime function on overlapping regions fo given coordinate points. Spacetime function are evaluated only on the coordinate which belong to st_fun shape.

Arguments

Type	Intent		Name
class(tem_varSys_op_type),	intent(in)	::	fun	Description of the method to obtain the variables, here some preset values might be stored, like the space time function to use or the required variables.
type(tem_varSys_type),	intent(in)	::	varSys	The variable system to obtain the variable from.
real(kind=rk),	intent(in)	::	point(:,:)	Three-dimensional coordinates at which the variable should be evaluated. Only useful for variables provided as space-time functions.
type(tem_time_type),	intent(in)	::	time	Point in time at which to evaluate the variable.
type(treelmesh_type),	intent(in)	::	tree	global treelm mesh info
integer,	intent(in)	::	nPnts	Number of values to obtain for this variable (vectorized access).
real(kind=rk),	intent(out)	::	res(:)	Resulting values for the requested variable. Read more…

public recursive subroutine evaluate_FOAG_spacetime_vectorByCoordinate(fun, varSys, point, time, tree, nPnts, res)

This subroutine directly evaluate spacetime function for given coordinate points on 1st st_fun assuming global shape for vectorial variable

Arguments

Type	Intent		Name
class(tem_varSys_op_type),	intent(in)	::	fun	Description of the method to obtain the variables, here some preset values might be stored, like the space time function to use or the required variables.
type(tem_varSys_type),	intent(in)	::	varSys	The variable system to obtain the variable from.
real(kind=rk),	intent(in)	::	point(:,:)	Three-dimensional coordinates at which the variable should be evaluated. Only useful for variables provided as space-time functions.
type(tem_time_type),	intent(in)	::	time	Point in time at which to evaluate the variable.
type(treelmesh_type),	intent(in)	::	tree	global treelm mesh info
integer,	intent(in)	::	nPnts	Number of values to obtain for this variable (vectorized access).
real(kind=rk),	intent(out)	::	res(:)	Resulting values for the requested variable. Read more…

public recursive subroutine evaluate_add_spacetime_vectorByCoordinate(fun, varSys, point, time, tree, nPnts, res)

This subroutine add multiple spacetime function for given coordinate points. Spacetime function are evaluated only on the coordinate which belong to st_fun shape for vectorial variable.

Arguments

Type	Intent		Name
class(tem_varSys_op_type),	intent(in)	::	fun	Description of the method to obtain the variables, here some preset values might be stored, like the space time function to use or the required variables.
type(tem_varSys_type),	intent(in)	::	varSys	The variable system to obtain the variable from.
real(kind=rk),	intent(in)	::	point(:,:)	Three-dimensional coordinates at which the variable should be evaluated. Only useful for variables provided as space-time functions.
type(tem_time_type),	intent(in)	::	time	Point in time at which to evaluate the variable.
type(treelmesh_type),	intent(in)	::	tree	global treelm mesh info
integer,	intent(in)	::	nPnts	Number of values to obtain for this variable (vectorized access).
real(kind=rk),	intent(out)	::	res(:)	Resulting values for the requested variable. Read more…

public recursive subroutine evaluate_first_spacetime_vectorByCoordinate(fun, varSys, point, time, tree, nPnts, res)

This subroutine returns first spacetime function on overlapping regions fo given coordinate points for vectorial variable. Spacetime function are evaluated only on the coordinate which belong to st_fun shape.

Arguments

Type	Intent		Name
class(tem_varSys_op_type),	intent(in)	::	fun	Description of the method to obtain the variables, here some preset values might be stored, like the space time function to use or the required variables.
type(tem_varSys_type),	intent(in)	::	varSys	The variable system to obtain the variable from.
real(kind=rk),	intent(in)	::	point(:,:)	Three-dimensional coordinates at which the variable should be evaluated. Only useful for variables provided as space-time functions.
type(tem_time_type),	intent(in)	::	time	Point in time at which to evaluate the variable.
type(treelmesh_type),	intent(in)	::	tree	global treelm mesh info
integer,	intent(in)	::	nPnts	Number of values to obtain for this variable (vectorized access).
real(kind=rk),	intent(out)	::	res(:)	Resulting values for the requested variable. Read more…

public recursive subroutine evaluate_FOAG_spacetime_scalarByTreeID(fun, varSys, elempos, time, tree, nElems, nDofs, res)

This subroutine directly evaluate spacetime function for given element position in global TreeID list on 1st st_fun assuming global shape.

Arguments

Type	Intent		Name
class(tem_varSys_op_type),	intent(in)	::	fun	Description of the method to obtain the variables, here some preset values might be stored, like the space time function to use or the required variables.
type(tem_varSys_type),	intent(in)	::	varSys	The variable system to obtain the variable from.
integer,	intent(in)	::	elempos(:)	Position of the TreeID of the element to get the variable for in the global treeID list.
type(tem_time_type),	intent(in)	::	time	Point in time at which to evaluate the variable.
type(treelmesh_type),	intent(in)	::	tree	global treelm mesh info
integer,	intent(in)	::	nElems	Number of values to obtain for this variable (vectorized access).
integer,	intent(in)	::	nDofs	Number of degrees of freedom within an element.
real(kind=rk),	intent(out)	::	res(:)	Resulting values for the requested variable. Read more…

public recursive subroutine evaluate_add_spacetime_scalarByTreeID(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Call the spacetime function for scalar variable, which are stored in method_data which intern points to tem_st_fun_listelem_type. this spacetime function can be used as a analytical solution for reference. note: ndofs is not used by this routine. so, to evaluate spacetime function for ndofs in an element, use tem_varsys_proc_point interface.

Arguments

Type	Intent		Name
class(tem_varSys_op_type),	intent(in)	::	fun	Description of the method to obtain the variables, here some preset values might be stored, like the space time function to use or the required variables.
type(tem_varSys_type),	intent(in)	::	varSys	The variable system to obtain the variable from.
integer,	intent(in)	::	elempos(:)	Position of the TreeID of the element to get the variable for in the global treeID list.
type(tem_time_type),	intent(in)	::	time	Point in time at which to evaluate the variable.
type(treelmesh_type),	intent(in)	::	tree	global treelm mesh info
integer,	intent(in)	::	nElems	Number of values to obtain for this variable (vectorized access).
integer,	intent(in)	::	nDofs	Number of degrees of freedom within an element.
real(kind=rk),	intent(out)	::	res(:)	Resulting values for the requested variable. Read more…

public recursive subroutine evaluate_first_spacetime_scalarByTreeID(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Arguments

Type	Intent		Name
class(tem_varSys_op_type),	intent(in)	::	fun	Description of the method to obtain the variables, here some preset values might be stored, like the space time function to use or the required variables.
type(tem_varSys_type),	intent(in)	::	varSys	The variable system to obtain the variable from.
integer,	intent(in)	::	elempos(:)	Position of the TreeID of the element to get the variable for in the global treeID list.
type(tem_time_type),	intent(in)	::	time	Point in time at which to evaluate the variable.
type(treelmesh_type),	intent(in)	::	tree	global treelm mesh info
integer,	intent(in)	::	nElems	Number of values to obtain for this variable (vectorized access).
integer,	intent(in)	::	nDofs	Number of degrees of freedom within an element.
real(kind=rk),	intent(out)	::	res(:)	Resulting values for the requested variable. Read more…

public recursive subroutine evaluate_FOAG_spacetime_vectorByTreeID(fun, varSys, elempos, time, tree, nElems, nDofs, res)

This subroutine directly evaluate spacetime function for given element position in global TreeID list on 1st st_fun assuming global shape for vectorial variable.

Arguments

Type	Intent		Name
class(tem_varSys_op_type),	intent(in)	::	fun	Description of the method to obtain the variables, here some preset values might be stored, like the space time function to use or the required variables.
type(tem_varSys_type),	intent(in)	::	varSys	The variable system to obtain the variable from.
integer,	intent(in)	::	elempos(:)	Position of the TreeID of the element to get the variable for in the global treeID list.
type(tem_time_type),	intent(in)	::	time	Point in time at which to evaluate the variable.
type(treelmesh_type),	intent(in)	::	tree	global treelm mesh info
integer,	intent(in)	::	nElems	Number of values to obtain for this variable (vectorized access).
integer,	intent(in)	::	nDofs	Number of degrees of freedom within an element.
real(kind=rk),	intent(out)	::	res(:)	Resulting values for the requested variable. Read more…

public recursive subroutine evaluate_add_spacetime_vectorByTreeID(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Call the spacetime function for vector variable, which are stored in method_data which intern points to tem_st_fun_listElem_type. This spacetime function can be used as a analytical solution for reference. NOTE: nDofs is not used by this routine. So, to evaluate spacetime function for nDofs in an element, use tem_varSys_proc_point interface.

Arguments

Type	Intent		Name
class(tem_varSys_op_type),	intent(in)	::	fun	Description of the method to obtain the variables, here some preset values might be stored, like the space time function to use or the required variables.
type(tem_varSys_type),	intent(in)	::	varSys	The variable system to obtain the variable from.
integer,	intent(in)	::	elempos(:)	Position of the TreeID of the element to get the variable for in the global treeID list.
type(tem_time_type),	intent(in)	::	time	Point in time at which to evaluate the variable.
type(treelmesh_type),	intent(in)	::	tree	global treelm mesh info
integer,	intent(in)	::	nElems	Number of values to obtain for this variable (vectorized access).
integer,	intent(in)	::	nDofs	Number of degrees of freedom within an element.
real(kind=rk),	intent(out)	::	res(:)	Resulting values for the requested variable. Read more…

public recursive subroutine evaluate_first_spacetime_vectorByTreeID(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Arguments

Type	Intent		Name
class(tem_varSys_op_type),	intent(in)	::	fun	Description of the method to obtain the variables, here some preset values might be stored, like the space time function to use or the required variables.
type(tem_varSys_type),	intent(in)	::	varSys	The variable system to obtain the variable from.
integer,	intent(in)	::	elempos(:)	Position of the TreeID of the element to get the variable for in the global treeID list.
type(tem_time_type),	intent(in)	::	time	Point in time at which to evaluate the variable.
type(treelmesh_type),	intent(in)	::	tree	global treelm mesh info
integer,	intent(in)	::	nElems	Number of values to obtain for this variable (vectorized access).
integer,	intent(in)	::	nDofs	Number of degrees of freedom within an element.
real(kind=rk),	intent(out)	::	res(:)	Resulting values for the requested variable. Read more…

public recursive subroutine set_params_spacetime(fun, varSys, instring)

This routine process instring and store information in spacetime function.

Arguments

Type	Intent		Name
class(tem_varSys_op_type),	intent(in)	::	fun	Description of the method to obtain the variables, here some preset values might be stored, like the space time function to use or the required variables.
type(tem_varSys_type),	intent(in)	::	varSys	The variable system to obtain the variable from.
character(len=*),	intent(in)	::	instring	Input string with parameter to set in method_data

public recursive subroutine get_params_spacetime(fun, varSys, instring, outstring)

This routine process instring and return string with requested info from spacetime function

Arguments

Type	Intent		Name
class(tem_varSys_op_type),	intent(in)	::	fun	Description of the method to obtain the variables, here some preset values might be stored, like the space time function to use or the required variables.
type(tem_varSys_type),	intent(in)	::	varSys	The variable system to obtain the variable from.
character(len=*),	intent(in)	::	instring	Input string with parameter to set in method_data
character(len=*),	intent(out)	::	outstring	Output string with requested parameter value from method_data

public recursive subroutine setup_indices_spacetime(fun, varSys, point, offset_bit, iLevel, tree, nPnts, idx)

This routine stores provided points in method_data of spacetime_listElem and return the indices of points or evaluated value in the growing array. If spacetime function is time-independent then pre-compute values and store in growing array of evalVal in tem_pointData_type.