mus_variable_module

This module provides all possible 'pure variables' (= no prefixes) for a given kind of simulation.

IMPORTANT NOTE: When you create a new variable, do not forget to add this variable name into mus_append_auxField, mus_store_derVarPos and also in mus_store_bcVarPos routine.

Uses

env_module	w	mus_variable_module
	w
iso_c_binding	w
	w
mus_auxFieldVar_module	w
	w
mus_bc_var_module	w
	w
mus_derQuan_module	w
	w
mus_derQuanIncomp_module	w
	w
mus_derQuanIsothermAcEq_module	w
	w
mus_derQuanMSGas_module	w
	w
mus_derQuanMSLiquid_module	w
	w
mus_derQuanNernstPlanck_module	w
	w
mus_derQuanPhysics_module	w
	w
mus_derQuanPoisson_module	w
	w
mus_derQuanPS_module	w
	w
mus_derVarPos_module	w
	w
mus_field_module	w
	w
mus_material_var_module	w
	w
mus_operation_var_module	w
	w
mus_scheme_header_module	w
	w
mus_scheme_layout_module	w
	w
mus_source_type_module	w
	w
mus_source_var_module	w
	w
mus_source_var_turbChanForce_module	w
	w
mus_stateVar_module	w
	w
mus_turbulence_var_module	w
	w
mus_varSys_module	w
	w
tem_aux_module	w
	w
tem_debug_module	w
	w
tem_derived_module	w
	w
tem_dyn_array_module	w
	w
tem_grow_array_module	w
	w
tem_logging_module	w
	w
tem_meshInfo_module	w
	w
tem_spacetime_fun_module	w
	w
tem_stencil_module	w
	w
tem_variable_module	w
	w
tem_varMap_module	w
	w
tem_varSys_module	w
	w

Help

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

public subroutine mus_build_varSys(varSys, solverData, schemeHeader, stencil, nFields, derVarPos, luaVar, field, globSrc, poss_srcVar, st_funList)

Build global variable system for Musubi

Arguments

Type	Intent	Attributes		Name
type(tem_varSys_type),	intent(inout)		::	varSys	global variable system
type(mus_varSys_solverData_type),	intent(in),	target	::	solverData	Contains pointer to solver data types
type(mus_scheme_header_type),	intent(in)		::	schemeHeader	identifier of the scheme
type(tem_stencilHeader_type),	intent(in)		::	stencil	Compute stencil header
integer,	intent(in)		::	nFields	number of fields
type(mus_derVarPos_type),	intent(out),	allocatable	::	derVarPos(:)	store position of each variable for each field and mixture size: nFields+1
type(tem_variable_type),	intent(in),	allocatable	::	luaVar(:)	additional variable defined in the lua file. Function pointer for this variables depends on its varType.
type(mus_field_type),	intent(inout)		::	field(:)	Field contains sources and boundary infos
type(mus_source_type),	intent(inout)		::	globSrc	global source
type(tem_possible_variable_type),	intent(in)		::	poss_srcVar	possible source variables
type(tem_st_fun_linkedList_type),	intent(out)		::	st_funList	contains spacetime functions of all variables

public subroutine mus_append_readVarAsStateVar(varSys, readVarIsPdf, read_varSys, stateVarMap, solverData, nFields, fldLabel)

Append variable read from restart file as state variables

Arguments

Type	Intent	Attributes		Name
type(tem_varSys_type),	intent(inout)		::	varSys	global variable system
logical,	intent(out)		::	readVarIsPdf	Is true if read_varSys has pdf variable
type(tem_varSys_type),	intent(in)		::	read_varSys	Variable system loaded from restart header file
type(tem_varMap_type),	intent(out)		::	stateVarMap	Store position of state variable in global varSys
type(mus_varSys_solverData_type),	intent(in),	target	::	solverData	Contains pointer to solver data types
integer,	intent(in)		::	nFields	number of fields
character(len=*),	intent(in)		::	fldLabel(:)	array of field label prefix. Size=nFields

public subroutine mus_append_stateVar(varSys, stateVarMap, solverData, schemeHeader, stencil, nFields, fldLabel)

Append state variable depends on the scheme kind

Arguments

Type	Intent	Attributes		Name
type(tem_varSys_type),	intent(inout)		::	varSys	global variable system
type(tem_varMap_type),	intent(out)		::	stateVarMap	Store position of state variable in global varSys
type(mus_varSys_solverData_type),	intent(in),	target	::	solverData	Contains pointer to solver data types
type(mus_scheme_header_type),	intent(in)		::	schemeHeader	identifier of the scheme
type(tem_stencilHeader_type),	intent(in)		::	stencil	compute stencil defintion
integer,	intent(in)		::	nFields	number of fields
character(len=*),	intent(in)		::	fldLabel(:)	array of field label prefix. Size=nFields

public subroutine mus_append_auxField(varSys, solverData, schemeHeader, nFields, fldLabel, derVarName)

Append auxiliary variables which are computed from state and stored in auxField array using calcAuxField function

Arguments

Type	Intent	Attributes		Name
type(tem_varSys_type),	intent(inout)		::	varSys	global variable system
type(mus_varSys_solverData_type),	intent(in),	target	::	solverData	Contains pointer to solver data types
type(mus_scheme_header_type),	intent(in)		::	schemeHeader	identifier of the scheme
integer,	intent(in)		::	nFields	number of fields
character(len=*),	intent(in)		::	fldLabel(:)	array of field label prefix. Size=nFields
type(grw_labelarray_type),	intent(inout)		::	derVarName	array of derive physical variables

public subroutine mus_store_derVarPos(derVarPos, derVarName, varSys, nFields, fldLabel)

Store the position of each variable in the global system in the derVarPos This function is also called in Harvester.

Arguments

Type	Intent		Name
type(mus_derVarPos_type),	intent(inout)	::	derVarPos(:)	Position of derived variables
type(grw_labelarray_type),	intent(in)	::	derVarName	array of derive physical variables
type(tem_varSys_type),	intent(in)	::	varSys	global variable system
integer,	intent(in)	::	nFields	number of fields
character(len=*),	intent(in)	::	fldLabel(:)	array of field label prefix. Size=nFields

private subroutine mus_append_sourceVar(me, solverData, schemeHeader, varSys, nFields, stencil, poss_srcVar, fldLabel)

Build a variable system of all possible source terms for the given schemeKind

Arguments

Type	Intent	Optional	Attributes		Name
type(mus_source_type),	intent(inout)			::	me	Contains source function pointer, source variable definition from lua and mapping of source variable in global varSys
type(mus_varSys_solverData_type),	intent(in),		target	::	solverData	Contains pointer to solver data types
type(mus_scheme_header_type),	intent(in)			::	schemeHeader	Identifier of the scheme
type(tem_varSys_type),	intent(inout)			::	varSys	Global variable system
integer,	intent(in)			::	nFields	number of fields
type(tem_stencilHeader_type),	intent(in)			::	stencil	compute stencil defintion
type(tem_possible_variable_type),	intent(in)			::	poss_srcVar	possible source variables
character(len=*),	intent(in),	optional		::	fldLabel	array of field label prefix required only for field source. If not present, it is assumed as global source

private subroutine mus_store_bcVarPos(field, nFields, varSys)

Store the position of each boundary variable in the global varSys in the field%bc%varPos%. This routine also checks if boundary variable defined in config file has same number of components as expected.

Arguments

Type	Intent		Name
type(mus_field_type),	intent(inout)	::	field(:)	Field containing boundary infos
integer,	intent(in)	::	nFields	number of fields
type(tem_varSys_type),	intent(in)	::	varSys	global variable system

private subroutine check_varSys_forPdfVar(readVarIsPdf, varSys, nFields, fldLabel)

This function runs over all variable loaded from restart file check if variables loaded are pdf variable or derive variable

Arguments

Type	Intent		Name
logical,	intent(out)	::	readVarIsPdf	return true if variable read from restart file has pdf
type(tem_varSys_type),	intent(in)	::	varSys	variable system loaded from restart file
integer,	intent(in)	::	nFields	number of fields
character(len=*),	intent(in)	::	fldLabel(:)	array of field label prefix. Size=nFields

mus_variable_module Module

Contents

Subroutines

Uses

Used by

Subroutines

public subroutine mus_build_varSys(varSys, solverData, schemeHeader, stencil, nFields, derVarPos, luaVar, field, globSrc, poss_srcVar, st_funList)

Arguments

public subroutine mus_append_readVarAsStateVar(varSys, readVarIsPdf, read_varSys, stateVarMap, solverData, nFields, fldLabel)

Arguments

public subroutine mus_append_stateVar(varSys, stateVarMap, solverData, schemeHeader, stencil, nFields, fldLabel)

Arguments

public subroutine mus_append_auxField(varSys, solverData, schemeHeader, nFields, fldLabel, derVarName)

Arguments

public subroutine mus_store_derVarPos(derVarPos, derVarName, varSys, nFields, fldLabel)

Arguments

private subroutine mus_append_sourceVar(me, solverData, schemeHeader, varSys, nFields, stencil, poss_srcVar, fldLabel)

Arguments

private subroutine mus_store_bcVarPos(field, nFields, varSys)

Arguments

private subroutine check_varSys_forPdfVar(readVarIsPdf, varSys, nFields, fldLabel)

Arguments