mus_derVarPos_module

This module contains the type defintion which stores position of all derive variables in global varSys.

function to compute equilFromAux for single element

Used by

mus_derVarPos_module		w	mus_auxField_module
		w
		w	mus_auxFieldVar_module
		w
		w	mus_bc_fluid_experimental_module
		w
		w	mus_bc_fluid_module
		w
		w	mus_bc_fluid_nonEqExpol_module
		w
		w	mus_bc_fluid_turbulent_module
		w
		w	mus_bc_fluid_wall_module
		w
		w	mus_bc_general_module
		w
		w	mus_bc_header_module
		w
		w	mus_bc_nernstPlanck_module
		w
		w	mus_bc_passiveScalar_module
		w
		w	mus_bc_poisson_module
		w
		w	mus_bc_species_module
		w
		w	mus_bgk_module
		w
		w	mus_compute_cumulant_module
		w
		w	mus_compute_nernstPlanck_module
		w
		w	mus_compute_passiveScalar_module
		w
		w	mus_compute_Poisson_module
		w
		w	mus_control_module
		w
		w	mus_d2q9_module
		w
		w	mus_d3q19_module
		w
		w	mus_d3q27_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_derQuanPoisson_module
		w
		w	mus_derQuanPS_module
		w
		w	mus_flow_module
		w
		w	mus_IBM_module
		w
	w	mus_interpolate_average_module
	w
	w	mus_interpolate_debug_module
	w
	w	mus_interpolate_header_module
	w
	w	mus_interpolate_linear_module
	w
	w	mus_interpolate_quadratic_module
	w
	w	mus_interpolate_verify_module
	w
	w	mus_isotherm_acEq_module
	w
	w	mus_mrt_d3q19_module
	w
	w	mus_mrt_d3q27_module
	w
	w	mus_MSGas_module
	w
	w	mus_MSLiquid_module
	w
	w	mus_relaxationParam_module
	w
	w	mus_scheme_type_module
	w
	w	mus_source_module
	w
	w	mus_source_type_module
	w
	w	mus_source_var_module
	w
	w	mus_source_var_turbChanForce_module
	w
	w	mus_test_module
	w
	w	mus_variable_module
	w

Help

Abstract Interfaces

abstract interface

private pure function derive_equilFromAuxFunc(derVarPos, auxField, iField, varSys, layout) result(res)

Derive equilibrium from auxField for single element

Arguments

Type	Intent		Name
class(mus_derVarPos_type),	intent(in)	::	derVarPos	Position of current field derive variable in variable system
real(kind=rk),	intent(in)	::	auxField(:)	Array of auxField of single element. Single species: dens_1, vel_1 multispecies: dens_1_sp1, vel_1_spc1, dens_1_sp2, vel_1_spc2, Access: (iElem-1)*nFields + iField
integer,	intent(in)	::	iField	Current field
type(tem_varSys_type),	intent(in)	::	varSys	variable system which is required to access fieldProp information via variable method data c_ptr
type(mus_scheme_layout_type),	intent(in)	::	layout	scheme layout contains stencil definition and lattice weights

Return Value real(kind=rk), (layout%fStencil%QQ)

Output of this routine Dimension: QQ of res

abstract interface

private pure function derive_auxFromStateFunc(derVarPos, state, iField, stencil, varSys) result(res)

Derive auxField from state for single element

Arguments

Type	Intent		Name
class(mus_derVarPos_type),	intent(in)	::	derVarPos	Position of derive variable in variable system
real(kind=rk),	intent(in)	::	state(:)	Array of state layout%stencil(1)%QQ * nFields
integer,	intent(in)	::	iField	Current field
type(tem_stencilHeader_type),	intent(in)	::	stencil	stencil header contains discrete velocity vectors
type(tem_varSys_type),	intent(in)	::	varSys	variable system which is required to access fieldProp information via variable method data c_ptr

Return Value real(kind=rk), (varSys%nAuxScalars)

Output of this routine Size: nAuxScalars

abstract interface

private subroutine derive_FromMacro(density, velocity, iField, nElems, varSys, layout, res)

interface to derive equilibrium from macro. Mainly used in initial condition and boundary condition routines to avoid dublication of routines between different scheme kinds. In this interface, solver definition can be access via varSys%method%val(1)%method_data c_ptr

Arguments

Type	Intent		Name
real(kind=rk),	intent(in)	::	density(:)	Array of density. Single species: dens_1, dens_2 .. dens_n multispecies: dens_1_sp1, dens_1_sp2, dens_2_sp1, dens_2_sp2 ... dens_n_sp1, dens_n_sp2 Access: (iElem-1)*nFields + iField
real(kind=rk),	intent(in)	::	velocity(:,:)	Array of velocity. Size: (3, nnFields) Access: ( iComp, (iElem-1)nFields + iField )
integer,	intent(in)	::	iField	Current field
integer,	intent(in)	::	nElems	number of elements
type(tem_varSys_type),	intent(in)	::	varSys	variable system which is required to access fieldProp information via variable method data c_ptr
type(mus_scheme_layout_type),	intent(in)	::	layout	scheme layout contains stencil definition and lattice weights
real(kind=rk),	intent(out)	::	res(:)	Output of this routine Dimension: n*nComponents of res

abstract interface

private subroutine derive_FromState(state, iField, nElems, varSys, layout, res)

Interface that takes state array as input calculate density, velocity or eq as output State should be AOS layout

Arguments

Type	Intent		Name
real(kind=rk),	intent(in)	::	state(:)	Array of state n * layout%stencil(1)%QQ * nFields
integer,	intent(in)	::	iField	Current field
integer,	intent(in)	::	nElems	number of elements
type(tem_varSys_type),	intent(in)	::	varSys	variable system which is required to access fieldProp information via variable method data c_ptr
type(mus_scheme_layout_type),	intent(in)	::	layout	scheme layout contains stencil definition and lattice weights
real(kind=rk),	intent(out)	::	res(:)	Output of this routine Dimension: n * nComponents of res Access: (iElem-1)nComp + iComp To derive velocities of all species, dimension: nnFieldsnComp Access: (iElem-1)nFieldsnComp + (iField-1)nComp + iComp

abstract interface

private subroutine derive_FromPreColState(state, neigh, iField, nSize, nElems, varSys, layout, res)

Interface that takes state array as input calculate density, velocity or eq as output from FETCH state i.e. precollision state State should be AOS layout

Arguments

Type	Intent		Name
real(kind=rk),	intent(in)	::	state(:)	Array of state n * layout%stencil(1)%QQ * nFields
integer,	intent(in)	::	neigh(:)	connectivity array
integer,	intent(in)	::	iField	Current field
integer,	intent(in)	::	nSize	number of elements in state array
integer,	intent(in)	::	nElems	number of elements
type(tem_varSys_type),	intent(in)	::	varSys	variable system which is required to access fieldProp information via variable method data c_ptr
type(mus_scheme_layout_type),	intent(in)	::	layout	scheme layout contains stencil definition and lattice weights
real(kind=rk),	intent(out)	::	res(:)	Output of this routine Dimension: n * nComponents of res Access: (iElem-1)nComp + iComp To derive velocities of all species, dimension: nnFieldsnComp Access: (iElem-1)nFieldsnComp + (iField-1)nComp + iComp

abstract interface

private subroutine derive_equilFromAux(derVarPos, auxField, iField, nElems, varSys, layout, res)

Derive equilibrium from auxField for given nelems

Arguments

Type	Intent		Name
class(mus_derVarPos_type),	intent(in)	::	derVarPos	Position of current field derive variable in variable system
real(kind=rk),	intent(in)	::	auxField(:)	Array of auxField. Single species: dens_1, vel_1, dens_2, vel_2, .. dens_n, vel_n multispecies: dens_1_sp1, vel_1_spc1, dens_1_sp2, vel_1_spc2, dens_2_sp1, vel_2_spc2, dens_2_sp2, vel_2_spc2 ... dens_n_sp1, vel_n_sp1, dens_n_sp2, vel_n_spc2 Access: (iElem-1)*nFields + iField
integer,	intent(in)	::	iField	Current field
integer,	intent(in)	::	nElems	number of elements
type(tem_varSys_type),	intent(in)	::	varSys	variable system which is required to access fieldProp information via variable method data c_ptr
type(mus_scheme_layout_type),	intent(in)	::	layout	scheme layout contains stencil definition and lattice weights
real(kind=rk),	intent(out)	::	res(:)	Output of this routine Dimension: n*QQ of res

abstract interface

private subroutine derive_auxFromState(derVarPos, state, neigh, iField, nElems, nSize, iLevel, stencil, varSys, auxField, quantities)

Derive auxField from local state. \todo KM: pass external force to add to auxField

Arguments

Type	Intent		Name
class(mus_derVarPos_type),	intent(in)	::	derVarPos	Position of current field derive variable in variable system
real(kind=rk),	intent(in)	::	state(:)	Array of state nSize * layout%stencil(1)%QQ * nFields use IDX macro to access this state
integer,	intent(in)	::	neigh(:)	connectivity vector
integer,	intent(in)	::	iField	Current field
integer,	intent(in)	::	nElems	number of elements to compute
integer,	intent(in)	::	nSize	number of elements in state array
integer,	intent(in)	::	iLevel	current level
type(tem_stencilHeader_type),	intent(in)	::	stencil	stencil header contains discrete velocity vectors
type(tem_varSys_type),	intent(in)	::	varSys	variable system which is required to access fieldProp information via variable method data c_ptr
real(kind=rk),	intent(inout)	::	auxField(:)	Output of this routine auxField is inout to allow storing auxField for each species seperately Size: nElems*nAuxScalars
type(mus_scheme_derived_quantities_type),	intent(in)	::	quantities	Class that contains pointers to the proper derived quantities functions

Derived Types

type, public :: mus_derVarPos_type

This type stores the position of each variable in the global sys

Components

Type	Visibility	Attributes		Name		Initial
integer,	public		::	pdf	=	-1
integer,	public		::	fetch_pdf	=	-1
integer,	public		::	omega	=	-1
integer,	public		::	density	=	-1
integer,	public		::	moleDensity	=	-1
integer,	public		::	pressure	=	-1
integer,	public		::	kinePress	=	-1
integer,	public		::	velocity	=	-1
integer,	public		::	spc_velocities	=	-1
integer,	public		::	velMag	=	-1
integer,	public		::	momentum	=	-1
integer,	public		::	spc_momenta	=	-1
integer,	public		::	shearStress	=	-1
integer,	public		::	wss	=	-1
integer,	public		::	shearMag	=	-1
integer,	public		::	strainRate	=	-1
integer,	public		::	shearRate	=	-1
integer,	public		::	kineticEnergy	=	-1
integer,	public		::	temperature	=	-1
integer,	public		::	moleFrac	=	-1
integer,	public		::	massFrac	=	-1
integer,	public		::	moleflux	=	-1
integer,	public		::	equilibrium	=	-1
integer,	public		::	nonEquilibrium	=	-1
integer,	public		::	equilibriumVel	=	-1
integer,	public		::	potential	=	-1
procedure(derive_FromMacro),	public,	pointer, nopass	::	equilFromMacro	=>	null()
procedure(derive_FromState),	public,	pointer, nopass	::	velFromState	=>	null()
procedure(derive_FromState),	public,	pointer, nopass	::	equilFromState	=>	null()
procedure(derive_FromState),	public,	pointer, nopass	::	momFromState	=>	null()
procedure(derive_FromState),	public,	pointer, nopass	::	velocitiesFromState	=>	null()
procedure(derive_FromState),	public,	pointer, nopass	::	momentaFromState	=>	null()
procedure(derive_FromPreColState),	public,	pointer, nopass	::	velFromPreColState	=>	null()
procedure(derive_auxFromState),	public,	pointer	::	auxFieldFromState	=>	null()	return auxField from local pdf state
procedure(derive_equilFromAux),	public,	pointer, nopass	::	equilFromAux	=>	null()	return equilibrium from auxilary variable for given nElems

Subroutines

public subroutine mus_derive_FromMacro_dummy(density, velocity, iField, nElems, varSys, layout, res)

Arguments

Type	Intent		Name
real(kind=rk),	intent(in)	::	density(:)	Array of density. Single species: dens_1, dens_2 .. dens_n multispecies: dens_1_sp1, dens_1_sp2, dens_2_sp1, dens_2_sp2 ... dens_n_sp1, dens_n_sp2 Access: (iElem-1)*nFields + iField
real(kind=rk),	intent(in)	::	velocity(:,:)	Array of velocity. Size: (3, nnFields) Access: ( iComp, (iElem-1)nFields + iField )
integer,	intent(in)	::	iField	Current field
integer,	intent(in)	::	nElems	number of elements
type(tem_varSys_type),	intent(in)	::	varSys	variable system which is required to access fieldProp information via variable method data c_ptr
type(mus_scheme_layout_type),	intent(in)	::	layout	scheme layout contains stencil definition and lattice weights
real(kind=rk),	intent(out)	::	res(:)	Output of this routine Dimension: n*nComponents of res

public subroutine mus_derive_FromState_dummy(state, iField, nElems, varSys, layout, res)

Arguments

Type	Intent		Name
real(kind=rk),	intent(in)	::	state(:)	Array of state n * layout%stencil(1)%QQ * nFields
integer,	intent(in)	::	iField	Current field
integer,	intent(in)	::	nElems	number of elements
type(tem_varSys_type),	intent(in)	::	varSys	variable system which is required to access fieldProp information via variable method data c_ptr
type(mus_scheme_layout_type),	intent(in)	::	layout	scheme layout contains stencil definition and lattice weights
real(kind=rk),	intent(out)	::	res(:)	Output of this routine Dimension: n * nComponents of res Access: (iElem-1)nComp + iComp To derive velocities of all species, dimension: nnFieldsnComp Access: (iElem-1)nFieldsnComp + (iField-1)nComp + iComp

public subroutine mus_derive_FromPreColState_dummy(state, neigh, iField, nSize, nElems, varSys, layout, res)

Arguments

Type	Intent		Name
real(kind=rk),	intent(in)	::	state(:)	Array of state n * layout%stencil(1)%QQ * nFields
integer,	intent(in)	::	neigh(:)	connectivity array
integer,	intent(in)	::	iField	Current field
integer,	intent(in)	::	nSize	number of elements in state array
integer,	intent(in)	::	nElems	number of elements
type(tem_varSys_type),	intent(in)	::	varSys	variable system which is required to access fieldProp information via variable method data c_ptr
type(mus_scheme_layout_type),	intent(in)	::	layout	scheme layout contains stencil definition and lattice weights
real(kind=rk),	intent(out)	::	res(:)	Output of this routine Dimension: n * nComponents of res Access: (iElem-1)nComp + iComp To derive velocities of all species, dimension: nnFieldsnComp Access: (iElem-1)nFieldsnComp + (iField-1)nComp + iComp

mus_derVarPos_module Module

Contents

Abstract Interfaces

Derived Types

Subroutines

Uses

Used by

Abstract Interfaces

abstract interface

private pure function derive_equilFromAuxFunc(derVarPos, auxField, iField, varSys, layout) result(res)

Arguments

Return Value real(kind=rk), (layout%fStencil%QQ)

abstract interface

private pure function derive_auxFromStateFunc(derVarPos, state, iField, stencil, varSys) result(res)

Arguments

Return Value real(kind=rk), (varSys%nAuxScalars)

abstract interface

private subroutine derive_FromMacro(density, velocity, iField, nElems, varSys, layout, res)

Arguments

abstract interface

private subroutine derive_FromState(state, iField, nElems, varSys, layout, res)

Arguments

abstract interface

private subroutine derive_FromPreColState(state, neigh, iField, nSize, nElems, varSys, layout, res)

Arguments

abstract interface

private subroutine derive_equilFromAux(derVarPos, auxField, iField, nElems, varSys, layout, res)

Arguments

abstract interface

private subroutine derive_auxFromState(derVarPos, state, neigh, iField, nElems, nSize, iLevel, stencil, varSys, auxField, quantities)

Arguments

Derived Types

type, public :: mus_derVarPos_type

Components

Subroutines

public subroutine mus_derive_FromMacro_dummy(density, velocity, iField, nElems, varSys, layout, res)

Arguments

public subroutine mus_derive_FromState_dummy(state, iField, nElems, varSys, layout, res)

Arguments

public subroutine mus_derive_FromPreColState_dummy(state, neigh, iField, nSize, nElems, varSys, layout, res)

Arguments