json_utils::json_get Interface Reference

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

Public Member Functions
subroutine	json_get_real (json, name, value)
	Retrieves a real parameter by name or throws an error.
subroutine	json_get_double (json, name, value)
	Retrieves a double precision real parameter by name or throws an error.
subroutine	json_get_integer (json, name, value)
	Retrieves an integer parameter by name or throws an error.
subroutine	json_get_logical (json, name, value)
	Retrieves a logical parameter by name or throws an error.
subroutine	json_get_string (json, name, value)
	Retrieves a string parameter by name or throws an error.
subroutine	json_get_real_array (json, name, value, expected_size)
	Retrieves a real array parameter by name or throws an error.
subroutine	json_get_double_array (json, name, value, expected_size)
	Retrieves a double precision array parameter by name or throws an error.
subroutine	json_get_integer_array (json, name, value, expected_size)
	Retrieves a integer array parameter by name or throws an error.
subroutine	json_get_logical_array (json, name, value, expected_size)
	Retrieves a logical array parameter by name or throws an error.
subroutine	json_get_string_array (json, name, value, filler)
	Retrieves a string array parameter by name or throws an error.
subroutine	json_get_subdict (json, key, output)
	Extract a sub-object from a json object.

Detailed Description

Definition at line 59 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
	)

Parameters

[in,out]	json	The json to retrieve the parameter from.
[in]	name	The full path to the parameter.
[out]	value	The variable to be populated with the retrieved parameter

Definition at line 180 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,
		integer, intent(in), optional	expected_size
	)

Parameters

[in,out]	json	The json to retrieve the parameter from.
[in]	name	The full path to the parameter.
[out]	value	The variable to be populated with the retrieved parameter
[in]	expected_size	(Optional) The expected size of the array. If provided, throws an error if the actual size does not match.

Definition at line 297 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
	)

Parameters

[in,out]	json	The json to retrieve the parameter from.
[in]	name	The full path to the parameter.
[out]	value	The variable to be populated with the retrieved parameter

Definition at line 201 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,
		integer, intent(in), optional	expected_size
	)

Parameters

[in,out]	json	The json to retrieve the parameter from.
[in]	name	The full path to the parameter.
[out]	value	The variable to be populated with the retrieved parameter
[in]	expected_size	(Optional) The expected size of the array. If provided, throws an error if the actual size does not match.

Definition at line 328 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
	)

Parameters

[in,out]	json	The json to retrieve the parameter from.
[in]	name	The full path to the parameter.
[out]	value	The variable to be populated with the retrieved parameter

Definition at line 222 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,
		integer, intent(in), optional	expected_size
	)

Parameters

[in,out]	json	The json to retrieve the parameter from.
[in]	name	The full path to the parameter.
[out]	value	The variable to be populated with the retrieved parameter
[in]	expected_size	(Optional) The expected size of the array. If provided, throws an error if the actual size does not match.

Definition at line 357 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
	)

Parameters

[in,out]	json	The json to retrieve the parameter from.
[in]	name	The full path to the parameter.
[out]	value	The variable to be populated with the retrieved parameter.

Definition at line 159 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,
		integer, intent(in), optional	expected_size
	)

Parameters

[in,out]	json	The json to retrieve the parameter from.
[in]	name	The full path to the parameter.
[out]	value	The variable to be populated with the retrieved parameter
[in]	expected_size	(Optional) The expected size of the array. If provided, throws an error if the actual size does not match.

Definition at line 266 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
	)

Parameters

[in,out]	json	The json to retrieve the parameter from.
[in]	name	The full path to the parameter.
[out]	value	The variable to be populated with the retrieved parameter

Definition at line 243 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
	)

Parameters

[in,out]	json	The json to retrieve the parameter from.
[in]	name	The full path to the parameter.
[out]	value	The variable to be populated with the retrieved parameter
[in]	filler	The default string to fill empty array items with.

Definition at line 387 of file json_utils.f90.

json_get_subdict()

subroutine json_utils::json_get::json_get_subdict	(	type(json_file), intent(inout)	json,
		character(len=*), intent(in)	key,
		type(json_file), intent(inout)	output
	)

Definition at line 442 of file json_utils.f90.

---

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

• /home/runner/work/neko/neko/src/common/json_utils.f90