derived_inputs::input_nsel Type Reference

Selector definition (interface between input string and back-end predefined integer keys). More...

Public Member Functions
procedure	init (this, name, desc)
procedure	add_option (this, input_key, key, key_desc, by_default)
	Add an option to the selector.
procedure	get_input_index (this, nerrors)
	Look for input key in array (return default if not found).
procedure	apply_to (this, path, var, nerrors)
	Check if selection is valid, export it and set global variable.

Public Attributes
character(len=key_len)	input_key = ''
	Key read from input (must be the first attribute for reading).
character(len=desc_len)	desc = ''
	Selector description.
character(len=name_len)	name = ''
	Output name.
integer	nopts
	Number of available options.
integer, dimension(nopts_max)	keys
	Option keys (unique identifiers).
character(len=key_len), dimension(nopts_max)	input_keys
	Corresponding input strings.
character(len=desc_len), dimension(nopts_max)	key_descs
	Corresponding descriptions.
integer	default_index
	Default option index.

Detailed Description

Selector definition (interface between input string and back-end predefined integer keys).

Member Function/Subroutine Documentation

add_option()

procedure derived_inputs::input_nsel::add_option	(	class(input_nsel), intent(inout)	this,
		character(len=*), intent(in)	input_key,
		integer, intent(in)	key,
		character(len=*), intent(in)	key_desc,
		logical, intent(in), optional	by_default )

Add an option to the selector.

Parameters

[in]	input_key	Key input string
[in]	key	key identifier
[in]	key_desc	Key description
[in]	by_default	Set this key as the default choice

apply_to()

procedure derived_inputs::input_nsel::apply_to	(	class(input_nsel), intent(inout)	this,
		character(len=*), intent(in)	path,
		integer, intent(out)	var,
		integer, intent(inout)	nerrors )

Check if selection is valid, export it and set global variable.

Parameters

[in]	path	Output path in HDF5 file
[out]	var	Global variable to store input value
[in,out]	nerrors	Error counter

get_input_index()

procedure derived_inputs::input_nsel::get_input_index	(	class(input_nsel), intent(in)	this,
		integer, intent(inout), optional	nerrors )

Look for input key in array (return default if not found).

Parameters

[in,out]

nerrors

If present, check for errors and increment counter

init()

procedure derived_inputs::input_nsel::init	(	class(input_nsel), intent(inout)	this,
		character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc )

Member Data Documentation

default_index

integer derived_inputs::input_nsel::default_index

Default option index.

desc

character(len=desc_len) derived_inputs::input_nsel::desc = ''

Selector description.

input_key

character(len=key_len) derived_inputs::input_nsel::input_key = ''

Key read from input (must be the first attribute for reading).

input_keys

character(len=key_len), dimension(nopts_max) derived_inputs::input_nsel::input_keys

Corresponding input strings.

key_descs

character(len=desc_len), dimension(nopts_max) derived_inputs::input_nsel::key_descs

Corresponding descriptions.

keys

integer, dimension(nopts_max) derived_inputs::input_nsel::keys

Option keys (unique identifiers).

name

character(len=name_len) derived_inputs::input_nsel::name = ''

Output name.

nopts

integer derived_inputs::input_nsel::nopts

Number of available options.

---

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

• /home/lanti/src/gkpic/orb5/src/derived_inputs.F90