CRTM_Options_Define.f90

Go to the documentation of this file.

!
! CRTM_Options_Define
!
! Module defining the CRTM Options optional argument data structure
! and containing routines to manipulate it.
!
!
! CREATION HISTORY:
!       Written by:     Paul van Delst, 25-Sep-2004
!                       paul.vandelst@noaa.gov
!

MODULE crtm_options_define

  ! ------------------
  ! Environment set up
  ! ------------------
  ! Module use statements
  USE type_kinds           , ONLY: fp, long, double
  USE message_handler      , ONLY: success, failure, warning, information, display_message
  USE compare_float_numbers, ONLY: OPERATOR(.equalto.)
  USE file_utility         , ONLY: file_open, file_exists
  USE binary_file_utility  , ONLY: open_binary_file        , &
                                   writegatts_binary_file  , &
                                   readgatts_binary_file   , &
                                   writelogical_binary_file, &
                                   readlogical_binary_file
  USE crtm_parameters      , ONLY: rt_ada
  USE ssu_input_define     , ONLY: ssu_input_type, &
                                   OPERATOR(==), &
                                   ssu_input_isvalid, &
                                   ssu_input_inspect, &
                                   ssu_input_getvalue, &
                                   ssu_input_setvalue, &
                                   ssu_input_readfile, &
                                   ssu_input_writefile
  USE zeeman_input_define  , ONLY: zeeman_input_type, &
                                   OPERATOR(==), &
                                   zeeman_input_isvalid, &
                                   zeeman_input_inspect, &
                                   zeeman_input_getvalue, &
                                   zeeman_input_setvalue, &
                                   zeeman_input_readfile, &
                                   zeeman_input_writefile
  ! Disable implicit typing
  IMPLICIT NONE


  ! ------------
  ! Visibilities
  ! ------------
  ! Everything private by default
  PRIVATE
  ! Datatypes
  PUBLIC :: crtm_options_type
  ! Operators
  PUBLIC :: OPERATOR(==)
  ! Public procedures
  PUBLIC :: crtm_options_associated
  PUBLIC :: crtm_options_destroy
  PUBLIC :: crtm_options_create
  PUBLIC :: crtm_options_isvalid
  PUBLIC :: crtm_options_inspect
  PUBLIC :: crtm_options_defineversion
  PUBLIC :: crtm_options_inquirefile
  PUBLIC :: crtm_options_readfile
  PUBLIC :: crtm_options_writefile
  ! ...Inherited procedures
  PUBLIC :: ssu_input_getvalue
  PUBLIC :: ssu_input_setvalue
  PUBLIC :: zeeman_input_getvalue
  PUBLIC :: zeeman_input_setvalue



  ! -------------------
  ! Procedure overloads
  ! -------------------
  INTERFACE OPERATOR(==)
    MODULE PROCEDURE crtm_options_equal
  END INTERFACE OPERATOR(==)


  ! -----------------
  ! Module parameters
  ! -----------------
  CHARACTER(*), PRIVATE, PARAMETER :: module_version_id = &
  '$Id: CRTM_Options_Define.f90 60152 2015-08-13 19:19:13Z paul.vandelst@noaa.gov $'
  ! Literal constants
  REAL(Double), PARAMETER :: zero = 0.0_double
  REAL(Double), PARAMETER :: one  = 1.0_double
  ! Integer "logicals" for I/O
  INTEGER(Long), PARAMETER :: false = 0_long
  INTEGER(Long), PARAMETER :: true  = 1_long
  ! Message string length
  INTEGER, PARAMETER :: ml = 256
  ! File status on close after write error
  CHARACTER(*), PARAMETER :: write_error_status = 'DELETE'


  ! ----------------------------
  ! Options data type definition
  ! ----------------------------
  !:tdoc+:
  TYPE :: crtm_options_type
    ! Allocation indicator
    LOGICAL :: is_allocated = .false.

    ! Input checking on by default
    LOGICAL :: check_input = .true.

    ! User defined MW water emissivity algorithm
    LOGICAL :: use_old_mwssem = .false.

    ! Antenna correction application
    LOGICAL :: use_antenna_correction = .false.

    ! NLTE radiance correction is ON by default
    LOGICAL :: apply_nlte_correction = .true.

    ! RT Algorithm is set to ADA by default
    INTEGER(Long) :: rt_algorithm_id = rt_ada

    ! Aircraft flight level pressure
    ! Value > 0 turns "on" the aircraft option
    REAL(Double) :: aircraft_pressure = -one

    ! User defined number of RT solver streams (streams up + streams down)
    LOGICAL       :: use_n_streams = .false.
    INTEGER(Long) :: n_streams = 0

    ! Scattering switch. Default is for
    ! Cloud/Aerosol scattering to be included.
    LOGICAL :: include_scattering = .true.

    ! User defined emissivity/reflectivity
    ! ...Dimensions
    INTEGER(Long) :: n_channels = 0  ! L dimension
    ! ...Index into channel-specific components
    INTEGER(Long) :: channel = 0
    ! ...Emissivity optional arguments
    LOGICAL :: use_emissivity = .false.
    REAL(Double), ALLOCATABLE :: emissivity(:)  ! L
    ! ...Direct reflectivity optional arguments
    LOGICAL :: use_direct_reflectivity = .false.
    REAL(Double), ALLOCATABLE :: direct_reflectivity(:) ! L

    ! SSU instrument input
    TYPE(ssu_input_type) :: ssu

    ! Zeeman-splitting input
    TYPE(zeeman_input_type) :: zeeman
  END TYPE crtm_options_type
  !:tdoc-:


CONTAINS


!################################################################################
!################################################################################
!##                                                                            ##
!##                         ## PUBLIC MODULE ROUTINES ##                       ##
!##                                                                            ##
!################################################################################
!################################################################################

!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       CRTM_Options_Associated
!
! PURPOSE:
!       Elemental function to test the status of the allocatable components
!       of a CRTM Options object.
!
! CALLING SEQUENCE:
!       Status = CRTM_Options_Associated( Options )
!
! OBJECTS:
!       Options:      Options structure which is to have its member's
!                     status tested.
!                     UNITS:      N/A
!                     TYPE:       CRTM_Options_type
!                     DIMENSION:  Scalar or any rank
!                     ATTRIBUTES: INTENT(IN)
!
! FUNCTION RESULT:
!       Status:       The return value is a logical value indicating the
!                     status of the Options members.
!                       .TRUE.  - if the array components are allocated.
!                       .FALSE. - if the array components are not allocated.
!                     UNITS:      N/A
!                     TYPE:       LOGICAL
!                     DIMENSION:  Same as input Options argument
!
!:sdoc-:
!--------------------------------------------------------------------------------

  ELEMENTAL FUNCTION crtm_options_associated( self ) RESULT( Status )
    TYPE(crtm_options_type), INTENT(IN) :: self
    LOGICAL :: status
    status = self%Is_Allocated
  END FUNCTION crtm_options_associated


!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       CRTM_Options_Destroy
!
! PURPOSE:
!       Elemental subroutine to re-initialize CRTM Options objects.
!
! CALLING SEQUENCE:
!       CALL CRTM_Options_Destroy( Options )
!
! OBJECTS:
!       Options:      Re-initialized Options structure.
!                     UNITS:      N/A
!                     TYPE:       CRTM_Options_type
!                     DIMENSION:  Scalar OR any rank
!                     ATTRIBUTES: INTENT(OUT)
!
!:sdoc-:
!--------------------------------------------------------------------------------

  ELEMENTAL SUBROUTINE crtm_options_destroy( self )
    TYPE(crtm_options_type), INTENT(OUT) :: self
    self%Is_Allocated = .false.
  END SUBROUTINE crtm_options_destroy


!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       CRTM_Options_Create
!
! PURPOSE:
!       Elemental subroutine to create an instance of the CRTM Options object.
!
! CALLING SEQUENCE:
!       CALL CRTM_Options_Create( Options, n_Channels )
!
! OBJECTS:
!       Options:      Options structure.
!                     UNITS:      N/A
!                     TYPE:       CRTM_Options_type
!                     DIMENSION:  Scalar or any rank
!                     ATTRIBUTES: INTENT(OUT)
!
! INPUTS:
!       n_Channels:   Number of channels for which there is Options data.
!                     Must be > 0.
!                     This dimension only applies to the emissivity-related
!                     components.
!                     UNITS:      N/A
!                     TYPE:       INTEGER
!                     DIMENSION:  Same as Options object
!                     ATTRIBUTES: INTENT(IN)
!
!:sdoc-:
!--------------------------------------------------------------------------------

  ELEMENTAL SUBROUTINE crtm_options_create( self, n_Channels )
    ! Arguments
    TYPE(crtm_options_type), INTENT(OUT) :: self
    INTEGER,                 INTENT(IN)  :: n_channels
    ! Local variables
    INTEGER :: alloc_stat

    ! Check input
    IF ( n_channels < 1 ) RETURN

    ! Perform the allocation
    ALLOCATE( self%Emissivity(n_channels), &
              self%Direct_Reflectivity(n_channels), &
              stat = alloc_stat )
    IF ( alloc_stat /= 0 ) RETURN

    ! Initialise
    ! ...Dimensions
    self%n_Channels = n_channels
    ! ...Arrays
    self%Emissivity          = zero
    self%Direct_Reflectivity = zero

    ! Set allocation indicator
    self%Is_Allocated = .true.

  END SUBROUTINE crtm_options_create


!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       CRTM_Options_IsValid
!
! PURPOSE:
!       Non-pure function to perform some simple validity checks on a
!       CRTM Options object.
!
!       If invalid data is found, a message is printed to stdout.
!
! CALLING SEQUENCE:
!       result = CRTM_Options_IsValid( opt )
!
!         or
!
!       IF ( CRTM_Options_IsValid( opt ) ) THEN....
!
! OBJECTS:
!       opt:       CRTM Options object which is to have its
!                  contents checked.
!                  UNITS:      N/A
!                  TYPE:       CRTM_Options_type
!                  DIMENSION:  Scalar
!                  ATTRIBUTES: INTENT(IN)
!
! FUNCTION RESULT:
!       result:    Logical variable indicating whether or not the input
!                  passed the check.
!                  If == .FALSE., Options object is unused or contains
!                                 invalid data.
!                     == .TRUE.,  Options object can be used in CRTM.
!                  UNITS:      N/A
!                  TYPE:       LOGICAL
!                  DIMENSION:  Scalar
!
!:sdoc-:
!--------------------------------------------------------------------------------

  FUNCTION crtm_options_isvalid( self ) RESULT( IsValid )
    TYPE(crtm_options_type), INTENT(IN) :: self
    LOGICAL :: isvalid
    CHARACTER(*), PARAMETER :: routine_name = 'CRTM_Options_IsValid'
    CHARACTER(ML) :: msg

    ! Setup
    isvalid = .true.

    ! Check emissivity options
    IF ( self%Use_Emissivity .OR. self%Use_Direct_Reflectivity ) THEN
      isvalid = crtm_options_associated(self)
      IF ( .NOT. isvalid ) THEN
        msg = 'Options structure not allocated'
        CALL display_message( routine_name, trim(msg), information )
        RETURN
      ENDIF
      IF ( self%Use_Emissivity ) THEN
        IF ( any(self%Emissivity < zero) .OR. any(self%Emissivity > one) ) THEN
          msg = 'Invalid emissivity'
          CALL display_message( routine_name, trim(msg), information )
          isvalid = .false.
        END IF
      END IF
      IF ( self%Use_Direct_Reflectivity ) THEN
        IF ( any(self%Direct_Reflectivity < zero) .OR. any(self%Direct_Reflectivity > one) ) THEN
          msg = 'Invalid direct reflectivity'
          CALL display_message( routine_name, trim(msg), information )
          isvalid = .false.
        END IF
      END IF
    END IF

    ! Check SSU input options
    isvalid = ssu_input_isvalid( self%SSU ) .AND. isvalid

    ! Check Zeeman input options
    isvalid = zeeman_input_isvalid( self%Zeeman ) .AND. isvalid

  END FUNCTION crtm_options_isvalid


!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       CRTM_Options_Inspect
!
! PURPOSE:
!       Subroutine to print the contents of a CRTM Options object to stdout.
!
! CALLING SEQUENCE:
!       CALL CRTM_Options_Inspect( Options )
!
! INPUTS:
!       Options:       CRTM Options object to display.
!                      UNITS:      N/A
!                      TYPE:       CRTM_Options_type
!                      DIMENSION:  Scalar
!                      ATTRIBUTES: INTENT(IN)
!
!:sdoc-:
!--------------------------------------------------------------------------------

  SUBROUTINE crtm_options_inspect( self )
    TYPE(crtm_options_type), INTENT(IN) :: self
    WRITE(*,'(1x,"Options OBJECT")')
    ! Display components
    WRITE(*,'(3x,"Check input flag            :",1x,l1)') self%Check_Input
    WRITE(*,'(3x,"Use old MWSSEM flag         :",1x,l1)') self%Use_Old_MWSSEM
    WRITE(*,'(3x,"Use antenna correction flag :",1x,l1)') self%Use_Antenna_Correction
    WRITE(*,'(3x,"Apply NLTE correction flag  :",1x,l1)') self%Apply_NLTE_Correction
    WRITE(*,'(3x,"Aircraft pressure altitude  :",1x,es13.6)') self%Aircraft_Pressure
    WRITE(*,'(3x,"RT algorithm Id             :",1x,i0)') self%RT_Algorithm_Id
    WRITE(*,'(3x,"Include scattering flag     :",1x,l1)') self%Include_Scattering
    WRITE(*,'(3x,"Use n_Streams flag          :",1x,l1)') self%Use_N_Streams
    WRITE(*,'(3x,"n_Streams                   :",1x,i0)') self%n_Streams
    ! ...Emissivity component
    IF ( crtm_options_associated(self) ) THEN
      WRITE(*,'(3x,"Emissivity component")')
      WRITE(*,'(5x,"n_Channels                   :",1x,i0)') self%n_Channels
      WRITE(*,'(5x,"Channel index                :",1x,i0)') self%Channel
      WRITE(*,'(5x,"Use emissivity flag          :",1x,l1)') self%Use_Emissivity
      WRITE(*,'(5x,"Use direct reflectivity flag :",1x,l1)') self%Use_Direct_Reflectivity
      WRITE(*,'(5x,"Emissivity :")')
      WRITE(*,'(5(1x,es13.6,:))') self%Emissivity
      WRITE(*,'(5x,"Direct reflectivity :")')
      WRITE(*,'(5(1x,es13.6,:))') self%Direct_Reflectivity
    END IF
    ! ...SSU input
    CALL ssu_input_inspect( self%SSU )
    ! ...Zeeman input
    CALL zeeman_input_inspect( self%Zeeman )

  END SUBROUTINE crtm_options_inspect


!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       CRTM_Options_DefineVersion
!
! PURPOSE:
!       Subroutine to return the module version information.
!
! CALLING SEQUENCE:
!       CALL CRTM_Options_DefineVersion( Id )
!
! OUTPUTS:
!       Id:            Character string containing the version Id information
!                      for the module.
!                      UNITS:      N/A
!                      TYPE:       CHARACTER(*)
!                      DIMENSION:  Scalar
!                      ATTRIBUTES: INTENT(OUT)
!
!:sdoc-:
!--------------------------------------------------------------------------------

  SUBROUTINE crtm_options_defineversion( Id )
    CHARACTER(*), INTENT(OUT) :: id
    id = module_version_id
  END SUBROUTINE crtm_options_defineversion


!------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       CRTM_Options_InquireFile
!
! PURPOSE:
!       Function to inquire CRTM Options object files.
!
! CALLING SEQUENCE:
!       Error_Status = CRTM_Options_InquireFile( &
!                        Filename               , &
!                        n_Profiles = n_Profiles  )
!
! INPUTS:
!       Filename:       Character string specifying the name of a
!                       CRTM Options data file to read.
!                       UNITS:      N/A
!                       TYPE:       CHARACTER(*)
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(IN)
!
! OPTIONAL OUTPUTS:
!       n_Profiles:     The number of profiles in the data file.
!                       UNITS:      N/A
!                       TYPE:       INTEGER
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: OPTIONAL, INTENT(OUT)
!
! FUNCTION RESULT:
!       Error_Status:   The return value is an integer defining the error status.
!                       The error codes are defined in the Message_Handler module.
!                       If == SUCCESS, the file inquire was successful
!                          == FAILURE, an unrecoverable error occurred.
!                       UNITS:      N/A
!                       TYPE:       INTEGER
!                       DIMENSION:  Scalar
!
!:sdoc-:
!------------------------------------------------------------------------------

  FUNCTION crtm_options_inquirefile( &
    Filename   , &  ! Input
    n_Profiles ) &  ! Optional output
  result( err_stat )
    ! Arguments
    CHARACTER(*),           INTENT(IN)  :: filename
    INTEGER     , OPTIONAL, INTENT(OUT) :: n_profiles
    ! Function result
    INTEGER :: err_stat
    ! Function parameters
    CHARACTER(*), PARAMETER :: routine_name = 'CRTM_Options_InquireFile'
    ! Function variables
    CHARACTER(ML) :: msg
    CHARACTER(ML) :: io_msg
    INTEGER :: io_stat
    INTEGER :: fid
    INTEGER :: m

    ! Set up
    err_stat = success
    ! ...Check that the file exists
    IF ( .NOT. file_exists( trim(filename) ) ) THEN
      msg = 'File '//trim(filename)//' not found.'
      CALL inquire_cleanup(); RETURN
    END IF


    ! Open the file
    err_stat = open_binary_file( filename, fid )
    IF ( err_stat /= success ) THEN
      msg = 'Error opening '//trim(filename)
      CALL inquire_cleanup(); RETURN
    END IF


    ! Read the number of profiles dimension
    READ( fid, iostat=io_stat,iomsg=io_msg ) m
    IF ( io_stat /= 0 ) THEN
      msg = 'Error reading dimensions from '//trim(filename)//' - '//trim(io_msg)
      CALL inquire_cleanup(); RETURN
    END IF


    ! Close the file
    CLOSE( fid,iostat=io_stat,iomsg=io_msg )
    IF ( io_stat /= 0 ) THEN
      msg = 'Error closing '//trim(filename)//' - '//trim(io_msg)
      CALL inquire_cleanup(); RETURN
    END IF


    ! Set the optional return arguments
    IF ( PRESENT(n_profiles) ) n_profiles = m

  CONTAINS

    SUBROUTINE inquire_cleanup()
      IF ( file_open(fid) ) THEN
        CLOSE( fid,iostat=io_stat,iomsg=io_msg )
        IF ( io_stat /= success ) &
          msg = trim(msg)//'; Error closing input file during error cleanup - '//trim(io_msg)
      END IF
      err_stat = failure
      CALL display_message( routine_name, msg, err_stat )
    END SUBROUTINE inquire_cleanup

  END FUNCTION crtm_options_inquirefile


!------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       CRTM_Options_ReadFile
!
! PURPOSE:
!       Function to read CRTM Options object files.
!
! CALLING SEQUENCE:
!       Error_Status = CRTM_Options_ReadFile( &
!                        Filename               , &
!                        Options                , &
!                        Quiet      = Quiet     , &
!                        n_Profiles = n_Profiles  )
!
! INPUTS:
!       Filename:     Character string specifying the name of an
!                     Options format data file to read.
!                     UNITS:      N/A
!                     TYPE:       CHARACTER(*)
!                     DIMENSION:  Scalar
!                     ATTRIBUTES: INTENT(IN)
!
! OUTPUTS:
!       Options:      CRTM Options object array containing the Options
!                     data.
!                     UNITS:      N/A
!                     TYPE:       CRTM_Options_type
!                     DIMENSION:  Rank-1 (n_Profiles)
!                     ATTRIBUTES: INTENT(OUT)
!
! OPTIONAL INPUTS:
!       Quiet:        Set this logical argument to suppress INFORMATION
!                     messages being printed to stdout
!                     If == .FALSE., INFORMATION messages are OUTPUT [DEFAULT].
!                        == .TRUE.,  INFORMATION messages are SUPPRESSED.
!                     If not specified, default is .FALSE.
!                     UNITS:      N/A
!                     TYPE:       LOGICAL
!                     DIMENSION:  Scalar
!                     ATTRIBUTES: INTENT(IN), OPTIONAL
!
! OPTIONAL OUTPUTS:
!       n_Profiles:   The number of profiles for which data was read.
!                     UNITS:      N/A
!                     TYPE:       INTEGER
!                     DIMENSION:  Scalar
!                     ATTRIBUTES: OPTIONAL, INTENT(OUT)
!
!
! FUNCTION RESULT:
!       Error_Status: The return value is an integer defining the error status.
!                     The error codes are defined in the Message_Handler module.
!                     If == SUCCESS, the file read was successful
!                        == FAILURE, an unrecoverable error occurred.
!                     UNITS:      N/A
!                     TYPE:       INTEGER
!                     DIMENSION:  Scalar
!
!:sdoc-:
!------------------------------------------------------------------------------

  FUNCTION crtm_options_readfile( &
    Filename  , &  ! Input
    Options   , &  ! Output
    Quiet     , &  ! Optional input
    n_Profiles, &  ! Optional output
    Debug     ) &  ! Optional input (Debug output control)
  result( err_stat )
    ! Arguments
    CHARACTER(*),            INTENT(IN)  :: filename
    TYPE(crtm_options_type), INTENT(OUT) :: options(:)  ! n_Profiles
    LOGICAL,       OPTIONAL, INTENT(IN)  :: quiet
    INTEGER,       OPTIONAL, INTENT(OUT) :: n_profiles
    LOGICAL,       OPTIONAL, INTENT(IN)  :: debug
    ! Function result
    INTEGER :: err_stat
    ! Function parameters
    CHARACTER(*), PARAMETER :: routine_name = 'CRTM_Options_ReadFile'
    ! Function variables
    CHARACTER(ML) :: msg
    CHARACTER(ML) :: io_msg
    INTEGER :: io_stat
    LOGICAL :: noisy
    INTEGER :: fid
    INTEGER :: m, n_file_profiles, n_input_profiles


    ! Set up
    err_stat = success
    ! ...Check Quiet argument
    noisy = .true.
    IF ( PRESENT(quiet) ) noisy = .NOT. quiet
    ! ...Override Quiet settings if debug set.
    IF ( PRESENT(debug) ) noisy = debug
    ! ...Check that the file exists
    IF ( .NOT. file_exists( trim(filename) ) ) THEN
      msg = 'File '//trim(filename)//' not found.'
      CALL read_cleanup(); RETURN
    END IF


    ! Open the file
    err_stat = open_binary_file( filename, fid )
    IF ( err_stat /= success ) THEN
      msg = 'Error opening '//trim(filename)
      CALL read_cleanup(); RETURN
    END IF


    ! Read the dimensions
    READ( fid,iostat=io_stat,iomsg=io_msg ) n_file_profiles
    IF ( io_stat /= 0 ) THEN
      msg = 'Error reading dimensions from '//trim(filename)//' - '//trim(io_msg)
      CALL read_cleanup(); RETURN
    END IF
    ! ...Check if n_Profiles in file is > size of output array
    n_input_profiles = SIZE(options)
    IF ( n_file_profiles > n_input_profiles ) THEN
      WRITE( msg,'("Number of profiles, ",i0,", > size of the output Options", &
                  &" array, ",i0,". Only the first ",i0, &
                  &" profiles will be read.")' ) &
                  n_file_profiles, n_input_profiles, n_input_profiles
      CALL display_message( routine_name, msg, warning )
    END IF
    n_input_profiles = min(n_input_profiles, n_file_profiles)


    ! Loop over all the profiles
    profile_loop: DO m = 1, n_input_profiles
      err_stat = read_record( fid, options(m), &
                              quiet = quiet, &
                              debug = debug  )
      IF ( err_stat /= success ) THEN
        WRITE( msg,'("Error reading Options element (",i0,") from ",a)' ) m, trim(filename)
        CALL read_cleanup(); RETURN
      END IF
    END DO profile_loop


    ! Close the file
    CLOSE( fid,iostat=io_stat,iomsg=io_msg )
    IF ( io_stat /= 0 ) THEN
      msg = 'Error closing '//trim(filename)//' - '//trim(io_msg)
      CALL read_cleanup(); RETURN
    END IF


    ! Set the optional return values
    IF ( PRESENT(n_profiles) ) n_profiles = n_input_profiles


    ! Output an info message
    IF ( noisy ) THEN
      WRITE( msg,'("Number of profiles read from ",a,": ",i0)' ) trim(filename), n_input_profiles
      CALL display_message( routine_name, msg, information )
    END IF

  CONTAINS

    SUBROUTINE read_cleanup()
      IF ( file_open( filename ) ) THEN
        CLOSE( fid,iostat=io_stat,iomsg=io_msg )
        IF ( io_stat /= 0 ) &
          msg = trim(msg)//'; Error closing input file during error cleanup - '//trim(io_msg)
      END IF
      CALL crtm_options_destroy( options )
      err_stat = failure
      CALL display_message( routine_name, msg, err_stat )
    END SUBROUTINE read_cleanup

  END FUNCTION crtm_options_readfile


!------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       CRTM_Options_WriteFile
!
! PURPOSE:
!       Function to write CRTM Options object files.
!
! CALLING SEQUENCE:
!       Error_Status = CRTM_Options_WriteFile( Filename     , &
!                                              Options      , &
!                                              Quiet = Quiet  )
!
! INPUTS:
!       Filename:     Character string specifying the name of the
!                     Options format data file to write.
!                     UNITS:      N/A
!                     TYPE:       CHARACTER(*)
!                     DIMENSION:  Scalar
!                     ATTRIBUTES: INTENT(IN)
!
!       Options:      CRTM Options object array containing the Options
!                     data.
!                     UNITS:      N/A
!                     TYPE:       CRTM_Options_type
!                     DIMENSION:  Rank-1 (n_Profiles)
!                     ATTRIBUTES: INTENT(IN)
!
! OPTIONAL INPUTS:
!       Quiet:        Set this logical argument to suppress INFORMATION
!                     messages being printed to stdout
!                     If == .FALSE., INFORMATION messages are OUTPUT [DEFAULT].
!                        == .TRUE.,  INFORMATION messages are SUPPRESSED.
!                     If not specified, default is .FALSE.
!                     UNITS:      N/A
!                     TYPE:       LOGICAL
!                     DIMENSION:  Scalar
!                     ATTRIBUTES: INTENT(IN), OPTIONAL
!
! FUNCTION RESULT:
!       Error_Status: The return value is an integer defining the error status.
!                     The error codes are defined in the Message_Handler module.
!                     If == SUCCESS, the file write was successful
!                        == FAILURE, an unrecoverable error occurred.
!                     UNITS:      N/A
!                     TYPE:       INTEGER
!                     DIMENSION:  Scalar
!
! SIDE EFFECTS:
!       - If the output file already exists, it is overwritten.
!       - If an error occurs during *writing*, the output file is deleted before
!         returning to the calling routine.
!
!:sdoc-:
!------------------------------------------------------------------------------

  FUNCTION crtm_options_writefile( &
    Filename, &  ! Input
    Options , &  ! Input
    Quiet   , &  ! Optional input
    Debug   ) &  ! Optional input (Debug output control)
  result( err_stat )
    ! Arguments
    CHARACTER(*),            INTENT(IN) :: filename
    TYPE(crtm_options_type), INTENT(IN) :: options(:)  ! n_Profiles
    LOGICAL,       OPTIONAL, INTENT(IN) :: quiet
    LOGICAL,       OPTIONAL, INTENT(IN) :: debug
    ! Function result
    INTEGER :: err_stat
    ! Function parameters
    CHARACTER(*), PARAMETER :: routine_name = 'CRTM_Options_WriteFile'
    ! Function variables
    CHARACTER(ML) :: msg
    CHARACTER(ML) :: io_msg
    INTEGER :: io_stat
    LOGICAL :: noisy
    INTEGER :: fid
    INTEGER :: m, n_output_profiles

    ! Setup
    err_stat = success
    ! ...Check Quiet argument
    noisy = .true.
    IF ( PRESENT(quiet) ) noisy = .NOT. quiet
    ! ...Override Quiet settings if debug set.
    IF ( PRESENT(debug) ) noisy = debug


    ! Any valid profiles?
    n_output_profiles = SIZE(options)
    IF ( n_output_profiles == 0 ) THEN
      msg = 'Zero dimension profiles in input!'
      CALL write_cleanup(); RETURN
    END IF


    ! Open the file
    err_stat = open_binary_file( filename, fid, for_output = .true. )
    IF ( err_stat /= success ) THEN
      msg = 'Error opening '//trim(filename)
      CALL write_cleanup(); RETURN
    END IF


    ! Write the dimensions
    WRITE( fid,iostat=io_stat,iomsg=io_msg ) n_output_profiles
    IF ( io_stat /= 0 ) THEN
      msg = 'Error writing dimensions to '//trim(filename)//'- '//trim(io_msg)
      CALL write_cleanup(); RETURN
    END IF


    ! Write the data
    profile_loop: DO m = 1, n_output_profiles
      err_stat = write_record( fid, options(m), &
                               quiet = quiet, &
                               debug = debug )
      IF ( err_stat /= success ) THEN
        WRITE( msg,'("Error writing Options element (",i0,") to ",a)' ) m, trim(filename)
        CALL write_cleanup(); RETURN
      END IF
    END DO profile_loop


    ! Close the file (if error, no delete)
    CLOSE( fid,status='KEEP',iostat=io_stat,iomsg=io_msg )
    IF ( io_stat /= 0 ) THEN
      msg = 'Error closing '//trim(filename)//'- '//trim(io_msg)
      CALL write_cleanup(); RETURN
    END IF


    ! Output an info message
    IF ( noisy ) THEN
      WRITE( msg,'("Number of profiles written to ",a,": ",i0)' ) trim(filename), n_output_profiles
      CALL display_message( routine_name, msg, information )
    END IF

  CONTAINS

    SUBROUTINE write_cleanup()
      IF ( file_open( filename ) ) THEN
        CLOSE( fid,status=write_error_status,iostat=io_stat,iomsg=io_msg )
        IF ( io_stat /= 0 ) &
          msg = trim(msg)//'; Error deleting output file during error cleanup - '//trim(io_msg)
      END IF
      err_stat = failure
      CALL display_message( routine_name, msg, err_stat )
    END SUBROUTINE write_cleanup

  END FUNCTION crtm_options_writefile



!##################################################################################
!##################################################################################
!##                                                                              ##
!##                          ## PRIVATE MODULE ROUTINES ##                       ##
!##                                                                              ##
!##################################################################################
!##################################################################################

!------------------------------------------------------------------------------
!
! NAME:
!       CRTM_Options_Equal
!
! PURPOSE:
!       Elemental function to test the equality of two CRTM_Options objects.
!       Used in OPERATOR(==) interface block.
!
!       Note: Only the dimensionality and radiance/brightness temperatures
!             are checked for equality.
!
! CALLING SEQUENCE:
!       is_equal = CRTM_Options_Equal( x, y )
!
!         or
!
!       IF ( x == y ) THEN
!         ...
!       END IF
!
! OBJECTS:
!       x, y:          Two CRTM Options objects to be compared.
!                      UNITS:      N/A
!                      TYPE:       CRTM_Options_type
!                      DIMENSION:  Scalar or any rank
!                      ATTRIBUTES: INTENT(IN)
!
! FUNCTION RESULT:
!       is_equal:      Logical value indicating whether the inputs are equal.
!                      UNITS:      N/A
!                      TYPE:       LOGICAL
!                      DIMENSION:  Same as inputs.
!
!------------------------------------------------------------------------------

  ELEMENTAL FUNCTION crtm_options_equal( x, y ) RESULT( is_equal )
    TYPE(crtm_options_type) , INTENT(IN) :: x, y
    LOGICAL :: is_equal

    is_equal = (x%Check_Input              .EQV.   y%Check_Input           ) .AND. &
               (x%Use_Old_MWSSEM           .EQV.   y%Use_Old_MWSSEM        ) .AND. &
               (x%Use_Antenna_Correction   .EQV.   y%Use_Antenna_Correction) .AND. &
               (x%Apply_NLTE_Correction    .EQV.   y%Apply_NLTE_Correction ) .AND. &
               (x%RT_Algorithm_Id           ==     y%RT_Algorithm_Id       ) .AND. &
               (x%Aircraft_Pressure      .equalto. y%Aircraft_Pressure     ) .AND. &
               (x%Use_n_Streams            .EQV.   y%Use_n_Streams         ) .AND. &
               (x%n_Streams                 ==     y%n_Streams             ) .AND. &
               (x%Include_Scattering       .EQV.   y%Include_Scattering    )

    ! Emissivity component
    is_equal = is_equal .AND. &
               ( (x%n_Channels == y%n_Channels) .AND. &
                 (x%Channel    == y%Channel   ) .AND. &
                 (x%Use_Emissivity           .EQV. y%Use_Emissivity          ) .AND. &
                 (x%Use_Direct_Reflectivity  .EQV. y%Use_Direct_Reflectivity ) .AND. &
                 (crtm_options_associated(x) .EQV. crtm_options_associated(y)) )
    IF ( crtm_options_associated(x) .AND. crtm_options_associated(y) ) &
      is_equal = is_equal .AND. &
                 all(x%Emissivity          .equalto. y%Emissivity         ) .AND. &
                 all(x%Direct_Reflectivity .equalto. y%Direct_Reflectivity)

    ! SSU input
    is_equal = is_equal .AND. &
               (x%SSU == y%SSU)

    ! Zeeman input
    is_equal = is_equal .AND. &
               (x%Zeeman == y%Zeeman)

  END FUNCTION crtm_options_equal


!
! NAME:
!       Read_Record
!
! PURPOSE:
!       Utility function to read a single options data record
!

  FUNCTION read_record( &
    fid        , &  ! Input
    opt        , &  ! Output
    Quiet      , &  ! Optional input
    Debug      ) &  ! Optional input (Debug output control)
  result( err_stat )
    ! Arguments
    INTEGER,                 INTENT(IN)  :: fid
    TYPE(crtm_options_type), INTENT(OUT) :: opt
    LOGICAL,       OPTIONAL, INTENT(IN)  :: quiet
    LOGICAL,       OPTIONAL, INTENT(IN)  :: debug
    ! Function result
    INTEGER :: err_stat
    ! Function parameters
    CHARACTER(*), PARAMETER :: routine_name = 'CRTM_Options_ReadFile(Record)'
    ! Function variables
    CHARACTER(ML) :: fname
    CHARACTER(ML) :: msg
    CHARACTER(ML) :: io_msg
    INTEGER :: io_stat
    INTEGER :: n_channels
    LOGICAL :: emissivity_data_present

    ! Set up
    err_stat = success


    ! Read the dimensions
    READ( fid,iostat=io_stat,iomsg=io_msg ) n_channels
    IF ( io_stat /= 0 ) THEN
      msg = 'Error reading dimensions - '//trim(io_msg)
      CALL read_record_cleanup(); RETURN
    END IF
    ! ... No emissivity data if n_channels == 0
    emissivity_data_present = (n_channels > 0)



    ! Allocate the Options structure if necessary
    IF ( emissivity_data_present ) THEN
      CALL crtm_options_create( opt, n_channels )
      IF ( .NOT. crtm_options_associated( opt ) ) THEN
        msg = 'Error creating output object.'
        CALL read_record_cleanup(); RETURN
      END IF
    END IF


    ! Read the optional values
    ! ...Input checking logical
    err_stat = readlogical_binary_file( fid, opt%Check_Input )
    IF ( err_stat /= success ) THEN
      msg = 'Error reading input checking option'
      CALL read_record_cleanup(); RETURN
    END IF
    ! ...Old MWSSEM logical
    err_stat = readlogical_binary_file( fid, opt%Use_Old_MWSSEM )
    IF ( err_stat /= success ) THEN
      msg = 'Error reading old MW water emissivity algorithm switch option'
      CALL read_record_cleanup(); RETURN
    END IF
    ! ...Antenna correction logical
    err_stat = readlogical_binary_file( fid, opt%Use_Antenna_Correction )
    IF ( err_stat /= success ) THEN
      msg = 'Error reading antenna correction option'
      CALL read_record_cleanup(); RETURN
    END IF
    ! ...NLTE correction logical
    err_stat = readlogical_binary_file( fid, opt%Apply_NLTE_Correction )
    IF ( err_stat /= success ) THEN
      msg = 'Error reading NLTE correction option'
      CALL read_record_cleanup(); RETURN
    END IF
    ! ...RT algorithm ID
    READ( fid,iostat=io_stat,iomsg=io_msg ) opt%RT_Algorithm_Id
    IF ( io_stat /= 0 ) THEN
      msg = 'Error reading RT algorithm id option - '//trim(io_msg)
      CALL read_record_cleanup(); RETURN
    END IF
    ! ...Aircraft flight level pressure
    READ( fid,iostat=io_stat,iomsg=io_msg ) opt%Aircraft_Pressure
    IF ( io_stat /= 0 ) THEN
      msg = 'Error reading aircraft flight level pressure option - '//trim(io_msg)
      CALL read_record_cleanup(); RETURN
    END IF
    ! ...Number of RT streams options
    err_stat = readlogical_binary_file( fid, opt%Use_n_Streams )
    IF ( err_stat /= success ) THEN
      msg = 'Error reading n_Streams option'
      CALL read_record_cleanup(); RETURN
    END IF
    READ( fid,iostat=io_stat,iomsg=io_msg ) opt%n_Streams
    IF ( io_stat /= 0 ) THEN
      msg = 'Error reading n_Streams optional value - '//trim(io_msg)
      CALL read_record_cleanup(); RETURN
    END IF
    ! ...Scattering options
    err_stat = readlogical_binary_file( fid, opt%Include_Scattering )
    IF ( err_stat /= success ) THEN
      msg = 'Error reading include scattering option'
      CALL read_record_cleanup(); RETURN
    END IF


    ! Read the emissivity/reflectivity data
    IF ( emissivity_data_present ) THEN
      ! Read the emissivity option
      ! ...The switch...
      err_stat = readlogical_binary_file( fid, opt%Use_Emissivity )
      IF ( err_stat /= success ) THEN
        msg = 'Error reading emissivity option'
        CALL read_record_cleanup(); RETURN
      END IF
      ! ...and the data
      READ( fid,iostat=io_stat,iomsg=io_msg ) opt%Emissivity
      IF ( io_stat /= 0 ) THEN
        msg = 'Error reading emissivity data - '//trim(io_msg)
        CALL read_record_cleanup(); RETURN
      END IF

      ! Read the direct reflectivity option
      ! ...The switch...
      err_stat = readlogical_binary_file( fid, opt%Use_Direct_Reflectivity )
      IF ( err_stat /= success ) THEN
        msg = 'Error reading direct reflectivity option'
        CALL read_record_cleanup(); RETURN
      END IF
      ! ...and the data
      READ( fid,iostat=io_stat,iomsg=io_msg ) opt%Direct_Reflectivity
      IF ( io_stat /= 0 ) THEN
        msg = 'Error reading direct reflectivity data - '//trim(io_msg)
        CALL read_record_cleanup(); RETURN
      END IF
    END IF


    ! Read the contained object data
    INQUIRE( unit=fid,name=fname )
    ! ...The SSU input data
    err_stat = ssu_input_readfile( &
                 opt%SSU, &
                 fname, &
                 quiet    = quiet, &
                 no_close = .true., &
                 debug    = debug )
    IF ( err_stat /= success ) THEN
      msg = 'Error reading SSU input data'
      CALL read_record_cleanup(); RETURN
    END IF
    ! ...The Zeeman input data
    err_stat = zeeman_input_readfile( &
                 opt%Zeeman, &
                 fname, &
                 quiet    = quiet, &
                 no_close = .true., &
                 debug    = debug )
    IF ( err_stat /= success ) THEN
      msg = 'Error reading Zeeman input data'
      CALL read_record_cleanup(); RETURN
    END IF

  CONTAINS

    SUBROUTINE read_record_cleanup()
      CALL crtm_options_destroy( opt )
      CLOSE( fid,iostat=io_stat,iomsg=io_msg )
      IF ( io_stat /= success ) &
        msg = trim(msg)//'; Error closing file during error cleanup - '//trim(io_msg)
      err_stat = failure
      CALL display_message( routine_name, msg, err_stat )
    END SUBROUTINE read_record_cleanup

  END FUNCTION read_record


!
! NAME:
!       Write_Record
!
! PURPOSE:
!       Utility function to write a single options data record
!

  FUNCTION write_record( &
    fid        , &  ! Input
    opt        , &  ! Input
    Quiet      , &  ! Optional input
    Debug      ) &  ! Optional input (Debug output control)
  result( err_stat )
    ! Arguments
    INTEGER,                 INTENT(IN) :: fid
    TYPE(crtm_options_type), INTENT(IN) :: opt
    LOGICAL,       OPTIONAL, INTENT(IN) :: quiet
    LOGICAL,       OPTIONAL, INTENT(IN) :: debug
    ! Function result
    INTEGER :: err_stat
    ! Function parameters
    CHARACTER(*), PARAMETER :: routine_name = 'CRTM_Options_WriteFile(Record)'
    ! Function variables
    CHARACTER(ML) :: fname
    CHARACTER(ML) :: msg
    CHARACTER(ML) :: io_msg
    INTEGER :: io_stat

    ! Set up
    err_stat = success


    ! Write the dimensions
    WRITE( fid,iostat=io_stat,iomsg=io_msg ) opt%n_channels
    IF ( io_stat /= 0 ) THEN
      msg = 'Error writing dimensions - '//trim(io_msg)
      CALL write_record_cleanup(); RETURN
    END IF


    ! Write the optional values
    ! ...Input checking logical
    err_stat = writelogical_binary_file( fid, opt%Check_Input )
    IF ( err_stat /= success ) THEN
      msg = 'Error writing input checking option'
      CALL write_record_cleanup(); RETURN
    END IF
    ! ...Old MWSSEM logical
    err_stat = writelogical_binary_file( fid, opt%Use_Old_MWSSEM )
    IF ( err_stat /= success ) THEN
      msg = 'Error writing old MW water emissivity algorithm switch option'
      CALL write_record_cleanup(); RETURN
    END IF
    ! ...Antenna correction logical
    err_stat = writelogical_binary_file( fid, opt%Use_Antenna_Correction )
    IF ( err_stat /= success ) THEN
      msg = 'Error writing antenna correction option'
      CALL write_record_cleanup(); RETURN
    END IF
    ! ...NLTE correction logical
    err_stat = writelogical_binary_file( fid, opt%Apply_NLTE_Correction )
    IF ( err_stat /= success ) THEN
      msg = 'Error writing NLTE correction option'
      CALL write_record_cleanup(); RETURN
    END IF
    ! ...RT algorithm ID
    WRITE( fid,iostat=io_stat,iomsg=io_msg ) opt%RT_Algorithm_Id
    IF ( io_stat /= 0 ) THEN
      msg = 'Error writing RT algorithm id option - '//trim(io_msg)
      CALL write_record_cleanup(); RETURN
    END IF
    ! ...Aircraft flight level pressure
    WRITE( fid,iostat=io_stat,iomsg=io_msg ) opt%Aircraft_Pressure
    IF ( io_stat /= 0 ) THEN
      msg = 'Error writing aircraft flight level pressure option - '//trim(io_msg)
      CALL write_record_cleanup(); RETURN
    END IF
    ! ...Number of RT streams options
    err_stat = writelogical_binary_file( fid, opt%Use_n_Streams )
    IF ( err_stat /= success ) THEN
      msg = 'Error writing n_Streams option'
      CALL write_record_cleanup(); RETURN
    END IF
    WRITE( fid,iostat=io_stat,iomsg=io_msg ) opt%n_Streams
    IF ( io_stat /= 0 ) THEN
      msg = 'Error writing n_Streams optional value - '//trim(io_msg)
      CALL write_record_cleanup(); RETURN
    END IF
    ! ...Scattering options
    err_stat = writelogical_binary_file( fid, opt%Include_Scattering )
    IF ( err_stat /= success ) THEN
      msg = 'Error writing include scattering option'
      CALL write_record_cleanup(); RETURN
    END IF


    ! Write the emissivity/reflectivity data
    IF ( crtm_options_associated(opt) ) THEN
      ! Write the emissivity option
      ! ...The switch...
      err_stat = writelogical_binary_file( fid, opt%Use_Emissivity )
      IF ( err_stat /= success ) THEN
        msg = 'Error writing emissivity option'
        CALL write_record_cleanup(); RETURN
      END IF
      ! ...and the data
      WRITE( fid,iostat=io_stat,iomsg=io_msg ) opt%Emissivity
      IF ( io_stat /= 0 ) THEN
        msg = 'Error writing emissivity data - '//trim(io_msg)
        CALL write_record_cleanup(); RETURN
      END IF

      ! Write the direct reflectivity option
      ! ...The switch...
      err_stat = writelogical_binary_file( fid, opt%Use_Direct_Reflectivity )
      IF ( err_stat /= success ) THEN
        msg = 'Error writing direct reflectivity option'
        CALL write_record_cleanup(); RETURN
      END IF
      ! ...and the data
      WRITE( fid,iostat=io_stat,iomsg=io_msg ) opt%Direct_Reflectivity
      IF ( io_stat /= 0 ) THEN
        msg = 'Error writing direct reflectivity data - '//trim(io_msg)
        CALL write_record_cleanup(); RETURN
      END IF
    END IF


    ! Write the contained object data
    INQUIRE( unit=fid,name=fname )
    ! ...The SSU input data
    err_stat = ssu_input_writefile( &
                 opt%SSU, &
                 fname, &
                 quiet    = quiet, &
                 no_close = .true., &
                 debug    = debug )
    IF ( err_stat /= success ) THEN
      msg = 'Error writing SSU input data'
      CALL write_record_cleanup(); RETURN
    END IF
    ! ...The Zeeman input data
    err_stat = zeeman_input_writefile( &
                 opt%Zeeman, &
                 fname, &
                 quiet    = quiet, &
                 no_close = .true., &
                 debug    = debug )
    IF ( err_stat /= success ) THEN
      msg = 'Error writing Zeeman input data'
      CALL write_record_cleanup(); RETURN
    END IF

  CONTAINS

    SUBROUTINE write_record_cleanup()
      CLOSE( fid,status=write_error_status,iostat=io_stat,iomsg=io_msg )
      IF ( io_stat /= success ) &
        msg = trim(msg)//'; Error closing file during error cleanup - '//trim(io_msg)
      err_stat = failure
      CALL display_message( routine_name, msg, err_stat )
    END SUBROUTINE write_record_cleanup

  END FUNCTION write_record

END MODULE crtm_options_define