mus_MSLiquid_module

This module provides the definition and methods for MSLiquid bgk advection relaxation scheme.

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.

Variables

Type	Visibility	Attributes		Name		Initial
integer,	private,	parameter	::	QQ	=	19	Definition of the discrete velocity set
integer,	private,	parameter	::	QQN	=	18
integer,	private,	parameter	::	q__W	=	1
integer,	private,	parameter	::	q__S	=	2
integer,	private,	parameter	::	q__B	=	3
integer,	private,	parameter	::	q__E	=	4
integer,	private,	parameter	::	q__N	=	5
integer,	private,	parameter	::	q__T	=	6
integer,	private,	parameter	::	q_BS	=	7
integer,	private,	parameter	::	q_TS	=	8
integer,	private,	parameter	::	q_BN	=	9
integer,	private,	parameter	::	q_TN	=	10
integer,	private,	parameter	::	q_BW	=	11
integer,	private,	parameter	::	q_BE	=	12
integer,	private,	parameter	::	q_TW	=	13
integer,	private,	parameter	::	q_TE	=	14
integer,	private,	parameter	::	q_SW	=	15
integer,	private,	parameter	::	q_NW	=	16
integer,	private,	parameter	::	q_SE	=	17
integer,	private,	parameter	::	q_NE	=	18
integer,	private,	parameter	::	q__0	=	19
integer,	private,	parameter	::	QQF3	=	57

Subroutines

public subroutine bgk_advRel_d3q19f3_MSLiquid(fieldProp, inState, outState, auxField, neigh, nElems, nSolve, level, layout, params, varSys, derVarPos)

Optimized Advection relaxation routine for the MSLiquid BGK model for d3q19 layout with three species.

Arguments

Type	Intent		Name
type(mus_field_prop_type),	intent(in)	::	fieldProp(:)	Array of field properties (fluid or species)
real(kind=rk),	intent(in)	::	inState(nElems*varSys%nScalars)	input pdf vector
real(kind=rk),	intent(out)	::	outState(nElems*varSys%nScalars)	output pdf vector
real(kind=rk),	intent(inout)	::	auxField(nElems*varSys%nAuxScalars)	Auxiliary field computed from pre-collision state Is updated with correct velocity field for multicomponent models
integer,	intent(in)	::	neigh(nElems*layout%fStencil%QQ)	connectivity vector
integer,	intent(in)	::	nElems	number of elements in state Array
integer,	intent(in)	::	nSolve	number of elements solved in kernel
integer,	intent(in)	::	level	current level
type(mus_scheme_layout_type),	intent(in)	::	layout	current layout
type(mus_param_type),	intent(in)	::	params	global parameters
type(tem_varSys_type),	intent(in)	::	varSys	variable system definition
type(mus_derVarPos_type),	intent(in)	::	derVarPos(:)	position of derived quantities in varsys for all fields

public subroutine bgk_advRel_MSLiquid_generic(fieldProp, inState, outState, auxField, neigh, nElems, nSolve, level, layout, params, varSys, derVarPos)

Unoptimized Advection relaxation routine for the multispecies BGK model

Arguments

Type	Intent		Name
type(mus_field_prop_type),	intent(in)	::	fieldProp(:)	Array of field properties (fluid or species)
real(kind=rk),	intent(in)	::	inState(nElems*varSys%nScalars)	input pdf vector
real(kind=rk),	intent(out)	::	outState(nElems*varSys%nScalars)	output pdf vector
real(kind=rk),	intent(inout)	::	auxField(nElems*varSys%nAuxScalars)	Auxiliary field computed from pre-collision state Is updated with correct velocity field for multicomponent models
integer,	intent(in)	::	neigh(nElems*layout%fStencil%QQ)	connectivity vector
integer,	intent(in)	::	nElems	number of elements in state Array
integer,	intent(in)	::	nSolve	number of elements solved in kernel
integer,	intent(in)	::	level	current level
type(mus_scheme_layout_type),	intent(in)	::	layout	current layout
type(mus_param_type),	intent(in)	::	params	global parameters
type(tem_varSys_type),	intent(in)	::	varSys	variable system definition
type(mus_derVarPos_type),	intent(in)	::	derVarPos(:)	position of derived quantities in varsys for all fields

public subroutine bgk_forcing_advRel_MSLiquid_generic(fieldProp, inState, outState, auxField, neigh, nElems, nSolve, level, layout, params, varSys, derVarPos)

Unoptimized Advection relaxation routine for the multispecies BGK model with external forcing term

Arguments

Type	Intent		Name
type(mus_field_prop_type),	intent(in)	::	fieldProp(:)	Array of field properties (fluid or species)
real(kind=rk),	intent(in)	::	inState(nElems*varSys%nScalars)	input pdf vector
real(kind=rk),	intent(out)	::	outState(nElems*varSys%nScalars)	output pdf vector
real(kind=rk),	intent(inout)	::	auxField(nElems*varSys%nAuxScalars)	Auxiliary field computed from pre-collision state Is updated with correct velocity field for multicomponent models
integer,	intent(in)	::	neigh(nElems*layout%fStencil%QQ)	connectivity vector
integer,	intent(in)	::	nElems	number of elements in state Array
integer,	intent(in)	::	nSolve	number of elements solved in kernel
integer,	intent(in)	::	level	current level
type(mus_scheme_layout_type),	intent(in)	::	layout	current layout
type(mus_param_type),	intent(in)	::	params	global parameters
type(tem_varSys_type),	intent(in)	::	varSys	variable system definition
type(mus_derVarPos_type),	intent(in)	::	derVarPos(:)	position of derived quantities in varsys for all fields

public subroutine mrt_advRel_MSLiquid_generic(fieldProp, inState, outState, auxField, neigh, nElems, nSolve, level, layout, params, varSys, derVarPos)

Unoptimized Advection relaxation routine for the multispecies BGK model

Arguments

Type	Intent		Name
type(mus_field_prop_type),	intent(in)	::	fieldProp(:)	Array of field properties (fluid or species)
real(kind=rk),	intent(in)	::	inState(nElems*varSys%nScalars)	input pdf vector
real(kind=rk),	intent(out)	::	outState(nElems*varSys%nScalars)	output pdf vector
real(kind=rk),	intent(inout)	::	auxField(nElems*varSys%nAuxScalars)	Auxiliary field computed from pre-collision state Is updated with correct velocity field for multicomponent models
integer,	intent(in)	::	neigh(nElems*layout%fStencil%QQ)	connectivity vector
integer,	intent(in)	::	nElems	number of elements in state Array
integer,	intent(in)	::	nSolve	number of elements solved in kernel
integer,	intent(in)	::	level	current level
type(mus_scheme_layout_type),	intent(in)	::	layout	current layout
type(mus_param_type),	intent(in)	::	params	global parameters
type(tem_varSys_type),	intent(in)	::	varSys	variable system definition
type(mus_derVarPos_type),	intent(in)	::	derVarPos(:)	position of derived quantities in varsys for all fields

public subroutine mrt_advRel_d3q19f3_MSLiquid(fieldProp, inState, outState, auxField, neigh, nElems, nSolve, level, layout, params, varSys, derVarPos)

Optimized Advection relaxation routine for the multispecies mrt model for d3q19 with 3 species

Arguments

Type	Intent		Name
type(mus_field_prop_type),	intent(in)	::	fieldProp(:)	Array of field properties (fluid or species)
real(kind=rk),	intent(in)	::	inState(nElems*varSys%nScalars)	input pdf vector
real(kind=rk),	intent(out)	::	outState(nElems*varSys%nScalars)	output pdf vector
real(kind=rk),	intent(inout)	::	auxField(nElems*varSys%nAuxScalars)	Auxiliary field computed from pre-collision state Is updated with correct velocity field for multicomponent models
integer,	intent(in)	::	neigh(nElems*layout%fStencil%QQ)	connectivity vector
integer,	intent(in)	::	nElems	number of elements in state Array
integer,	intent(in)	::	nSolve	number of elements solved in kernel
integer,	intent(in)	::	level	current level
type(mus_scheme_layout_type),	intent(in)	::	layout	current layout
type(mus_param_type),	intent(in)	::	params	global parameters
type(tem_varSys_type),	intent(in)	::	varSys	variable system definition
type(mus_derVarPos_type),	intent(in)	::	derVarPos(:)	position of derived quantities in varsys for all fields

public subroutine bgk_advRel_d3q19f3_MSLiquid_WTDF(fieldProp, inState, outState, auxField, neigh, nElems, nSolve, level, layout, params, varSys, derVarPos)

Semi-optimized Advection relaxation routine for the MSLiquid BGK model for d3q19 layout with three species with thermodynamic factor.

Arguments

Type	Intent		Name
type(mus_field_prop_type),	intent(in)	::	fieldProp(:)	Array of field properties (fluid or species)
real(kind=rk),	intent(in)	::	inState(nElems*varSys%nScalars)	input pdf vector
real(kind=rk),	intent(out)	::	outState(nElems*varSys%nScalars)	output pdf vector
real(kind=rk),	intent(inout)	::	auxField(nElems*varSys%nAuxScalars)	Auxiliary field computed from pre-collision state Is updated with correct velocity field for multicomponent models
integer,	intent(in)	::	neigh(nElems*layout%fStencil%QQ)	connectivity vector
integer,	intent(in)	::	nElems	number of elements in state Array
integer,	intent(in)	::	nSolve	number of elements solved in kernel
integer,	intent(in)	::	level	current level
type(mus_scheme_layout_type),	intent(in)	::	layout	current layout
type(mus_param_type),	intent(in)	::	params	global parameters
type(tem_varSys_type),	intent(in)	::	varSys	variable system definition
type(mus_derVarPos_type),	intent(in)	::	derVarPos(:)	position of derived quantities in varsys for all fields

public subroutine mrt_advRel_d3q19f3_MSLiquid_WTDF(fieldProp, inState, outState, auxField, neigh, nElems, nSolve, level, layout, params, varSys, derVarPos)

Optimized Advection relaxation routine for the multispecies mrt model for d3q19 with 3 species with thermodynamic factor

Arguments

Type	Intent		Name
type(mus_field_prop_type),	intent(in)	::	fieldProp(:)	Array of field properties (fluid or species)
real(kind=rk),	intent(in)	::	inState(nElems*varSys%nScalars)	input pdf vector
real(kind=rk),	intent(out)	::	outState(nElems*varSys%nScalars)	output pdf vector
real(kind=rk),	intent(inout)	::	auxField(nElems*varSys%nAuxScalars)	Auxiliary field computed from pre-collision state Is updated with correct velocity field for multicomponent models
integer,	intent(in)	::	neigh(nElems*layout%fStencil%QQ)	connectivity vector
integer,	intent(in)	::	nElems	number of elements in state Array
integer,	intent(in)	::	nSolve	number of elements solved in kernel
integer,	intent(in)	::	level	current level
type(mus_scheme_layout_type),	intent(in)	::	layout	current layout
type(mus_param_type),	intent(in)	::	params	global parameters
type(tem_varSys_type),	intent(in)	::	varSys	variable system definition
type(mus_derVarPos_type),	intent(in)	::	derVarPos(:)	position of derived quantities in varsys for all fields

public subroutine mrt_advRel_MSLiquid_generic_WTDF(fieldProp, inState, outState, auxField, neigh, nElems, nSolve, level, layout, params, varSys, derVarPos)

Unoptimized Advection relaxation routine for the multispecies BGK model with thermodynamic factors in Maxwell-Stefan formulation

Arguments

Type	Intent		Name
type(mus_field_prop_type),	intent(in)	::	fieldProp(:)	Array of field properties (fluid or species)
real(kind=rk),	intent(in)	::	inState(nElems*varSys%nScalars)	input pdf vector
real(kind=rk),	intent(out)	::	outState(nElems*varSys%nScalars)	output pdf vector
real(kind=rk),	intent(inout)	::	auxField(nElems*varSys%nAuxScalars)	Auxiliary field computed from pre-collision state Is updated with correct velocity field for multicomponent models
integer,	intent(in)	::	neigh(nElems*layout%fStencil%QQ)	connectivity vector
integer,	intent(in)	::	nElems	number of elements in state Array
integer,	intent(in)	::	nSolve	number of elements solved in kernel
integer,	intent(in)	::	level	current level
type(mus_scheme_layout_type),	intent(in)	::	layout	current layout
type(mus_param_type),	intent(in)	::	params	global parameters
type(tem_varSys_type),	intent(in)	::	varSys	variable system definition
type(mus_derVarPos_type),	intent(in)	::	derVarPos(:)	position of derived quantities in varsys for all fields

public subroutine bgk_advRel_MSLiquid_generic_WTDF(fieldProp, inState, outState, auxField, neigh, nElems, nSolve, level, layout, params, varSys, derVarPos)

Unoptimized Advection relaxation routine for the multispecies BGK model with thermodynamic factors in Maxwell-Stefan formulation

Arguments

Type	Intent		Name
type(mus_field_prop_type),	intent(in)	::	fieldProp(:)	Array of field properties (fluid or species)
real(kind=rk),	intent(in)	::	inState(nElems*varSys%nScalars)	input pdf vector
real(kind=rk),	intent(out)	::	outState(nElems*varSys%nScalars)	output pdf vector
real(kind=rk),	intent(inout)	::	auxField(nElems*varSys%nAuxScalars)	Auxiliary field computed from pre-collision state Is updated with correct velocity field for multicomponent models
integer,	intent(in)	::	neigh(nElems*layout%fStencil%QQ)	connectivity vector
integer,	intent(in)	::	nElems	number of elements in state Array
integer,	intent(in)	::	nSolve	number of elements solved in kernel
integer,	intent(in)	::	level	current level
type(mus_scheme_layout_type),	intent(in)	::	layout	current layout
type(mus_param_type),	intent(in)	::	params	global parameters
type(tem_varSys_type),	intent(in)	::	varSys	variable system definition
type(mus_derVarPos_type),	intent(in)	::	derVarPos(:)	position of derived quantities in varsys for all fields

mus_MSLiquid_module Module

Contents

Variables

Subroutines

Uses

Used by

Variables

Subroutines

public subroutine bgk_advRel_d3q19f3_MSLiquid(fieldProp, inState, outState, auxField, neigh, nElems, nSolve, level, layout, params, varSys, derVarPos)

Arguments

public subroutine bgk_advRel_MSLiquid_generic(fieldProp, inState, outState, auxField, neigh, nElems, nSolve, level, layout, params, varSys, derVarPos)

Arguments

public subroutine bgk_forcing_advRel_MSLiquid_generic(fieldProp, inState, outState, auxField, neigh, nElems, nSolve, level, layout, params, varSys, derVarPos)

Arguments

public subroutine mrt_advRel_MSLiquid_generic(fieldProp, inState, outState, auxField, neigh, nElems, nSolve, level, layout, params, varSys, derVarPos)

Arguments

public subroutine mrt_advRel_d3q19f3_MSLiquid(fieldProp, inState, outState, auxField, neigh, nElems, nSolve, level, layout, params, varSys, derVarPos)

Arguments

public subroutine bgk_advRel_d3q19f3_MSLiquid_WTDF(fieldProp, inState, outState, auxField, neigh, nElems, nSolve, level, layout, params, varSys, derVarPos)

Arguments

public subroutine mrt_advRel_d3q19f3_MSLiquid_WTDF(fieldProp, inState, outState, auxField, neigh, nElems, nSolve, level, layout, params, varSys, derVarPos)

Arguments

public subroutine mrt_advRel_MSLiquid_generic_WTDF(fieldProp, inState, outState, auxField, neigh, nElems, nSolve, level, layout, params, varSys, derVarPos)

Arguments

public subroutine bgk_advRel_MSLiquid_generic_WTDF(fieldProp, inState, outState, auxField, neigh, nElems, nSolve, level, layout, params, varSys, derVarPos)

Arguments