mus_flow_module

Flow-related routines such as initialization of the flow field and parameters

************ !

Uses

env_module	w	mus_flow_module
	w
mus_auxField_module	w
	w
mus_derivedQuantities_module2	w
	w
mus_derVarPos_module	w
	w
mus_eNRTL_module	w
	w
mus_field_module	w
	w
mus_fluid_module	w
	w
mus_initFluid_module	w
	w
mus_initFluidIncomp_module	w
	w
mus_initIsothermAcEq_module	w
	w
mus_initLBMPS_module	w
	w
mus_initMultispecies_module	w
	w
mus_initNernstPlanck_module	w
	w
mus_initPoisson_module	w
	w
mus_interpolate_verify_module	w
	w
mus_mixture_module	w
	w
mus_nernstPlanck_module	w
	w
mus_param_module	w
	w
mus_physics_module	w
	w
mus_restart_module	w
	w
mus_scheme_type_module	w
	w
tem_aux_module	w
	w
tem_debug_module	w
	w
tem_general_module	w
	w
tem_geometry_module	w
	w
tem_global_module	w
	w
tem_ini_condition_module	w
	w
tem_logging_module	w
	w
tem_math_module	w
	w
tem_param_module	w
	w
tem_spatial_module	w
	w
tem_stencil_module	w
	w
tem_subTree_type_module	w
	w
tem_tools_module	w
	w
tem_varMap_module	w
	w
tem_varSys_module	w
	w
treelmesh_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

mus_init_flow fillHelperElementsFineToCoarse fillHelperElementsCoarseToFine mus_initAuxField init_advRel mus_init_byIC mus_init_pdf mus_init_passiveScalar mus_init_poisson mus_init_nernst_planck mus_init_MSLiquid mus_init_MSGas mus_init_isotherm_acEq

Subroutines

public subroutine mus_init_flow(scheme, tree, general, physics, scaling, levelPointer)

Initialize flow field depends on read restart or initial condition

Arguments

Type	Intent		Name
type(mus_scheme_type),	intent(inout)	::	scheme	Scheme type
type(treelmesh_type),	intent(in)	::	tree	tree
type(tem_general_type),	intent(inout)	::	general
type(mus_physics_type),	intent(in)	::	physics
character(len=*),	intent(in)	::	scaling
integer,	intent(in)	::	levelPointer(:)	global info type

public recursive subroutine fillHelperElementsFineToCoarse(scheme, general, physics, iLevel, maxLevel)

Recursively fill all the helper elements (i.e. ghost, halo) with valid information from the fluid elements.

Arguments

Type	Intent		Name
type(mus_scheme_type),	intent(inout)	::	scheme	containers for the scheme contains interpolation type
type(tem_general_type),	intent(in)	::	general	global parameters
type(mus_physics_type),	intent(in)	::	physics
integer,	intent(in)	::	iLevel	Level counter variable
integer,	intent(in)	::	maxLevel	global flow quantity properties

public recursive subroutine fillHelperElementsCoarseToFine(scheme, general, physics, iLevel, minLevel, maxLevel)

Recursively fill all the helper elements (i.e. ghost, halo) with valid information from the fluid elements.

Arguments

Type	Intent		Name
type(mus_scheme_type),	intent(inout)	::	scheme	containers for the scheme contains interpolation type
type(tem_general_type),	intent(in)	::	general	global parameters
type(mus_physics_type),	intent(in)	::	physics
integer,	intent(in)	::	iLevel	Level counter variable
integer,	intent(in)	::	minLevel	level range
integer,	intent(in)	::	maxLevel	level range

public subroutine mus_initAuxField(scheme, general, minLevel, maxLevel)

This routine initialize auxField variable from PDF values initialized by initial condition. AuxField is computed from state using SAVE access for fluid elements and interpolated for ghost elements

Arguments

Type	Intent		Name
type(mus_scheme_type),	intent(inout)	::	scheme	containers for the scheme contains interpolation type
type(tem_general_type),	intent(in)	::	general	contains commPattern, MPI communicator and simControl
integer,	intent(in)	::	minLevel	level range
integer,	intent(in)	::	maxLevel	level range

private subroutine init_advRel(scheme)

Choose the relaxation model

Arguments

Type	Intent	Optional	Attributes		Name
type(mus_scheme_type)				::	scheme	scheme type

private subroutine mus_init_byIC(scheme, tree, fac, scaling)

Initialize flow field by calling corresponding routine according to scheme kind.

Arguments

Type	Intent		Name
type(mus_scheme_type),	intent(inout)	::	scheme	Scheme type
type(treelmesh_type),	intent(in)	::	tree	tree
type(mus_convertFac_type),	intent(in)	::	fac(tree%global%minLevel:tree%global%maxLevel)	Global parameters
character(len=*),	intent(in)	::	scaling

private subroutine mus_init_pdf(me, tree, fac, scaling, field, iField, state, neigh, nElems, nSize, iLevel)

Initialize the flow from pressure, velocity and strain rate.\n First equilibirium pdf (fEq) is calculated from pressure and velocity. Then non-equilibirium (fnEq) is calculated from strain rate. At last set the pdf of each element by sum up these two parts (fEq+fnEq).

Arguments

Type	Intent		Name
type(mus_scheme_type),	intent(in)	::	me	Scheme type
type(treelmesh_type),	intent(in)	::	tree	tree type
type(mus_convertFac_type),	intent(in)	::	fac	Global parameters
character(len=*),	intent(in)	::	scaling	scaling
type(mus_field_type),	intent(inout)	::	field	Field type
integer,	intent(in)	::	iField	Field index
real(kind=rk),	intent(inout)	::	state(:)	PDF
integer,	intent(in)	::	neigh(:)	Connectivity array
integer,	intent(in)	::	nElems	Number of local elements
integer,	intent(in)	::	nSize	number of elements as size
integer,	intent(in)	::	iLevel	Level index

private subroutine mus_init_passiveScalar(me, tree, fac, scaling, field, iField, state, neigh, nElems, nSize, iLevel)

Initialize passive scalar from pressure and velocity.\n Equilibirium pdf (fEq) is calculated from pressure and velocity.

Arguments

Type	Intent		Name
type(mus_scheme_type),	intent(in)	::	me	Scheme type
type(treelmesh_type),	intent(in)	::	tree	tree type
type(mus_convertFac_type),	intent(in)	::	fac	Global parameters
character(len=*),	intent(in)	::	scaling	scaling
type(mus_field_type),	intent(inout)	::	field	Field type
integer,	intent(in)	::	iField	Field index
real(kind=rk),	intent(inout)	::	state(:)	PDF
integer,	intent(in)	::	neigh(:)	Connectivity array
integer,	intent(in)	::	nElems	Number of local elements
integer,	intent(in)	::	nSize	number of elements as size
integer,	intent(in)	::	iLevel	Level index

private subroutine mus_init_poisson(me, tree, fac, scaling, field, state, neigh, nElems, nSize, iLevel)

Initialize poisson lbm from potential Equilibirium pdf (fEq) is calculated from potential.

Arguments

Type	Intent		Name
type(mus_scheme_type),	intent(in)	::	me	Scheme type
type(treelmesh_type),	intent(in)	::	tree	tree type
type(mus_convertFac_type),	intent(in)	::	fac	Global parameters
character(len=*),	intent(in)	::	scaling	scaling
type(mus_field_type),	intent(inout)	::	field	Field type
real(kind=rk),	intent(inout)	::	state(:)	PDF
integer,	intent(in)	::	neigh(:)	Connectivity array
integer,	intent(in)	::	nElems	Number of local elements
integer,	intent(in)	::	nSize	number of elements as size
integer,	intent(in)	::	iLevel	Level index

private subroutine mus_init_nernst_planck(me, tree, fac, field, iField, state, neigh, nElems, nSize, iLevel, nernstPlanck)

Initialize nernst planck from and .\n Equilibirium pdf (fEq) is calculated from and .

Arguments

Type	Intent		Name
type(mus_scheme_type),	intent(in)	::	me	Scheme type
type(treelmesh_type),	intent(in)	::	tree	tree type
type(mus_convertFac_type),	intent(in)	::	fac	Global parameters
type(mus_field_type),	intent(inout)	::	field	Field type
integer,	intent(in)	::	iField	Field index
real(kind=rk),	intent(inout)	::	state(:)	PDF
integer,	intent(in)	::	neigh(:)	Connectivity array
integer,	intent(in)	::	nElems	Number of local elements
integer,	intent(in)	::	nSize	number of elements as size
integer,	intent(in)	::	iLevel	Level index
type(mus_nernstPlanck_type),	intent(in)	::	nernstPlanck	Contins solvent information

private subroutine mus_init_MSLiquid(me, tree, fac, state, neigh, field, mixture, nElems, nSize, iLevel)

Initialize the flow from calculated quantitites like density, velocity etc. for multispecies lbm

Arguments

Type	Intent		Name
type(mus_scheme_type),	intent(inout)	::	me
type(treelmesh_type),	intent(in)	::	tree
type(mus_convertFac_type),	intent(in)	::	fac
real(kind=rk),	intent(inout)	::	state(:)	PDF
integer,	intent(in)	::	neigh(:)	Connectivity array
type(mus_field_type),	intent(inout)	::	field(:)
type(mus_mixture_type),	intent(inout)	::	mixture
integer,	intent(in)	::	nElems
integer,	intent(in)	::	nSize
integer,	intent(in)	::	iLevel

private subroutine mus_init_MSGas(me, tree, fac, state, neigh, field, nElems, nSize, iLevel)

Initialize the flow from calculated quantitites like density, velocity etc. for multispecies lbm

Arguments

Type	Intent		Name
type(mus_scheme_type),	intent(inout)	::	me
type(treelmesh_type),	intent(in)	::	tree
type(mus_convertFac_type),	intent(in)	::	fac
real(kind=rk),	intent(inout)	::	state(:)	PDF
integer,	intent(in)	::	neigh(:)	Connectivity array
type(mus_field_type),	intent(inout)	::	field(:)
integer,	intent(in)	::	nElems
integer,	intent(in)	::	nSize
integer,	intent(in)	::	iLevel

private subroutine mus_init_isotherm_acEq(me, tree, fac, field, iField, state, neigh, nElems, nSize, iLevel)

Initialize the isothermal acEq flow from density and velocity\n equilibrium pdf (fEq) is calculated from density and velocity

Arguments

Type	Intent		Name
type(mus_scheme_type),	intent(inout)	::	me	Scheme type
type(treelmesh_type),	intent(in)	::	tree	tree type
type(mus_convertFac_type),	intent(in)	::	fac	Global parameters
type(mus_field_type),	intent(inout)	::	field	Field type
integer,	intent(in)	::	iField	Field index
real(kind=rk),	intent(inout)	::	state(:)	PDF
integer,	intent(in)	::	neigh(:)	Connectivity array
integer,	intent(in)	::	nElems	Number of local elements
integer,	intent(in)	::	nSize	number of elements as size
integer,	intent(in)	::	iLevel	Level index

mus_flow_module Module

Contents

Subroutines

Uses

Used by

Contents

Subroutines

Subroutines

public subroutine mus_init_flow(scheme, tree, general, physics, scaling, levelPointer)

Arguments

public recursive subroutine fillHelperElementsFineToCoarse(scheme, general, physics, iLevel, maxLevel)

Arguments

public recursive subroutine fillHelperElementsCoarseToFine(scheme, general, physics, iLevel, minLevel, maxLevel)

Arguments

public subroutine mus_initAuxField(scheme, general, minLevel, maxLevel)

Arguments

private subroutine init_advRel(scheme)

Arguments

private subroutine mus_init_byIC(scheme, tree, fac, scaling)

Arguments

private subroutine mus_init_pdf(me, tree, fac, scaling, field, iField, state, neigh, nElems, nSize, iLevel)

Arguments

private subroutine mus_init_passiveScalar(me, tree, fac, scaling, field, iField, state, neigh, nElems, nSize, iLevel)

Arguments

private subroutine mus_init_poisson(me, tree, fac, scaling, field, state, neigh, nElems, nSize, iLevel)

Arguments

private subroutine mus_init_nernst_planck(me, tree, fac, field, iField, state, neigh, nElems, nSize, iLevel, nernstPlanck)

Arguments

private subroutine mus_init_MSLiquid(me, tree, fac, state, neigh, field, mixture, nElems, nSize, iLevel)

Arguments

private subroutine mus_init_MSGas(me, tree, fac, state, neigh, field, nElems, nSize, iLevel)

Arguments

private subroutine mus_init_isotherm_acEq(me, tree, fac, field, iField, state, neigh, nElems, nSize, iLevel)

Arguments