mus_solSpecHelpers_module Module

This module provides MUSUBI specific helper functions for extracting information from the solver specific character.


Uses


Interfaces

public interface getFieldVariable

  • private function getFieldVariable_scalar(conf, varLabel, varName, fieldVar, fieldProp) result(val)

    Get the field variable name for given field type from a given solver specific character handle.

    Arguments

    Type IntentOptional Attributes Name
    type(flu_State), intent(in) :: conf

    handle of the solver specific character
    character(len=*), intent(in) :: varLabel

    complete variable label (prefix + pure variable name)
    character(len=*), intent(in) :: varName

    pure variable name (e.g. density)
    character(len=*), intent(in) :: fieldVar

    required name of the field variable
    character(len=*), intent(in) :: fieldProp

    Which field type does the field variable belong to. Example: 'fluid'/'species'

    Return Value real(kind=rk)

    val to be returned

  • private function getFieldVariable_array(conf, varLabel, varName, fieldVar, fieldProp, nVals) result(val)

    Get the field variable name for given field type from a given solver specific character handle.

    Arguments

    Type IntentOptional Attributes Name
    type(flu_State), intent(in) :: conf

    handle of the solver specific character
    character(len=*), intent(in) :: varLabel

    complete variable label (prefix + pure variable name)
    character(len=*), intent(in) :: varName

    pure variable name (e.g. density)
    character(len=*), intent(in) :: fieldVar

    required name of the field variable
    character(len=*), intent(in) :: fieldProp

    Which field type does the field variable belong to. Example: 'fluid'/'species'
    integer, intent(in) :: nVals

    number of entries in the array to read out

    Return Value real(kind=rk), (nVals)

    val to be returned


Functions

public function getIdentifyChar(conf, key) result(resChar)

Get a character from the identify table using a given solver specific character handle and a given key word.

Arguments

Type IntentOptional Attributes Name
type(flu_State), intent(in) :: conf

handle of the solver specific character
character(len=*), intent(in) :: key

key to search for

Return Value character(len=labelLen)

scheme kind to be returned

public function getVariable_FromTable(conf, varLabel, table) result(val)

Get the value of variable inside the table name 'key' in scheme @note Todo extent it for vectors

Arguments

Type IntentOptional Attributes Name
type(flu_State), intent(in) :: conf

handle of the solver specific character
character(len=*), intent(in) :: varLabel

complete variable label
character(len=*), intent(in) :: table

table name

Return Value real(kind=rk)

val to be returned

public function getNFields(conf) result(nFields)

Get the number of fields from a given solver specific character handle.

Arguments

Type IntentOptional Attributes Name
type(flu_State), intent(in) :: conf

handle of the solver specific character

Return Value integer

number of fields to be returned

public function getFieldPrefixes(conf, nFields) result(prefix)

Get the right field prefixes from a given solver specific character handle.

Arguments

Type IntentOptional Attributes Name
type(flu_State), intent(in) :: conf

handle of the solver specific character
integer, intent(in) :: nFields

Return Value character(len=labelLen), (nFields)

field prefixes to be returned

public function getWeights(conf, stencil) result(weights)

Get the the weights of a used stencil from a given solver specific character handle.

Arguments

Type IntentOptional Attributes Name
type(flu_State), intent(in) :: conf

handle of the solver specific character
type(tem_stencilHeader_type), intent(in) :: stencil

stencil information

Return Value real(kind=rk), (stencil%QQ)

weights to be returned

public function getConversionFac(conf, facName, nLevels) result(val)

Get the conversion factor variable from physics table from a given solver specific character handle.

Arguments

Type IntentOptional Attributes Name
type(flu_State), intent(in) :: conf

handle of the solver specific character
character(len=*), intent(in) :: facName

conversion factor variable label
integer, intent(in) :: nLevels

Return Value real(kind=rk), (nLevels)

val to be returned

private function getFieldVariable_scalar(conf, varLabel, varName, fieldVar, fieldProp) result(val)

Get the field variable name for given field type from a given solver specific character handle.

Arguments

Type IntentOptional Attributes Name
type(flu_State), intent(in) :: conf

handle of the solver specific character
character(len=*), intent(in) :: varLabel

complete variable label (prefix + pure variable name)
character(len=*), intent(in) :: varName

pure variable name (e.g. density)
character(len=*), intent(in) :: fieldVar

required name of the field variable
character(len=*), intent(in) :: fieldProp

Which field type does the field variable belong to. Example: 'fluid'/'species'

Return Value real(kind=rk)

val to be returned

private function getFieldVariable_array(conf, varLabel, varName, fieldVar, fieldProp, nVals) result(val)

Get the field variable name for given field type from a given solver specific character handle.

Arguments

Type IntentOptional Attributes Name
type(flu_State), intent(in) :: conf

handle of the solver specific character
character(len=*), intent(in) :: varLabel

complete variable label (prefix + pure variable name)
character(len=*), intent(in) :: varName

pure variable name (e.g. density)
character(len=*), intent(in) :: fieldVar

required name of the field variable
character(len=*), intent(in) :: fieldProp

Which field type does the field variable belong to. Example: 'fluid'/'species'
integer, intent(in) :: nVals

number of entries in the array to read out

Return Value real(kind=rk), (nVals)

val to be returned