Neko  0.8.1
A portable framework for high-order spectral element flow simulations
json_utils::json_get Interface Reference

Retrieves a parameter by name or throws an error. More...

Private Member Functions

subroutine json_get_real (json, name, value)
 Retrieves a real parameter by name or throws an error. More...
 
subroutine json_get_double (json, name, value)
 Retrieves a double precision real parameter by name or throws an error. More...
 
subroutine json_get_integer (json, name, value)
 Retrieves an integer parameter by name or throws an error. More...
 
subroutine json_get_logical (json, name, value)
 Retrieves a logical parameter by name or throws an error. More...
 
subroutine json_get_string (json, name, value)
 Retrieves a string parameter by name or throws an error. More...
 
subroutine json_get_real_array (json, name, value)
 Retrieves a real array parameter by name or throws an error. More...
 
subroutine json_get_double_array (json, name, value)
 Retrieves a real array parameter by name or throws an error. More...
 
subroutine json_get_integer_array (json, name, value)
 Retrieves a integer array parameter by name or throws an error. More...
 
subroutine json_get_logical_array (json, name, value)
 Retrieves a logical array parameter by name or throws an error. More...
 
subroutine json_get_string_array (json, name, value, filler)
 Retrieves a string array parameter by name or throws an error. More...
 

Detailed Description

Retrieves a parameter by name or throws an error.

Definition at line 44 of file json_utils.f90.

Member Function/Subroutine Documentation

◆ json_get_double()

subroutine json_utils::json_get::json_get_double ( type(json_file), intent(inout)  json,
character(len=*), intent(in)  name,
real(kind=dp), intent(out)  value 
)
private

Retrieves a double precision real parameter by name or throws an error.

Parameters
[in,out]jsonThe json to retrieve the parameter from.
[in]nameThe full path to the parameter.
[out]valueThe variable to be populated with the retrieved parameter.

Definition at line 82 of file json_utils.f90.

◆ json_get_double_array()

subroutine json_utils::json_get::json_get_double_array ( type(json_file), intent(inout)  json,
character(len=*), intent(in)  name,
real(kind=dp), dimension(:), intent(out), allocatable  value 
)
private

Retrieves a real array parameter by name or throws an error.

Parameters
[in,out]jsonThe json to retrieve the parameter from.
[in]nameThe full path to the parameter.
[out]valueThe variable to be populated with the retrieved parameter.

Definition at line 167 of file json_utils.f90.

◆ json_get_integer()

subroutine json_utils::json_get::json_get_integer ( type(json_file), intent(inout)  json,
character(len=*), intent(in)  name,
integer, intent(out)  value 
)
private

Retrieves an integer parameter by name or throws an error.

Parameters
[in,out]jsonThe json to retrieve the parameter from.
[in]nameThe full path to the parameter.
[out]valueThe variable to be populated with the retrieved parameter.

Definition at line 99 of file json_utils.f90.

◆ json_get_integer_array()

subroutine json_utils::json_get::json_get_integer_array ( type(json_file), intent(inout)  json,
character(len=*), intent(in)  name,
integer, dimension(:), intent(out), allocatable  value 
)
private

Retrieves a integer array parameter by name or throws an error.

Parameters
[in,out]jsonThe json to retrieve the parameter from.
[in]nameThe full path to the parameter.
[out]valueThe variable to be populated with the retrieved parameter.

Definition at line 184 of file json_utils.f90.

◆ json_get_logical()

subroutine json_utils::json_get::json_get_logical ( type(json_file), intent(inout)  json,
character(len=*), intent(in)  name,
logical, intent(out)  value 
)
private

Retrieves a logical parameter by name or throws an error.

Parameters
[in,out]jsonThe json to retrieve the parameter from.
[in]nameThe full path to the parameter.
[out]valueThe variable to be populated with the retrieved parameter.

Definition at line 116 of file json_utils.f90.

◆ json_get_logical_array()

subroutine json_utils::json_get::json_get_logical_array ( type(json_file), intent(inout)  json,
character(len=*), intent(in)  name,
logical, dimension(:), intent(out), allocatable  value 
)
private

Retrieves a logical array parameter by name or throws an error.

Parameters
[in,out]jsonThe json to retrieve the parameter from.
[in]nameThe full path to the parameter.
[out]valueThe variable to be populated with the retrieved parameter.

Definition at line 201 of file json_utils.f90.

◆ json_get_real()

subroutine json_utils::json_get::json_get_real ( type(json_file), intent(inout)  json,
character(len=*), intent(in)  name,
real(kind=sp), intent(out)  value 
)
private

Retrieves a real parameter by name or throws an error.

Parameters
[in,out]jsonThe json to retrieve the parameter from.
[in]nameThe full path to the parameter.
[out]valueThe variable to be populated with the retrieved parameter.

Definition at line 65 of file json_utils.f90.

◆ json_get_real_array()

subroutine json_utils::json_get::json_get_real_array ( type(json_file), intent(inout)  json,
character(len=*), intent(in)  name,
real(kind=sp), dimension(:), intent(out), allocatable  value 
)
private

Retrieves a real array parameter by name or throws an error.

Parameters
[in,out]jsonThe json to retrieve the parameter from.
[in]nameThe full path to the parameter.
[out]valueThe variable to be populated with the retrieved parameter.

Definition at line 150 of file json_utils.f90.

◆ json_get_string()

subroutine json_utils::json_get::json_get_string ( type(json_file), intent(inout)  json,
character(len=*), intent(in)  name,
character(len=:), intent(out), allocatable  value 
)
private

Retrieves a string parameter by name or throws an error.

Parameters
[in,out]jsonThe json to retrieve the parameter from.
[in]nameThe full path to the parameter.
[out]valueThe variable to be populated with the retrieved parameter.

Definition at line 133 of file json_utils.f90.

◆ json_get_string_array()

subroutine json_utils::json_get::json_get_string_array ( type(json_file), intent(inout)  json,
character(len=*), intent(in)  name,
character(len=*), dimension(:), intent(out), allocatable  value,
character(len=*), intent(in), optional  filler 
)
private

Retrieves a string array parameter by name or throws an error.

Parameters
[in,out]jsonThe json to retrieve the parameter from.
[in]nameThe full path to the parameter.
[out]valueThe variable to be populated with the retrieved parameter.
[in]fillerThe default string to fill empty array items with.

Definition at line 219 of file json_utils.f90.


The documentation for this interface was generated from the following file: