tem_timeControl_reached_max Function

public pure function tem_timeControl_reached_max(me, now) result(at_max)

Returns for each of the time measurements, if the max specification was reached.

An array of logicals of the length tem_time_n_ids is returned, indicating for each measurement, if the max time of the timeControl was reached.

Arguments

Type IntentOptional Attributes Name
type(tem_timeControl_type), intent(in) :: me

Time control to compare agains its max settings.
type(tem_time_type), intent(in) :: now

Current time to compare the max settings to.

Return Value logical, (tem_time_n_ids)

Resulting array indicating for each time definition, if its max setting was reached.


Source Code

  pure function tem_timeControl_reached_max(me, now) result(at_max)
    ! -------------------------------------------------------------------- !
    !> Time control to compare agains its max settings.
    type(tem_timeControl_type), intent(in) :: me

    !> Current time to compare the max settings to.
    type(tem_time_type), intent(in) :: now

    !> Resulting array indicating for each time definition, if its max setting
    !! was reached.
    logical :: at_max(tem_time_n_ids)
    ! -------------------------------------------------------------------- !
    ! -------------------------------------------------------------------- !

    at_max = tem_time_ge_each(now, me%max)

  end function tem_timeControl_reached_max