read_namefile_routines

Subroutines and functions for reading in name files

Uses

- uemep_constants
Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.

Used by

Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.

Interfaces

private interface read_name

public function read_name_real(name_str, default_val, unit_in, unit_out) result(res)

Reads single precision value from name file

Skips comments (!) and returns default value if name is not present in name file

Arguments

Type	Intent		Name
character(len=*),	intent(in)	::	name_str	Name of value in name file
real,	intent(in)	::	default_val	Default value
integer,	intent(in)	::	unit_in	Name file unit
integer,	intent(in)	::	unit_out	Log file unit

Return Value real

Value found in name file (or default value)

public function read_name_double(name_str, default_val, unit_in, unit_out) result(res)

Reads double precision value from name file

Skips comments (!) and returns default value if name is not present in name file

Arguments

Type	Intent		Name
character(len=*),	intent(in)	::	name_str	Name of value in name file
real(kind=dp),	intent(in)	::	default_val	Default value
integer,	intent(in)	::	unit_in	Name file unit
integer,	intent(in)	::	unit_out	Log file unit

Return Value real(kind=dp)

Value found in name file (or default value)

public function read_name_integer(name_str, default_val, unit_in, unit_out) result(res)

Reads integer value from name file

Skips comments (!) and returns default value if name is not present in name file

Arguments

Type	Intent		Name
character(len=*),	intent(in)	::	name_str	Name of value in name file
integer,	intent(in)	::	default_val	Default value
integer,	intent(in)	::	unit_in	Name file unit
integer,	intent(in)	::	unit_out	Log file unit

Return Value integer

Value found in name file (or default value)

public function read_name_char(name_str, default_val, unit_in, unit_out) result(res)

Reads string from name file

Skips comments (!) and returns default string if name is not present in name file

Arguments

Type	Intent		Name
character(len=*),	intent(in)	::	name_str	Name of string in name file
character(len=*),	intent(in)	::	default_val	Default string
integer,	intent(in)	::	unit_in	Name file unit
integer,	intent(in)	::	unit_out	Log file unit

Return Value character(len=:), allocatable

String found in name file (or default string)

public function read_name_logical(name_str, default_val, unit_in, unit_out) result(res)

Reads boolean value from name file

Skips comments (!) and returns default value if name is not present in name file

Arguments

Type	Intent		Name
character(len=*),	intent(in)	::	name_str	Name of value in name file
logical,	intent(in)	::	default_val	Default value
integer,	intent(in)	::	unit_in	Name file unit
integer,	intent(in)	::	unit_out	Log file unit

Return Value logical

Functions

public function read_name_char(name_str, default_val, unit_in, unit_out) result(res)

Reads string from name file

Arguments

Type	Intent		Name
character(len=*),	intent(in)	::	name_str	Name of string in name file
character(len=*),	intent(in)	::	default_val	Default string
integer,	intent(in)	::	unit_in	Name file unit
integer,	intent(in)	::	unit_out	Log file unit

Return Value character(len=:), allocatable

String found in name file (or default string)

public function read_name_double(name_str, default_val, unit_in, unit_out) result(res)

Reads double precision value from name file

Arguments

Type	Intent		Name
character(len=*),	intent(in)	::	name_str	Name of value in name file
real(kind=dp),	intent(in)	::	default_val	Default value
integer,	intent(in)	::	unit_in	Name file unit
integer,	intent(in)	::	unit_out	Log file unit

Return Value real(kind=dp)

Value found in name file (or default value)

public function read_name_integer(name_str, default_val, unit_in, unit_out) result(res)

Reads integer value from name file

Arguments

Type	Intent		Name
character(len=*),	intent(in)	::	name_str	Name of value in name file
integer,	intent(in)	::	default_val	Default value
integer,	intent(in)	::	unit_in	Name file unit
integer,	intent(in)	::	unit_out	Log file unit

Return Value integer

Value found in name file (or default value)

public function read_name_logical(name_str, default_val, unit_in, unit_out) result(res)

Reads boolean value from name file

Arguments

Type	Intent		Name
character(len=*),	intent(in)	::	name_str	Name of value in name file
logical,	intent(in)	::	default_val	Default value
integer,	intent(in)	::	unit_in	Name file unit
integer,	intent(in)	::	unit_out	Log file unit

Return Value logical

public function read_name_real(name_str, default_val, unit_in, unit_out) result(res)

Reads single precision value from name file

Arguments

Type	Intent		Name
character(len=*),	intent(in)	::	name_str	Name of value in name file
real,	intent(in)	::	default_val	Default value
integer,	intent(in)	::	unit_in	Name file unit
integer,	intent(in)	::	unit_out	Log file unit

Return Value real

Value found in name file (or default value)

read_namefile_routines Module

Contents

Interfaces

Functions

Uses

Used by

Interfaces

private interface read_name

public function read_name_real(name_str, default_val, unit_in, unit_out) result(res)

Arguments

Return Value real

public function read_name_double(name_str, default_val, unit_in, unit_out) result(res)

Arguments

Return Value real(kind=dp)

public function read_name_integer(name_str, default_val, unit_in, unit_out) result(res)

Arguments

Return Value integer

public function read_name_char(name_str, default_val, unit_in, unit_out) result(res)

Arguments

Return Value character(len=:), allocatable

public function read_name_logical(name_str, default_val, unit_in, unit_out) result(res)

Arguments

Return Value logical

Functions

public function read_name_char(name_str, default_val, unit_in, unit_out) result(res)

Arguments

Return Value character(len=:), allocatable

public function read_name_double(name_str, default_val, unit_in, unit_out) result(res)

Arguments

Return Value real(kind=dp)

public function read_name_integer(name_str, default_val, unit_in, unit_out) result(res)

Arguments

Return Value integer

public function read_name_logical(name_str, default_val, unit_in, unit_out) result(res)

Arguments

Return Value logical

public function read_name_real(name_str, default_val, unit_in, unit_out) result(res)

Arguments

Return Value real