FLASH-X
Doxygen Generated Documentation From Interface Source Code
Functions/Subroutines
nameValueLL_get.F90 File Reference

Go to the source code of this file.

Functions/Subroutines

subroutine nameValueLL_getReal (context, name, value, current_val, error)
 
subroutine nameValueLL_getInt (context, name, value, current_val, error)
 
subroutine nameValueLL_getStr (context, name, value, current_val, error)
 
subroutine nameValueLL_getLog (context, name, value, current_val, error)
 

Function/Subroutine Documentation

◆ nameValueLL_getInt()

subroutine nameValueLL_getInt ( type (context_type), intent(in)  context,
character(len=*), intent(in)  name,
integer, intent(inout)  value,
logical, intent(in)  current_val,
integer, intent(out)  error 
)

Definition at line 89 of file nameValueLL_get.F90.

◆ nameValueLL_getLog()

subroutine nameValueLL_getLog ( type (context_type), intent(in)  context,
character(len=*), intent(in)  name,
logical, intent(inout)  value,
logical, intent(in)  current_val,
integer, intent(out)  error 
)

Definition at line 186 of file nameValueLL_get.F90.

◆ nameValueLL_getReal()

subroutine nameValueLL_getReal ( type (context_type), intent(in)  context,
character(len=*), intent(in)  name,
real, intent(inout)  value,
logical, intent(in)  current_val,
integer, intent(out)  error 
)

Gets a name from a linked list implemented under the hood. This subroutine is overloaded and implements nameValueLL_getReal, nameValueLL_getInt nameValueLL_getStr, nameValueLL_getLog

context: type of list (ie for parameters or scalars) name: name or parameter or scalar value: name value current_val: a logical true/false value that indicates whether you want the current value of the parameter or scalar or if you want the original value (ie the value that was stored in the checkpoint file)

NOTES For most purposes current_val will be set to true. This argument is hidden under the hood from users. Users will call either RuntimeParameters_get or RuntimeParameters_getPrev. The rare times that users call RuntimeParameters_getPrev, the logical value current_value will be set to false.

Definition at line 40 of file nameValueLL_get.F90.

◆ nameValueLL_getStr()

subroutine nameValueLL_getStr ( type (context_type), intent(in)  context,
character(len=*), intent(in)  name,
character(len=*), intent(inout)  value,
logical, intent(in)  current_val,
integer, intent(out)  error 
)

Definition at line 136 of file nameValueLL_get.F90.