a wrapper for basic fortran types. More...

Data Types
type	val_p_type
	pointer to a val, to create arrays of pointers More...

type	val_type
	a type to have a wrapper that stores any basic fortran type More...

Functions/Subroutines
subroutine, public	val_create (val, l_val, l_vals, l_vals_ptr, i_val, i_vals, i_vals_ptr, r_val, r_vals, r_vals_ptr, c_val, c_vals, c_vals_ptr, lc_val, lc_vals, lc_vals_ptr, enum)
	creates a keyword value

subroutine, public	val_release (val)
	releases the given val

subroutine, public	val_retain (val)
	retains the given val

subroutine, public	val_get (val, has_l, has_i, has_r, has_lc, has_c, l_val, l_vals, i_val, i_vals, r_val, r_vals, c_val, c_vals, len_c, type_of_var, enum)
	returns the stored values

subroutine, public	val_write (val, unit_nr, unit, unit_str, fmt)
	writes out the values stored in the val

subroutine, public	val_write_internal (val, string, unit)
	Write values to an internal file, i.e. string variable.

subroutine, public	val_duplicate (val_in, val_out)
	creates a copy of the given value

Variables
integer, parameter, public	no_t = 0

integer, parameter, public	logical_t = 1

integer, parameter, public	integer_t = 2

integer, parameter, public	real_t = 3

integer, parameter, public	char_t = 4

integer, parameter, public	enum_t = 5

integer, parameter, public	lchar_t = 6

Detailed Description

a wrapper for basic fortran types.

History: 06.2004 created

Author: fawzi

Function/Subroutine Documentation

◆ val_create()

subroutine, public input_val_types::val_create	(	type(val_type), pointer	val,
		logical, intent(in), optional	l_val,
		logical, dimension(:), intent(in), optional	l_vals,
		logical, dimension(:), optional, pointer	l_vals_ptr,
		integer, intent(in), optional	i_val,
		integer, dimension(:), intent(in), optional	i_vals,
		integer, dimension(:), optional, pointer	i_vals_ptr,
		real(kind=dp), intent(in), optional	r_val,
		real(kind=dp), dimension(:), intent(in), optional	r_vals,
		real(kind=dp), dimension(:), optional, pointer	r_vals_ptr,
		character(len=*), intent(in), optional	c_val,
		character(len=*), dimension(:), intent(in), optional	c_vals,
		character(len=default_string_length), dimension(:), optional, pointer	c_vals_ptr,
		character(len=*), intent(in), optional	lc_val,
		character(len=*), dimension(:), intent(in), optional	lc_vals,
		character(len=default_string_length), dimension(:), optional, pointer	lc_vals_ptr,
		type(enumeration_type), optional, pointer	enum
	)

creates a keyword value

Parameters

val	the object to be created
l_val,i_val,r_val,c_val,lc_val	a logical,integer,real,string, long string to be stored in the val
l_vals,i_vals,r_vals,c_vals	an array of logicals, integers, reals, characters, long strings to be stored in val
l_vals_ptr,i_vals_ptr,r_vals_ptr,c_vals_ptr	an array of logicals, ... to be stored in val, val will get the ownership of the pointer
i_val	...
i_vals	...
i_vals_ptr	...
r_val	...
r_vals	...
r_vals_ptr	...
c_val	...
c_vals	...
c_vals_ptr	...
lc_val	...
lc_vals	...
lc_vals_ptr	...
enum	the enumaration type this value is using

Author: fawzi

Note: using an enumeration only i_val/i_vals/i_vals_ptr are accepted

Definition at line 100 of file input_val_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ val_release()

subroutine, public input_val_types::val_release ( type(val_type), pointer val )

releases the given val

Parameters

val	the val to release

Author: fawzi

Definition at line 261 of file input_val_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ val_retain()

subroutine, public input_val_types::val_retain ( type(val_type), pointer val )

retains the given val

Parameters

val	the val to retain

Author: fawzi

Definition at line 296 of file input_val_types.F.

Here is the caller graph for this function:

◆ val_get()

subroutine, public input_val_types::val_get	(	type(val_type), pointer	val,
		logical, intent(out), optional	has_l,
		logical, intent(out), optional	has_i,
		logical, intent(out), optional	has_r,
		logical, intent(out), optional	has_lc,
		logical, intent(out), optional	has_c,
		logical, intent(out), optional	l_val,
		logical, dimension(:), optional, pointer	l_vals,
		integer, intent(out), optional	i_val,
		integer, dimension(:), optional, pointer	i_vals,
		real(kind=dp), intent(out), optional	r_val,
		real(kind=dp), dimension(:), optional, pointer	r_vals,
		character(len=*), intent(out), optional	c_val,
		character(len=default_string_length), dimension(:), optional, pointer	c_vals,
		integer, intent(out), optional	len_c,
		integer, intent(out), optional	type_of_var,
		type(enumeration_type), optional, pointer	enum
	)

returns the stored values

Parameters

val	the object from which you want to extract the values
has_l	...
has_i	...
has_r	...
has_lc	...
has_c	...
l_val	gets a logical from the val
l_vals	gets an array of logicals from the val
i_val	gets an integer from the val
i_vals	gets an array of integers from the val
r_val	gets a real from the val
r_vals	gets an array of reals from the val
c_val	gets a char from the val
c_vals	gets an array of chars from the val
len_c	len_trim of c_val (if it was a lc_val, of type lchar_t it might be longet than default_string_length)
type_of_var	...
enum	...

Author: fawzi

Note: using an enumeration only i_val/i_vals/i_vals_ptr are accepted add something like ignore_string_cut that if true does not warn if the c_val is too short to contain the string

Definition at line 332 of file input_val_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ val_write()

subroutine, public input_val_types::val_write	(	type(val_type), pointer	val,
		integer, intent(in)	unit_nr,
		type(cp_unit_type), optional, pointer	unit,
		character(len=*), intent(in), optional	unit_str,
		character(len=*), intent(in), optional	fmt
	)

writes out the values stored in the val

Parameters

val	the val to write
unit_nr	the number of the unit to write to
unit	the unit of mesure in which the output should be written (overrides unit_str)
unit_str	the unit of mesure in which the output should be written
fmt	...

Author: fawzi

Note: unit of mesure used only for reals

Definition at line 476 of file input_val_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ val_write_internal()

subroutine, public input_val_types::val_write_internal	(	type(val_type), pointer	val,
		character(len=*), intent(out)	string,
		type(cp_unit_type), optional, pointer	unit
	)

Write values to an internal file, i.e. string variable.

Parameters

val	...
string	...
unit	...

Date: 10.03.2005

History: 17.01.2006, MK, Optional argument unit for the conversion to the external unit added

Author: MK

Version: 1.0

Definition at line 650 of file input_val_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ val_duplicate()

subroutine, public input_val_types::val_duplicate	(	type(val_type), pointer	val_in,
		type(val_type), pointer	val_out
	)

creates a copy of the given value

Parameters

val_in	the value to copy
val_out	the value tha will be created

Author: fawzi

Definition at line 736 of file input_val_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ no_t

integer, parameter, public input_val_types::no_t = 0

Definition at line 41 of file input_val_types.F.

◆ logical_t

integer, parameter, public input_val_types::logical_t = 1

Definition at line 41 of file input_val_types.F.

◆ integer_t

integer, parameter, public input_val_types::integer_t = 2

Definition at line 41 of file input_val_types.F.

◆ real_t

integer, parameter, public input_val_types::real_t = 3

Definition at line 41 of file input_val_types.F.

◆ char_t

integer, parameter, public input_val_types::char_t = 4

Definition at line 41 of file input_val_types.F.

◆ enum_t

integer, parameter, public input_val_types::enum_t = 5

Definition at line 41 of file input_val_types.F.

◆ lchar_t

integer, parameter, public input_val_types::lchar_t = 6

Definition at line 41 of file input_val_types.F.

Data Types

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ val_create()

◆ val_release()

◆ val_retain()

◆ val_get()

◆ val_write()

◆ val_write_internal()

◆ val_duplicate()

Variable Documentation

◆ no_t

◆ logical_t

◆ integer_t

◆ real_t

◆ char_t

◆ enum_t

◆ lchar_t