time_utils_mod Module Reference

Detailed Description

Set of time utilities for converting between FMS and ESMF time type.

Data Types
interface	esmf2fms_time
	Converts time from FMS to ESMF format. More...
interface	fms2esmf_cal
	Converts calendar from FMS to ESMF format. More...

Functions/Subroutines
type(esmf_calkind_flag) function	fms2esmf_cal_c (calendar)
	Sets fms2esmf_cal_c to the corresponding ESMF calendar type. More...
type(esmf_calkind_flag) function	fms2esmf_cal_i (calendar)
	Sets fms2esmf_cal_i to the corresponding ESMF calendar type. More...
type(time_type) function	esmf2fms_time_t (time)
	Converts date from ESMF format to FMS format. More...
type(time_type) function	esmf2fms_timestep (timestep)
	Converts time-interval from ESMF format to FMS format. More...
type(esmf_time) function, public	fms2esmf_time (time, calkind)
	Converts date from FMS format to ESMF format. More...
type(time_type) function, public	string_to_date (string, rc)
	Converts a string (I4.4,I2.2,I2.2,".",I2.2,I2.2,I2.2) that represents yr, mon, day, hr, min, sec to a FMS data format. More...

Function/Subroutine Documentation

esmf2fms_time_t()

type(time_type) function time_utils_mod::esmf2fms_time_t ( type(esmf_time), intent(in)  time )

private

Converts date from ESMF format to FMS format.

Returns

FMS time structure

Parameters

[in]

time

ESMF time structure

Definition at line 82 of file time_utils.F90.

  type(Time_type)                    :: esmf2fms_time_t !< FMS time structure
  type(ESMF_Time), intent(in)        :: time            !< ESMF time structure
 
  ! Local Variables
  integer                            :: yy, mm, dd, h, m, s
  type(ESMF_CALKIND_FLAG)            :: calkind
 
  integer                            :: rc
 
  call esmf_timeget(time, yy=yy, mm=mm, dd=dd, h=h, m=m, s=s, &
      calkindflag=calkind, rc=rc)
  if (esmf_logfounderror(rctocheck=rc, msg=esmf_logerr_passthru, &
    line=__line__, &
    file=__file__)) &
    return  ! bail out
 
  esmf2fms_time_t = set_date(yy, mm, dd, h, m, s)
 

esmf2fms_timestep()

type(time_type) function time_utils_mod::esmf2fms_timestep ( type(esmf_timeinterval), intent(in)  timestep )

private

Converts time-interval from ESMF format to FMS format.

Returns

FMS time structure

Parameters

[in]

timestep

time-interval following ESMF format [s]

Definition at line 104 of file time_utils.F90.

  type(Time_type)                    :: esmf2fms_timestep !< FMS time structure
  type(ESMF_TimeInterval), intent(in):: timestep          !< time-interval following
                                                          !! ESMF format [s]
  ! Local Variables
  integer                            :: s
  type(ESMF_CALKIND_FLAG)            :: calkind
 
  integer                            :: rc
 
  call esmf_timeintervalget(timestep, s=s, calkindflag=calkind, rc=rc)
  if (esmf_logfounderror(rctocheck=rc, msg=esmf_logerr_passthru, &
    line=__line__, &
    file=__file__)) &
    return  ! bail out
 
  esmf2fms_timestep = set_time(s, 0)
 

fms2esmf_cal_c()

type(esmf_calkind_flag) function time_utils_mod::fms2esmf_cal_c ( character(len=*), intent(in)  calendar )

private

Sets fms2esmf_cal_c to the corresponding ESMF calendar type.

Returns

ESMF calendar type

Parameters

[in]

calendar

Type of calendar

Definition at line 41 of file time_utils.F90.

  type(ESMF_CALKIND_FLAG)            :: fms2esmf_cal_c !< ESMF calendar type
  character(len=*), intent(in)       :: calendar       !< Type of calendar
 
  select case( uppercase(trim(calendar)) )
  case( 'GREGORIAN' )
    fms2esmf_cal_c = esmf_calkind_gregorian
  case( 'JULIAN' )
    fms2esmf_cal_c = esmf_calkind_julian
  case( 'NOLEAP' )
    fms2esmf_cal_c = esmf_calkind_noleap
  case( 'THIRTY_DAY' )
    fms2esmf_cal_c = esmf_calkind_360day
  case( 'NO_CALENDAR' )
    fms2esmf_cal_c = esmf_calkind_nocalendar
  case default
    call mpp_error(fatal, &
    'ocean_solo: ocean_solo_nml entry calendar must be one of GREGORIAN|JULIAN|NOLEAP|THIRTY_DAY|NO_CALENDAR.' )
  end select

fms2esmf_cal_i()

type(esmf_calkind_flag) function time_utils_mod::fms2esmf_cal_i ( integer, intent(in)  calendar )

private

Sets fms2esmf_cal_i to the corresponding ESMF calendar type.

Returns

ESMF calendar structure

Parameters

[in]

calendar

Type of calendar

Definition at line 63 of file time_utils.F90.

  type(ESMF_CALKIND_FLAG)            :: fms2esmf_cal_i !< ESMF calendar structure
  integer, intent(in)                :: calendar       !< Type of calendar
 
  select case(calendar)
    case(thirty_day_months)
      fms2esmf_cal_i = esmf_calkind_360day
    case(gregorian)
      fms2esmf_cal_i = esmf_calkind_gregorian
    case(julian)
      fms2esmf_cal_i = esmf_calkind_julian
    case(noleap)
      fms2esmf_cal_i = esmf_calkind_noleap
    case(no_calendar)
      fms2esmf_cal_i = esmf_calkind_nocalendar
  end select

fms2esmf_time()

type(esmf_time) function, public time_utils_mod::fms2esmf_time	(	type(time_type), intent(in)	time,
		type(esmf_calkind_flag), intent(in), optional	calkind
	)

Converts date from FMS format to ESMF format.

Returns

ESMF time structure

Parameters

[in]	time	FMS time structure
[in]	calkind	ESMF calendar structure

Definition at line 125 of file time_utils.F90.

  type(ESMF_Time)                    :: fms2esmf_time !< ESMF time structure
  type(time_type), intent(in)        :: time          !< FMS time structure
  type(ESMF_CALKIND_FLAG), intent(in), optional :: calkind !< ESMF calendar structure
 
  ! Local Variables
  integer                            :: yy, mm, d, h, m, s
  type(ESMF_CALKIND_FLAG)            :: l_calkind
 
  integer                            :: rc
 
  if(present(calkind)) then
    l_calkind = calkind
  else
    l_calkind = fms2esmf_cal(fms_get_calendar_type())
  endif
 
  call get_date(time, yy, mm, d, h, m, s)
 
  call esmf_timeset(fms2esmf_time, yy=yy, mm=mm, d=d, h=h, m=m, s=s, &
      calkindflag=l_calkind, rc=rc)
  if (esmf_logfounderror(rctocheck=rc, msg=esmf_logerr_passthru, &
    line=__line__, &
    file=__file__)) &
    return  ! bail out
 

string_to_date()

type(time_type) function, public time_utils_mod::string_to_date	(	character(len=15), intent(in)	string,
		integer, intent(out), optional	rc
	)

Converts a string (I4.4,I2.2,I2.2,".",I2.2,I2.2,I2.2) that represents yr, mon, day, hr, min, sec to a FMS data format.

Parameters

[in]	string	String representing a date
[out]	rc	ESMF error handler

Returns

FMS time structure

Definition at line 155 of file time_utils.F90.

  character(len=15), intent(in)           :: string        !< String representing a date
  integer, intent(out), optional          :: rc            !< ESMF error handler
  type(time_type)                         :: string_to_date!< FMS time structure
 
  ! Local variables
  integer                                 :: yr,mon,day,hr,min,sec
 
  if(present(rc)) rc = esmf_success
 
  read(string, '(I4.4,I2.2,I2.2,".",I2.2,I2.2,I2.2)') yr, mon, day, hr, min, sec
  string_to_date = set_date(yr, mon, day, hr, min, sec)