conversions_mod::conv_to_integer Interface Reference

Converts data types to integers. More...

Private Member Functions
integer function, pointer	generic_to_integer (generic, makecopy)
	Converts a generic to an integer. More...
integer function	string_to_integer (string)
	Converts a string to an integer. More...
integer function	real_to_integer (input)
	Converts a real to an integer. More...
integer function	logical_to_integer (input)
	Converts a logical to an integer. More...

Detailed Description

Converts data types to integers.

For the generic input then a flag indicating whether to make a copy of the underlying generic data or not is required. For all other data this copy is made automatically and no flag is required

Parameters

data	The data to convert into an integer
copyflag	For generic data only: Whether to use a copy of the structured data or not

Returns

An integer. For generic data a pointer to the integer or null if generic conversion not possible

Definition at line 49 of file conversions.F90.

Member Function/Subroutine Documentation

generic_to_integer()

integer function, pointer conversions_mod::conv_to_integer::generic_to_integer ( class(*), intent(in), pointer  generic, logical, intent(in)  makecopy  )

private

Converts a generic to an integer.

Parameters

generic	The generic to convert into an integer
makecopy	Whether to use a copy of the generic data or not

Returns

A pointer to the integer or null if generic conversion not possible

Definition at line 493 of file conversions.F90.

    class(*), pointer, intent(in) :: generic
    logical, intent(in) :: makecopy
    integer, pointer :: generic_to_integer
 
    select type(generic)
      type is (integer)
        if (makecopy) then
          allocate(generic_to_integer, source=generic)
        else
          generic_to_integer=>generic
        end if
      class default
        generic_to_integer=>null()
    end select

logical_to_integer()

integer function conversions_mod::conv_to_integer::logical_to_integer ( logical, intent(in)  input )

private

Converts a logical to an integer.

Parameters

input

The logical to convert into an integer

Returns

The integer

Definition at line 531 of file conversions.F90.

    logical, intent(in) :: input
 
    if (input) then
      logical_to_integer = 1
    else
      logical_to_integer = 0
    end if

real_to_integer()

integer function conversions_mod::conv_to_integer::real_to_integer ( real, intent(in)  input )

private

Converts a real to an integer.

Parameters

input

The real to convert into an integer

Returns

The integer

Definition at line 522 of file conversions.F90.

    real, intent(in) :: input
 
    real_to_integer = int(input)

string_to_integer()

integer function conversions_mod::conv_to_integer::string_to_integer ( character(len=*), intent(in)  string )

private

Converts a string to an integer.

Parameters

string

The string to convert into an integer

Returns

The integer

Definition at line 513 of file conversions.F90.

    character(len=*), intent(in) :: string
 
    read(string, '(i15)' ) string_to_integer

---

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

• model_core/src/utils/conversions.F90