conversions_mod::conv_to_string Interface Reference

Converts data types to strings. More...

Private Member Functions
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...
character(len=5) function	logical_to_string (input)
	Converts a logical to a string. More...

Detailed Description

Converts data types to strings.

For the generic input then a flag indicating whether to make a copy of the underlying generic data and the length of the resulting string must be specified. For other conversions just the data is needed as the string length is assumed and the returned string does not point to the data provided

Parameters

data	The data to convert into a string
copyflag	For generic data only: Whether to use a copy of the structured data or not
length	For generic data only: Length of the resulting string

Returns

A string. For generic data a pointer to the string or null if generic conversion not possible

Definition at line 38 of file conversions.F90.

Member Function/Subroutine Documentation

generic_to_string()

character(len=str_length) function, pointer conversions_mod::conv_to_string::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 182 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_string()

character(len=15) function conversions_mod::conv_to_string::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 205 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))

logical_to_string()

character(len=5) function conversions_mod::conv_to_string::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 337 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_string()

character(len=30) function conversions_mod::conv_to_string::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 250 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))

real_single_to_string()

character(len=30) function conversions_mod::conv_to_string::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 216 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))

---

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

• model_core/src/utils/conversions.F90