conversions_mod::conv_to_logical Interface Reference

Converts data types to logical. More...

Private Member Functions
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...

Detailed Description

Converts data types to logical.

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 a logical
copyflag	For generic data only: Whether to use a copy of the structured data or not

Returns

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

Definition at line 69 of file conversions.F90.

Member Function/Subroutine Documentation

generic_to_logical()

logical function, pointer conversions_mod::conv_to_logical::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

integer_to_logical()

logical function conversions_mod::conv_to_logical::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

real_to_logical()

logical function conversions_mod::conv_to_logical::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_to_logical()

logical function conversions_mod::conv_to_logical::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

---

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

• /nfs/a277/earlcd/dev/monc/svn-git/monc/model_core/src/utils/conversions.F90