D.3.4 Initialized_Base_Structure Procedure

The main documentation of the Initialized_Base_Structure Procedure contains additional explanation of this code listing.

  function Initialized_Base_Structure (Structure) result(Initialized)

    ! Use associations.

    use Caesar_Flags_Module, only: initialized_flag

    ! Input variable.

    ! Base_Structure to be checked.
    type(Base_Structure_type), intent(in) :: Structure

    ! Output variable.

    type(logical) :: Initialized          ! Initialized condition boolean.

    !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    ! Verify requirements - none.

    ! Set initialized boolean.

    Initialized = Structure%Initialized == initialized_flag

    ! Verify guarantees - none.

    return
  end function Initialized_Base_Structure