conversions_mod Module Reference

Conversion between common inbuilt FORTRAN data types. More...

Data Types
interface	conv_is_integer
	Determines whether a data item can be represented as an integer or not. More...
interface	conv_is_logical
	Determines whether a data item can be represented as a logical or not. More...
interface	conv_is_real
	Determines whether a data item can be represented as a real or not. More...
interface	conv_to_generic
	Converts a data type into the generic (class *) form. More...
interface	conv_to_integer
	Converts data types to integers. More...
interface	conv_to_logical
	Converts data types to logical. More...
interface	conv_to_real
	Converts data types to real. More...
interface	conv_to_string
	Converts data types to strings. More...

Functions/Subroutines
real(kind=double_precision) function, public	conv_single_real_to_double (input_real)
	Converts from a single to double precision real. This applies some rounding to a certain number of decimal places to ignore very small fractions. More...
logical function	string_is_integer (string)
	Determines whether a string is an integer or not. More...
logical function	string_is_real (string)
	Determines whether a string is a real or not. More...
logical function	string_is_logical (string)
	Determines whether a string is a logical or not. More...
character(len=str_length) function, pointer	generic_to_string (generic, makecopy, str_length)
	Converts a generic to a string. More...
character(len=15) function	integer_to_string (input)
	Converts an integer to a string. More...
character(len=30) function	real_single_to_string (input, decimal_places, exponent, exponent_small_numbers)
	Converts a single precision real to a string. More...
character(len=30) function	real_double_to_string (input, decimal_places, exponent, exponent_small_numbers)
	Converts a double precision real to a string. More...
subroutine	limit_to_decimal_places (string_to_parse, decimal_places)
	Helper subroutine which trims the string down to an upper limit of decimal places, with all numbers beyond this point removed. More...
subroutine	trim_trailing_zeros (string_to_parse, zeros_to_retain)
	A helper subroutine which trims training zeros from the string after a decimal place this is to make the string more readable when printed out. More...
character(len=5) function	logical_to_string (input)
	Converts a logical to a string. More...
logical function, pointer	generic_to_logical (generic, makecopy)
	Converts a generic to a logical. More...
logical function	string_to_logical (string)
	Converts a string to a logical. More...
logical function	integer_to_logical (input)
	Converts an integer to a logical. More...
logical function	real_to_logical (input)
	Converts a real to a logical. More...
real(kind=default_precision) function, pointer, public	generic_to_double_real (generic, makecopy)
	Converts a generic to a double real. More...
real function, pointer	generic_to_real (generic, makecopy)
	Converts a generic to a real. If this is infact an integer then will do a conversion and allocate pointed to this. More...
real function	string_to_real (string)
	Converts a string to a real. More...
real function	integer_to_real (input)
	Converts an integer to a real. More...
real function	logical_to_real (input)
	Converts a logical to a real. More...
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...
class(*) function, pointer	string_to_generic (string, makecopy)
	Converts a string into its generic data representation. More...
class(*) function, pointer	integer_to_generic (input, makecopy)
	Converts an integer into its generic data representation. More...
class(*) function, pointer	real_single_to_generic (input, makecopy)
	Converts a single real into its generic data representation. More...
class(*) function, pointer	real_double_to_generic (input, makecopy)
	Converts a double real into its generic data representation. More...
class(*) function, pointer	logical_to_generic (input, makecopy)
	Converts a logical into its generic data representation. More...

Variables
integer, parameter	real_rounding_precision =int(1e8)

Detailed Description

Conversion between common inbuilt FORTRAN data types.

The user will still need to supply conversions between their derived types but this makes it easier when handling common inbuilt type conversions.

Function/Subroutine Documentation

conv_single_real_to_double()

real(kind=double_precision) function, public conversions_mod::conv_single_real_to_double

(

real(kind=single_precision), intent(in)

input_real

)

Converts from a single to double precision real. This applies some rounding to a certain number of decimal places to ignore very small fractions.

Parameters

input_real

The single precision real to convert

Returns

Double precision representation which is smoothed to a specific rounding precision

Definition at line 112 of file conversions.F90.

    real(kind=SINGLE_PRECISION), intent(in) :: input_real

    conv_single_real_to_double=dnint(real(input_real, kind=DEFAULT_PRECISION) * &
         real_rounding_precision) / real_rounding_precision

Here is the caller graph for this function:

generic_to_double_real()

real(kind=default_precision) function, pointer, public conversions_mod::generic_to_double_real	(	class(*), intent(in), pointer	generic,
		logical, intent(in)	makecopy
	)

Converts a generic to a double real.

Parameters

generic	The generic to convert into a double real
makecopy	Whether to use a copy of the generic data or not

Returns

A pointer to the double real or null if generic conversion not possible

Definition at line 402 of file conversions.F90.

    class(*), pointer, intent(in) :: generic
    logical, intent(in) :: makecopy
    real(kind=DEFAULT_PRECISION), pointer :: generic_to_double_real

    select type(generic)
      type is (real(kind=default_precision))
        if (makecopy) then
          allocate(generic_to_double_real, source=generic)
        else
          generic_to_double_real=>generic
        end if
      class default
        generic_to_double_real=>null()
    end select

generic_to_integer()

integer function, pointer conversions_mod::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 482 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

generic_to_logical()

logical function, pointer conversions_mod::generic_to_logical ( class(*), intent(in), pointer  generic, logical, intent(in)  makecopy  )

private

Converts a generic to a logical.

Parameters

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

Returns

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

Definition at line 341 of file conversions.F90.

    class(*), pointer, intent(in) :: generic
    logical, intent(in) :: makecopy
    logical, pointer :: generic_to_logical

    select type(generic)
      type is (logical)
        if (makecopy) then
          allocate(generic_to_logical, source=generic)
        else
          generic_to_logical=>generic
        end if
      class default
        generic_to_logical=>null()
    end select

generic_to_real()

real function, pointer conversions_mod::generic_to_real ( class(*), intent(in), pointer  generic, logical, intent(in)  makecopy  )

private

Converts a generic to a real. If this is infact an integer then will do a conversion and allocate pointed to this.

Parameters

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

Returns

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

Definition at line 423 of file conversions.F90.

    class(*), pointer, intent(in) :: generic
    logical, intent(in) :: makecopy
    real, pointer :: generic_to_real

    select type(generic)
      type is (real)
        if (makecopy) then
          allocate(generic_to_real, source=generic)
        else
          generic_to_real=>generic
        end if
        type is (integer)          
          allocate(generic_to_real)        
          generic_to_real=conv_to_real(generic)        
      class default
        generic_to_real=>null()
    end select

generic_to_string()

character(len=str_length) function, pointer conversions_mod::generic_to_string ( class(*), intent(in), pointer  generic, logical, intent(in)  makecopy, integer, intent(in)  str_length  )

private

Converts a generic to a string.

Parameters

generic	The generic to convert into a string
makecopy	Whether to use a copy of the generic data or not
str_length	Length of the resulting string

Returns

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

Definition at line 171 of file conversions.F90.

    class(*), pointer, intent(in) :: generic
    logical, intent(in) :: makecopy
    integer, intent(in) :: str_length
    character(len=str_length), pointer :: generic_to_string, temporary_generic_ptr

    select type(generic)
      type is (character(len=*))
        if (makecopy) then
          ! Need to do this to enforce string length information
          temporary_generic_ptr=>generic
          allocate(generic_to_string, source=temporary_generic_ptr)
        else
          generic_to_string=>generic
        end if
      class default
        generic_to_string=>null()
    end select

integer_to_generic()

class(*) function, pointer conversions_mod::integer_to_generic ( integer, intent(in), target  input, logical, intent(in)  makecopy  )

private

Converts an integer into its generic data representation.

Parameters

input	The integer to convert into its generic representation
makecopy	Whether make a copy of the underlying data or just return a simple pointer

Returns

A pointer to the generic data

Definition at line 550 of file conversions.F90.

    integer, target , intent(in) :: input
    logical, intent(in) :: makecopy
    class(*), pointer :: integer_to_generic

    if (makecopy) then
      allocate(integer_to_generic, source=input)
    else
      integer_to_generic=>input
    end if

integer_to_logical()

logical function conversions_mod::integer_to_logical ( integer, intent(in)  input )

private

Converts an integer to a logical.

Parameters

input

The integer to convert into a logical

Returns

The logical

Definition at line 375 of file conversions.F90.

    integer, intent(in) :: input

    if (input .ge. 1) then
      integer_to_logical = .true.
    else
      integer_to_logical = .false.
    end if

integer_to_real()

real function conversions_mod::integer_to_real ( integer, intent(in)  input )

private

Converts an integer to a real.

Parameters

input

The integer to convert into a real

Returns

The real

Definition at line 459 of file conversions.F90.

    integer, intent(in) :: input

    integer_to_real = real(input)

integer_to_string()

character(len=15) function conversions_mod::integer_to_string ( integer, intent(in)  input )

private

Converts an integer to a string.

Parameters

input

The integer to convert into a string

Returns

The string of length 15 characters

Definition at line 194 of file conversions.F90.

    integer, intent(in) :: input
    character(len=15) :: integer_to_string

    write(integer_to_string, '(i15)' ) input
    integer_to_string = trim(adjustl(integer_to_string))

limit_to_decimal_places()

subroutine conversions_mod::limit_to_decimal_places ( character(len=*), intent(inout)  string_to_parse, integer, intent(in)  decimal_places  )

private

Helper subroutine which trims the string down to an upper limit of decimal places, with all numbers beyond this point removed.

Parameters

stringToParse	The raw, uncropped, string to processess which is modified
decimalPlaces	Number of decimal places to keep

Definition at line 276 of file conversions.F90.

    character(len=*), intent(inout) :: string_to_parse
    integer, intent(in) :: decimal_places

    integer :: decimal_posn, exp_posn

    string_to_parse=adjustl(string_to_parse)
    decimal_posn=index(string_to_parse, ".")
    exp_posn=index(string_to_parse, "E")
    if (decimal_posn .ne. 0 .and. decimal_posn+decimal_places+1 .le. len(string_to_parse)) then
      if (exp_posn .eq. 0) then
        string_to_parse(decimal_posn+decimal_places+1:)=" "
      else
        string_to_parse(decimal_posn+decimal_places+1:)=string_to_parse(exp_posn:)
        string_to_parse(decimal_posn+decimal_places+1+(len(string_to_parse)-exp_posn)+1:)=" "
      end if
    end if    

Here is the caller graph for this function:

logical_to_generic()

class(*) function, pointer conversions_mod::logical_to_generic ( logical, intent(in), target  input, logical, intent(in)  makecopy  )

private

Converts a logical into its generic data representation.

Parameters

input	The logical to convert into its generic representation
makecopy	Whether make a copy of the underlying data or just return a simple pointer

Returns

A pointer to the generic data

Definition at line 598 of file conversions.F90.

    logical, target, intent(in) :: input
    logical, intent(in) :: makecopy
    class(*), pointer :: logical_to_generic

    if (makecopy) then
      allocate(logical_to_generic, source=input)
    else
      logical_to_generic=>input
    end if

logical_to_integer()

integer function conversions_mod::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 520 of file conversions.F90.

    logical, intent(in) :: input

    if (input) then
      logical_to_integer = 1
    else
      logical_to_integer = 0
    end if

logical_to_real()

real function conversions_mod::logical_to_real ( logical, intent(in)  input )

private

Converts a logical to a real.

Parameters

input

The logical to convert into a real

Returns

The real

Definition at line 468 of file conversions.F90.

    logical, intent(in) :: input

    if (input) then
      logical_to_real = 1.0
    else
      logical_to_real = 0.0
    end if

logical_to_string()

character(len=5) function conversions_mod::logical_to_string ( logical, intent(in)  input )

private

Converts a logical to a string.

Parameters

input

The logical to convert into a string

Returns

The string of length 5 characters

Definition at line 326 of file conversions.F90.

    logical, intent(in) :: input
    character(len=5) :: logical_to_string

    if (input) then
      logical_to_string = "true"
    else
      logical_to_string = "false"
    end if

real_double_to_generic()

class(*) function, pointer conversions_mod::real_double_to_generic ( real(kind=double_precision), intent(in), target  input, logical, intent(in)  makecopy  )

private

Converts a double real into its generic data representation.

Parameters

input	The real to convert into its generic representation
makecopy	Whether make a copy of the underlying data or just return a simple pointer

Returns

A pointer to the generic data

Definition at line 582 of file conversions.F90.

    real(kind=DOUBLE_PRECISION), target, intent(in) :: input
    logical, intent(in) :: makecopy
    class(*), pointer :: real_double_to_generic

    if (makecopy) then
      allocate(real_double_to_generic, source=input)
    else
      real_double_to_generic=>input
    end if

real_double_to_string()

character(len=30) function conversions_mod::real_double_to_string ( real(kind=double_precision), intent(in)  input, integer, optional  decimal_places, logical, optional  exponent, logical, optional  exponent_small_numbers  )

private

Converts a double precision real to a string.

Parameters

input

The real to convert into a string

Returns

The string of length 30 characters

Definition at line 239 of file conversions.F90.

    real(kind=DOUBLE_PRECISION), intent(in) :: input
    character(len=30) :: real_double_to_string
    integer, optional :: decimal_places
    logical, optional :: exponent, exponent_small_numbers

    logical :: transformed
    transformed=.false.

    if (present(exponent)) then
      if (exponent) then
        write(real_double_to_string, '(es30.10)' ) input
        transformed=.true.
      end if
    end if
    if (present(exponent_small_numbers)) then
      if (exponent_small_numbers) then
        write(real_double_to_string, '(g30.10)' ) input
        transformed=.true.
      end if
    end if
    if (.not. transformed) then
      write(real_double_to_string, '(f30.10)' ) input
      if (scan(real_double_to_string, "*") .ne. 0) write(real_double_to_string, '(es30.10)' ) input
    end if
    call trim_trailing_zeros(real_double_to_string, 2)
    if (present(decimal_places)) then
      call limit_to_decimal_places(real_double_to_string, decimal_places)
    end if

    real_double_to_string = trim(adjustl(real_double_to_string))

Here is the call graph for this function:

real_single_to_generic()

class(*) function, pointer conversions_mod::real_single_to_generic ( real(kind=single_precision), intent(in), target  input, logical, intent(in)  makecopy  )

private

Converts a single real into its generic data representation.

Parameters

input	The real to convert into its generic representation
makecopy	Whether make a copy of the underlying data or just return a simple pointer

Returns

A pointer to the generic data

Definition at line 566 of file conversions.F90.

    real(kind=SINGLE_PRECISION), target, intent(in) :: input
    logical, intent(in) :: makecopy
    class(*), pointer :: real_single_to_generic

    if (makecopy) then
      allocate(real_single_to_generic, source=input)
    else
      real_single_to_generic=>input
    end if

real_single_to_string()

character(len=30) function conversions_mod::real_single_to_string ( real(kind=single_precision), intent(in)  input, integer, optional  decimal_places, logical, optional  exponent, logical, optional  exponent_small_numbers  )

private

Converts a single precision real to a string.

Parameters

input

The real to convert into a string

Returns

The string of length 30 characters

Definition at line 205 of file conversions.F90.

    real(kind=SINGLE_PRECISION), intent(in) :: input
    character(len=30) :: real_single_to_string
    integer, optional :: decimal_places
    logical, optional :: exponent, exponent_small_numbers

    logical :: transformed
    transformed=.false.

    if (present(exponent)) then
      if (exponent) then
        write(real_single_to_string, '(es30.10)' ) input
        transformed=.true.
      end if
    end if
    if (present(exponent_small_numbers)) then
      if (exponent_small_numbers) then
        write(real_single_to_string, '(g30.10)' ) input
        transformed=.true.
      end if
    end if
    if (.not. transformed) then
      write(real_single_to_string, '(f30.10)' ) input
      if (scan(real_single_to_string, "*") .ne. 0) write(real_single_to_string, '(es30.10)' ) input
    end if
    call trim_trailing_zeros(real_single_to_string, 2)
    if (present(decimal_places)) call limit_to_decimal_places(real_single_to_string, decimal_places)

    real_single_to_string = trim(adjustl(real_single_to_string))

Here is the call graph for this function:

real_to_integer()

integer function conversions_mod::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 511 of file conversions.F90.

    real, intent(in) :: input

    real_to_integer = int(input)

real_to_logical()

logical function conversions_mod::real_to_logical ( real, intent(in)  input )

private

Converts a real to a logical.

Parameters

input

The real to convert into a logical

Returns

The logical

Definition at line 388 of file conversions.F90.

    real, intent(in) :: input

    if (input .ge. 1.0) then
      real_to_logical = .true.
    else
      real_to_logical = .false.
    end if

string_is_integer()

logical function conversions_mod::string_is_integer ( character(len=*), intent(in)  string )

private

Determines whether a string is an integer or not.

Parameters

string

The string to test

Returns

Logical whether or not the string can be represented as an integer

Definition at line 123 of file conversions.F90.

    character(len=*), intent(in) :: string

    integer :: integer_value, ierr

    if (len(trim(string)) .ne. 0) then
      read(string, '(i10)', iostat=ierr ) integer_value
      string_is_integer = ierr == 0
    else
      string_is_integer=.false.
    end if

string_is_logical()

logical function conversions_mod::string_is_logical ( character(len=*), intent(in)  string )

private

Determines whether a string is a logical or not.

Parameters

string

The string to test

Returns

Logical whether or not the string can be represented as a logical

Definition at line 156 of file conversions.F90.

    character(len=*), intent(in) :: string

    string_is_logical = .false.
    if (trim(adjustl(string)) .eq. "true" .or. trim(adjustl(string)) .eq. "false" .or. &
         trim(adjustl(string)) .eq. ".true." .or. trim(adjustl(string)) .eq. ".false." .or. &
         trim(adjustl(string)) .eq. ".true" .or. trim(adjustl(string)) .eq. "true." .or. &
         trim(adjustl(string)) .eq. ".false" .or. trim(adjustl(string)) .eq. "false.") string_is_logical = .true.

string_is_real()

logical function conversions_mod::string_is_real ( character(len=*), intent(in)  string )

private

Determines whether a string is a real or not.

Parameters

string

The string to test

Returns

Logical whether or not the string can be represented as a real

Definition at line 139 of file conversions.F90.

    character(len=*), intent(in) :: string

    integer :: ierr
    real :: real_value

    if (len(trim(string)) .ne. 0) then
      read(string, '(f10.2)', iostat=ierr ) real_value
      string_is_real = ierr == 0
    else
      string_is_real=.false.
    end if

string_to_generic()

class(*) function, pointer conversions_mod::string_to_generic ( character(len=*), intent(in), target  string, logical, intent(in)  makecopy  )

private

Converts a string into its generic data representation.

Parameters

string	The string to convert into its generic representation
makecopy	Whether make a copy of the underlying data or just return a simple pointer

Returns

A pointer to the generic data

Definition at line 534 of file conversions.F90.

    character(len=*), target, intent(in) :: string
    logical, intent(in) :: makecopy
    class(*), pointer :: string_to_generic

    if (makecopy) then
      allocate(string_to_generic, source=string)
    else
      string_to_generic=>string
    end if

string_to_integer()

integer function conversions_mod::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 502 of file conversions.F90.

    character(len=*), intent(in) :: string

    read(string, '(i15)' ) string_to_integer

string_to_logical()

logical function conversions_mod::string_to_logical ( character(len=*), intent(in)  string )

private

Converts a string to a logical.

Parameters

string

The string to convert into a logical (case sensitive)

Returns

The logical

Definition at line 361 of file conversions.F90.

    character(len=*), intent(in) :: string

    if (trim(adjustl(string)) .eq. "true" .or. trim(adjustl(string)) .eq. ".true." .or. &
         trim(adjustl(string)) .eq. ".true" .or. trim(adjustl(string)) .eq. "true.") then
      string_to_logical = .true.
    else
      string_to_logical = .false.
    end if

string_to_real()

real function conversions_mod::string_to_real ( character(len=*), intent(in)  string )

private

Converts a string to a real.

Parameters

string

The string to convert into a real

Returns

The real

Definition at line 446 of file conversions.F90.

    character(len=*), intent(in) :: string

    if (scan(string, "E") .ne. 0 .or. scan(string, "e") .ne. 0) then
      read(string, '(es30.10)' ) string_to_real
    else
      read(string, '(f10.0)' ) string_to_real
    end if

trim_trailing_zeros()

subroutine conversions_mod::trim_trailing_zeros ( character(len=*), intent(inout)  string_to_parse, integer, intent(in)  zeros_to_retain  )

private

A helper subroutine which trims training zeros from the string after a decimal place this is to make the string more readable when printed out.

Parameters

stringToParse	The string to parse which is modified to replace trailing zeros
zerosToRetain	The number of trailing (after decimal) zeros to retain

Definition at line 299 of file conversions.F90.

    character(len=*), intent(inout) :: string_to_parse
    integer, intent(in) :: zeros_to_retain

    integer :: decimal_posn, i, zero_count, nonzero_hit

    zero_count=0

    decimal_posn=index(string_to_parse, ".")
    if (decimal_posn .ne. 0 .and. decimal_posn .lt. len(string_to_parse)) then
      do i=len(trim(string_to_parse)), decimal_posn, -1
        if (string_to_parse(i:i) .ne. "0") then
          nonzero_hit=i
          exit
        else
          zero_count=zero_count+1
        end if
      end do
      if (zero_count .gt. zeros_to_retain) then
        string_to_parse(nonzero_hit+zeros_to_retain:)=""
      end if
    end if

Here is the caller graph for this function:

Variable Documentation

real_rounding_precision

integer, parameter conversions_mod::real_rounding_precision =int(1e8)

private

Definition at line 14 of file conversions.F90.

  integer, parameter :: real_rounding_precision=int(1e8)