dc_present Module Reference

Judge optional control parameters. More...

Data Types
interface	present_and_eq
interface	present_and_ne
interface	present_select

Functions/Subroutines
logical function, public	present_and_true (arg)
logical function, public	present_and_false (arg)
logical function, public	present_and_zero (arg)
logical function, public	present_and_nonzero (arg)
logical function, public	present_and_not_empty (arg)

Detailed Description

Judge optional control parameters.

Author

Youhei SASAKI, Yasuhiro MORIKAWA, Eizi TOYODA, Takeshi HORINOUCHI

Copyright

Copyright (C) GFD Dennou Club, 2000-2026. All rights reserved.
License is BSD-2-Clause. see COPYRIGHT in detail

Important

This file is generated from ../../../../src/dc_utils/dc_present.erb by ERB included Ruby 3.3.8. Please do not edit this file directly.

This module provides utility functions for checking optional arguments. These functions check whether an optional argument is present and whether it satisfies certain conditions (true, false, zero, equal to a value, etc.).

Procedures List

Procedure	Description
present_and_true	Returns .true. if arg is present and .true.
present_and_false	Returns .true. if arg is present and .false.
present_and_zero	Returns .true. if arg is present and equals zero
present_and_nonzero	Returns .true. if arg is present and not zero
present_and_eq	Returns .true. if arg is present and equals val
present_and_ne	Returns .true. if arg is present and not equals val
present_and_not_empty	Returns .true. if arg is present and not empty string
present_select	Returns the first valid optional argument or default

Function/Subroutine Documentation

present_and_false()

logical function, public dc_present::present_and_false

(

logical, intent(in), optional

arg

)

Check if arg is present and false

Parameters

[in]

arg

Optional logical argument

Returns

.true. if arg is present and .false., .false. otherwise

Definition at line 127 of file dc_present.f90.

    logical                       :: result
    logical, intent(in), optional :: arg
    continue
    if(present(arg)) then
      if(arg) then
        result=.false.
      else
        result=.true.
      endif
    else
      result=.false.
    endif

present_and_nonzero()

logical function, public dc_present::present_and_nonzero

(

integer, intent(in), optional

arg

)

Check if arg is present and non-zero

Parameters

[in]

arg

Optional integer argument

Returns

.true. if arg is present and not equals zero, .false. otherwise

Definition at line 177 of file dc_present.f90.

    logical                       :: result
    integer, intent(in), optional :: arg
    continue
    if(present(arg)) then
      if(arg==0) then
        result=.false.
      else
        result=.true.
      endif
    else
      result=.false.
    endif

present_and_not_empty()

logical function, public dc_present::present_and_not_empty

(

character(len=*), intent(in), optional

arg

)

Check if arg is present and not empty string

Parameters

[in]

arg

Optional character argument

Returns

.true. if arg is present and not an empty string, .false. otherwise

Definition at line 375 of file dc_present.f90.

    logical                                :: result
    character(len=*), intent(in), optional :: arg
    continue
    result = .false.
    if( present(arg) .AND. (arg .ne. '')) result = .true.

present_and_true()

logical function, public dc_present::present_and_true

(

logical, intent(in), optional

arg

)

Check if arg is present and true

Parameters

[in]

arg

Optional logical argument

Returns

.true. if arg is present and .true., .false. otherwise

Definition at line 102 of file dc_present.f90.

    logical                       :: result
    logical, intent(in), optional :: arg
    continue
    if(present(arg)) then
      if(arg) then
        result=.true.
      else
        result=.false.
      endif
    else
      result=.false.
    endif

present_and_zero()

logical function, public dc_present::present_and_zero

(

integer, intent(in), optional

arg

)

Check if arg is present and zero

Parameters

[in]

arg

Optional integer argument

Returns

.true. if arg is present and equals zero, .false. otherwise

Definition at line 152 of file dc_present.f90.

    logical                       :: result
    integer, intent(in), optional :: arg
    continue
    if(present(arg)) then
      if(arg==0) then
        result=.true.
      else
        result=.false.
      endif
    else
      result=.false.
    endif