tem_operation_var_module

This module provides a mechanism to define new variables in the simulation by applying some operator on existing variables.

Uses

Help
Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.

Used by

Help
Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.

Subroutines

tem_free_varSys_data_ptr tem_varSys_append_operVar tem_opVar_reduction_transient_init tem_opVar_reduction_transient_update tem_evalAdd_forElement tem_evalAdd_forPoint tem_evalAdd_fromIndex tem_evalMag_forElement tem_evalMag_forPoint tem_evalMag_fromIndex tem_divideVecByScal_forPoint tem_divideVecByScal_fromIndex tem_opVar_setParams tem_opVar_getParams tem_opVar_setupIndices tem_opVar_fill_inputIndex check_opVar_prerequisites evalDiff_forElement evalDiff_forPoint evalDiff_fromIndex evalRelDiff_forElement evalRelDiff_forPoint evalRelDiff_fromIndex evalMultiply_forElement evalMultiply_forPoint evalMultiply_fromIndex division_forElement division_forPoint division_fromIndex multiplyScalTimesVec_forElement tem_multiplyScalTimesVec_forPoint tem_multiplyScalTimesVec_fromIndex divideVecByScal_forElement extract_forElement extract_forPoint extract_fromIndex combine_forElement combine_forPoint combine_fromIndex reductionTransient_forElement reductionTransient_forPoint reductionTransient_fromIndex

Functions

public function tem_get_new_varSys_data_ptr(solver_bundle) result(resPtr)

Routine to get a pointer to a new instance of method_data for an operation variable

Arguments

Type	Intent	Optional	Attributes		Name
type(c_ptr),	intent(in),	optional		::	solver_bundle	Optional solver data to store in tem_varSys_op_data_type

Return Value type(c_ptr)

Pointer to the newly created instance.

Subroutines

public subroutine tem_free_varSys_data_ptr(vardat_ptr)

Free a method data structure again.

Arguments

Type	Intent	Optional	Attributes		Name
type(c_ptr),	intent(inout)			::	vardat_ptr	Data pointer to free

public subroutine tem_varSys_append_operVar(operVar, varSys, pos, 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)		::	operVar	variables defined in the lua file
type(tem_varSys_type),	intent(inout)		::	varSys	global variable system to which operVar to be appended
integer,	intent(out),	optional	::	pos	Position of the variable in the system.
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.

public subroutine tem_opVar_reduction_transient_init(varSys, tree, redTransVarMap, nDofs, time)

Initialize time reduction operation variable Loop over all variable in varSys and allocate redTrans%val for reduction_transient operation variable with nElems

Arguments

Type	Intent	Optional		Name
type(tem_varSys_type),	intent(in)		::	varSys	Global variable system
type(treelmesh_type),	intent(in)		::	tree	treelmesh_type
type(tem_varMap_type),	intent(out)		::	redTransVarMap	position of time reduction variable in varSys
integer,	intent(in),	optional	::	nDofs	Solver nDegrees of freedom
type(tem_time_type),	intent(in)		::	time	Current time

public subroutine tem_opVar_reduction_transient_update(redTransVarPos, varSys, tree, time)

Update all time reduction operation variables for entire domain

Arguments

Type	Intent		Name
integer,	intent(in)	::	redTransVarPos(:)	Position of time reduction variables in varSys
type(tem_varSys_type),	intent(in)	::	varSys	Global Variable system
type(treelmesh_type),	intent(in)	::	tree	treelmesh_type
type(tem_time_type),	intent(in)	::	time	Current time

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

Evaluate the function pointers of the dependent variables, and then calculate the addition or arbinary number of input variables with all input variables have same nComponents. ( scalar or vector ) In lua file, first define new variable with varType operation kind as "addition" and provide two dependent variable via input_varname. If input_varname variable is not part of predefined solver variables then add also that variable via variable table for example spacetime function 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 tem_evalAdd_forPoint(fun, varSys, point, time, tree, nPnts, res)

Same as tem_evalAdd_forElement except it evaluate addition from points

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 tem_evalAdd_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Same as tem_evalAdd_forPoint except it evaluate addition from points via index which are setup before hand

Arguments

Type	Intent	Optional		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.
type(tem_time_type),	intent(in)		::	time	Point in time at which to evaluate the variable.
integer,	intent(in)		::	iLevel	Level on which values are requested
integer,	intent(in)		::	idx(:)	Index of points in the growing array and variable val array to return. Size: nVals
integer,	intent(in),	optional	::	idxLen(:)	With idx as start index in contiguous memory, idxLength defines length of each contiguous memory Size: nVals
integer,	intent(in)		::	nVals	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 tem_evalMag_forElement(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Evaluate magnitude of any vectorial variable. In lua file, first define new variable with varType operation kind as "magnitude" and provide name of the variable from which magnitude to be derived in input_varname. If input_varname variable is not part of predefined solver variables then add also that variable via variable table.

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 tem_evalMag_forPoint(fun, varSys, point, time, tree, nPnts, res)

Same as evalMag_forElement except it evaluate magnitude from points

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 tem_evalMag_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Same as evalMag_forPoint except it evaluate magnitude from points via indices which need to be setup before

Arguments

Type	Intent	Optional		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.
type(tem_time_type),	intent(in)		::	time	Point in time at which to evaluate the variable.
integer,	intent(in)		::	iLevel	Level on which values are requested
integer,	intent(in)		::	idx(:)	Index of points in the growing array and variable val array to return. Size: nVals
integer,	intent(in),	optional	::	idxLen(:)	With idx as start index in contiguous memory, idxLength defines length of each contiguous memory Size: nVals
integer,	intent(in)		::	nVals	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 tem_divideVecByScal_forPoint(fun, varSys, point, time, tree, nPnts, res)

Same as divideVecByScal_forElement except it divides values from points

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 tem_divideVecByScal_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Same as divideVecByScal_fromElement except it divide values from points via indices which are setup before

Arguments

Type	Intent	Optional		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.
type(tem_time_type),	intent(in)		::	time	Point in time at which to evaluate the variable.
integer,	intent(in)		::	iLevel	Level on which values are requested
integer,	intent(in)		::	idx(:)	Index of points in the growing array and variable val array to return. Size: nVals
integer,	intent(in),	optional	::	idxLen(:)	With idx as start index in contiguous memory, idxLength defines length of each contiguous memory Size: nVals
integer,	intent(in)		::	nVals	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 tem_opVar_setParams(fun, varSys, instring)

This subroutine call set_params of input_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.
character(len=*),	intent(in)	::	instring	Input string with parameter to set in method_data

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

This subroutine call get_params of input_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.
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 tem_opVar_setupIndices(fun, varSys, point, offset_bit, iLevel, tree, nPnts, idx)

This subroutine call setup indices of input_variable

Arguments

Type	Intent	Optional		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(:,:)	List of space coordinate points to store as growing array in method_data
character,	intent(in),	optional	::	offset_bit(:)	Offset bit encoded as character for every point. Read more…
integer,	intent(in)		::	iLevel	Level to which input points belong to
type(treelmesh_type),	intent(in)		::	tree	global treelm mesh info
integer,	intent(in)		::	nPnts	Number of points to add in method_data of this variable
integer,	intent(out)		::	idx(:)	Index of points in the growing array and variable val array. Size: nPoints Read more…

public recursive subroutine tem_opVar_fill_inputIndex(fun, varSys, point, offset_bit, iLevel, tree, nPnts, inputIndex)

subroutine to fill index for the setuo Index routine called for operation variables, it is also used by the solver

Arguments

Type	Intent	Optional		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(:,:)	List of space coordinate points to store as growing array in method_data
character,	intent(in),	optional	::	offset_bit(:)	Offset bit encoded as character for every point. Read more…
integer,	intent(in)		::	iLevel	Level to which input points belong to
type(treelmesh_type),	intent(in)		::	tree	global treelm mesh info
integer,	intent(in)		::	nPnts	Number of points to add in method_data of this variable
type(grw_intarray_type),	intent(out)		::	inputIndex(:)	input index for dependent variables size: fun%nInputs

private subroutine check_opVar_prerequisites(operType, nInputs, input_varname, varSys, nComps, isSatisfied)

This subroutine checks whether input variables satisfy requirements for opertype.

Arguments

Type	Intent		Name
character(len=*),	intent(in)	::	operType	Operation type
integer,	intent(in)	::	nInputs	Number of inputs
character(len=*),	intent(in)	::	input_varname(nInputs)	Input varnames for current operation
type(tem_varSys_type),	intent(in)	::	varSys	Variable system to look for input_varname
integer,	intent(inout)	::	nComps	Number of components defined for operation variable. If nComps == -1 then current nComps is set here
logical,	intent(out)	::	isSatisfied	true if all requirements for opertype are satisfied

private recursive subroutine evalDiff_forElement(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Evaluate the function pointers of the dependent variables, and then calculate the difference between these two. ( scalar or vector ) In lua file, first define new variable with varType operation kind as "difference" and provide two dependent variable via input_varname. If input_varname variable is not part of predefined solver variables then add also that variable via variable table for example spacetime function variable. For example: Define a variable called difference, which depend on density and spacetime. one can get an error between simulation results and analytical solution.

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…

private recursive subroutine evalDiff_forPoint(fun, varSys, point, time, tree, nPnts, res)

Same as evalDiff_forElement except it evaluate diff from points

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…

private recursive subroutine evalDiff_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Same as evalDiff_forPoint except it evaluate diff from points via index which are setup before hand

Arguments

Type	Intent	Optional		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.
type(tem_time_type),	intent(in)		::	time	Point in time at which to evaluate the variable.
integer,	intent(in)		::	iLevel	Level on which values are requested
integer,	intent(in)		::	idx(:)	Index of points in the growing array and variable val array to return. Size: nVals
integer,	intent(in),	optional	::	idxLen(:)	With idx as start index in contiguous memory, idxLength defines length of each contiguous memory Size: nVals
integer,	intent(in)		::	nVals	Number of values to obtain for this variable (vectorized access).
real(kind=rk),	intent(out)		::	res(:)	Resulting values for the requested variable. Read more…

private recursive subroutine evalRelDiff_forElement(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Same as evalDiff but output of 2nd dependent variable is used to compute relative difference.

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…

private recursive subroutine evalRelDiff_forPoint(fun, varSys, point, time, tree, nPnts, res)

Same as evalRelDiff_forElement except it evaluate relatice diff from points

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…

private recursive subroutine evalRelDiff_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Same as evalRelDiff_forElement except it evaluate relative diff from points via index which are setup before

Arguments

Type	Intent	Optional		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.
type(tem_time_type),	intent(in)		::	time	Point in time at which to evaluate the variable.
integer,	intent(in)		::	iLevel	Level on which values are requested
integer,	intent(in)		::	idx(:)	Index of points in the growing array and variable val array to return. Size: nVals
integer,	intent(in),	optional	::	idxLen(:)	With idx as start index in contiguous memory, idxLength defines length of each contiguous memory Size: nVals
integer,	intent(in)		::	nVals	Number of values to obtain for this variable (vectorized access).
real(kind=rk),	intent(out)		::	res(:)	Resulting values for the requested variable. Read more…

private recursive subroutine evalMultiply_forElement(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Routine to multiply variables if all variables have same number of components.

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…

private recursive subroutine evalMultiply_forPoint(fun, varSys, point, time, tree, nPnts, res)

Same as evalMultiply_forElement except it evaluate it multiply values from points

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…

private recursive subroutine evalMultiply_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Same as evalMultiply_forPoint except it multiply values from points via indices which are setup before

Arguments

Type	Intent	Optional		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.
type(tem_time_type),	intent(in)		::	time	Point in time at which to evaluate the variable.
integer,	intent(in)		::	iLevel	Level on which values are requested
integer,	intent(in)		::	idx(:)	Index of points in the growing array and variable val array to return. Size: nVals
integer,	intent(in),	optional	::	idxLen(:)	With idx as start index in contiguous memory, idxLength defines length of each contiguous memory Size: nVals
integer,	intent(in)		::	nVals	Number of values to obtain for this variable (vectorized access).
real(kind=rk),	intent(out)		::	res(:)	Resulting values for the requested variable. Read more…

private recursive subroutine division_forElement(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Routine to divide variables if all variables have same number of components.

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…

private recursive subroutine division_forPoint(fun, varSys, point, time, tree, nPnts, res)

Same as division_forElement except it evaluate it division values from points

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…

private recursive subroutine division_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Same as division_forElement except it division values from points via indices which are setup before

Arguments

Type	Intent	Optional		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.
type(tem_time_type),	intent(in)		::	time	Point in time at which to evaluate the variable.
integer,	intent(in)		::	iLevel	Level on which values are requested
integer,	intent(in)		::	idx(:)	Index of points in the growing array and variable val array to return. Size: nVals
integer,	intent(in),	optional	::	idxLen(:)	With idx as start index in contiguous memory, idxLength defines length of each contiguous memory Size: nVals
integer,	intent(in)		::	nVals	Number of values to obtain for this variable (vectorized access).
real(kind=rk),	intent(out)		::	res(:)	Resulting values for the requested variable. Read more…

private recursive subroutine multiplyScalTimesVec_forElement(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Routine to multiply scalat times vector

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…

private recursive subroutine tem_multiplyScalTimesVec_forPoint(fun, varSys, point, time, tree, nPnts, res)

Same as multiplyScalTimesVec_forElement except it multiply values for given corrdinate points

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…

private recursive subroutine tem_multiplyScalTimesVec_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Same as multiplyScalTimesVec_fromElement except it multiply values from points via indices which are setup before

Arguments

Type	Intent	Optional		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.
type(tem_time_type),	intent(in)		::	time	Point in time at which to evaluate the variable.
integer,	intent(in)		::	iLevel	Level on which values are requested
integer,	intent(in)		::	idx(:)	Index of points in the growing array and variable val array to return. Size: nVals
integer,	intent(in),	optional	::	idxLen(:)	With idx as start index in contiguous memory, idxLength defines length of each contiguous memory Size: nVals
integer,	intent(in)		::	nVals	Number of values to obtain for this variable (vectorized access).
real(kind=rk),	intent(out)		::	res(:)	Resulting values for the requested variable. Read more…

private recursive subroutine divideVecByScal_forElement(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Routine to divide vector by scalar

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…

private recursive subroutine extract_forElement(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Extract component index of any vectorial variable. In lua file, first define new variable with varType operation kind as "extract" and provide name of the variable from which to extract component index via input_varname (it must be single variable) and index to extract via input_varIndex. If input_varname variable is not part of predefined solver variables then add also that variable via variable table.

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…

private recursive subroutine extract_forPoint(fun, varSys, point, time, tree, nPnts, res)

Same as extract_forElement except it extract from points

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…

private recursive subroutine extract_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Same as extract_from Point except it extract from points via indices which are setup before

Arguments

Type	Intent	Optional		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.
type(tem_time_type),	intent(in)		::	time	Point in time at which to evaluate the variable.
integer,	intent(in)		::	iLevel	Level on which values are requested
integer,	intent(in)		::	idx(:)	Index of points in the growing array and variable val array to return. Size: nVals
integer,	intent(in),	optional	::	idxLen(:)	With idx as start index in contiguous memory, idxLength defines length of each contiguous memory Size: nVals
integer,	intent(in)		::	nVals	Number of values to obtain for this variable (vectorized access).
real(kind=rk),	intent(out)		::	res(:)	Resulting values for the requested variable. Read more…

private recursive subroutine combine_forElement(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Combine multiple variables into single variable with nComponent of output variable as sum of all input variables nComponents. In lua file, first define new variable with varType operation kind as "combine" and provide name of the variable from which to extract component index via input_varname (it must be single variable) and index to combine via input_varIndex. If input_varname variable is not part of predefined solver variables then add also that variable via variable table.

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…

private recursive subroutine combine_forPoint(fun, varSys, point, time, tree, nPnts, res)

same as combine_fromelement except it extract from points

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…

private recursive subroutine combine_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Same as combine_from Point except it combine from points via indices which are setup before

Arguments

Type	Intent	Optional		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.
type(tem_time_type),	intent(in)		::	time	Point in time at which to evaluate the variable.
integer,	intent(in)		::	iLevel	Level on which values are requested
integer,	intent(in)		::	idx(:)	Index of points in the growing array and variable val array to return. Size: nVals
integer,	intent(in),	optional	::	idxLen(:)	With idx as start index in contiguous memory, idxLength defines length of each contiguous memory Size: nVals
integer,	intent(in)		::	nVals	Number of values to obtain for this variable (vectorized access).
real(kind=rk),	intent(out)		::	res(:)	Resulting values for the requested variable. Read more…

private recursive subroutine reductionTransient_forElement(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Routine to return time reduction variables

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…

private recursive subroutine reductionTransient_forPoint(fun, varSys, point, time, tree, nPnts, res)

Same as reductionTransient_forElement except it evaluate it multiply values from points

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…

private recursive subroutine reductionTransient_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Same as reductionTransient_forPoint except it multiply values from points via indices which are setup before

Arguments

Type	Intent	Optional		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.
type(tem_time_type),	intent(in)		::	time	Point in time at which to evaluate the variable.
integer,	intent(in)		::	iLevel	Level on which values are requested
integer,	intent(in)		::	idx(:)	Index of points in the growing array and variable val array to return. Size: nVals
integer,	intent(in),	optional	::	idxLen(:)	With idx as start index in contiguous memory, idxLength defines length of each contiguous memory Size: nVals
integer,	intent(in)		::	nVals	Number of values to obtain for this variable (vectorized access).
real(kind=rk),	intent(out)		::	res(:)	Resulting values for the requested variable. Read more…

tem_operation_var_module Module

Contents

Functions

Subroutines

Uses

Used by

Contents

Functions

Subroutines

Functions

public function tem_get_new_varSys_data_ptr(solver_bundle) result(resPtr)

Arguments

Return Value type(c_ptr)

Subroutines

public subroutine tem_free_varSys_data_ptr(vardat_ptr)

Arguments

public subroutine tem_varSys_append_operVar(operVar, varSys, pos, solverData_evalElem)

Arguments

public subroutine tem_opVar_reduction_transient_init(varSys, tree, redTransVarMap, nDofs, time)

Arguments

public subroutine tem_opVar_reduction_transient_update(redTransVarPos, varSys, tree, time)

Arguments

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

Arguments

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

Arguments

public recursive subroutine tem_evalAdd_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Arguments

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

Arguments

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

Arguments

public recursive subroutine tem_evalMag_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Arguments

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

Arguments

public recursive subroutine tem_divideVecByScal_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Arguments

public recursive subroutine tem_opVar_setParams(fun, varSys, instring)

Arguments

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

Arguments

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

Arguments

public recursive subroutine tem_opVar_fill_inputIndex(fun, varSys, point, offset_bit, iLevel, tree, nPnts, inputIndex)

Arguments

private subroutine check_opVar_prerequisites(operType, nInputs, input_varname, varSys, nComps, isSatisfied)

Arguments

private recursive subroutine evalDiff_forElement(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Arguments

private recursive subroutine evalDiff_forPoint(fun, varSys, point, time, tree, nPnts, res)

Arguments

private recursive subroutine evalDiff_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Arguments

private recursive subroutine evalRelDiff_forElement(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Arguments

private recursive subroutine evalRelDiff_forPoint(fun, varSys, point, time, tree, nPnts, res)

Arguments

private recursive subroutine evalRelDiff_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Arguments

private recursive subroutine evalMultiply_forElement(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Arguments

private recursive subroutine evalMultiply_forPoint(fun, varSys, point, time, tree, nPnts, res)

Arguments

private recursive subroutine evalMultiply_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Arguments

private recursive subroutine division_forElement(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Arguments

private recursive subroutine division_forPoint(fun, varSys, point, time, tree, nPnts, res)

Arguments

private recursive subroutine division_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Arguments

private recursive subroutine multiplyScalTimesVec_forElement(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Arguments

private recursive subroutine tem_multiplyScalTimesVec_forPoint(fun, varSys, point, time, tree, nPnts, res)

Arguments

private recursive subroutine tem_multiplyScalTimesVec_fromIndex(fun, varSys, time, iLevel, idx, idxLen, nVals, res)

Arguments

private recursive subroutine divideVecByScal_forElement(fun, varSys, elempos, time, tree, nElems, nDofs, res)

Arguments