FitCoeff_Define.f90

Go to the documentation of this file.

!
! FitCoeff_Define
!
! Module defining the FitCoeff objects.
!
!
! CREATION HISTORY:
!       Written by:     Paul van Delst, 17-Nov-2011
!                       paul.vandelst@noaa.gov
 
MODULE fitcoeff_define

  ! -----------------
  ! Environment setup
  ! -----------------
  ! Module use
  USE type_kinds           , ONLY: fp, long, double
  USE message_handler      , ONLY: success, failure, 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
  ! Disable implicit typing
  IMPLICIT NONE


  ! ------------
  ! Visibilities
  ! ------------
  ! Everything private by default
  PRIVATE
  ! Parameters
  PUBLIC :: fitcoeff_max_n_dimensions
  ! Datatypes
  PUBLIC :: fitcoeff_1d_type
  PUBLIC :: fitcoeff_2d_type
  PUBLIC :: fitcoeff_3d_type
  ! Operators
  PUBLIC :: OPERATOR(==)
  ! Procedures
  PUBLIC :: fitcoeff_associated
  PUBLIC :: fitcoeff_destroy
  PUBLIC :: fitcoeff_create
  PUBLIC :: fitcoeff_setvalue
  PUBLIC :: fitcoeff_inspect
  PUBLIC :: fitcoeff_validrelease
  PUBLIC :: fitcoeff_info
  PUBLIC :: fitcoeff_defineversion
  PUBLIC :: fitcoeff_inquirefile
  PUBLIC :: fitcoeff_readfile
  PUBLIC :: fitcoeff_writefile


  ! ---------------------
  ! Procedure overloading
  ! ---------------------
  INTERFACE fitcoeff_associated
    MODULE PROCEDURE fitcoeff_1d_associated
    MODULE PROCEDURE fitcoeff_2d_associated
    MODULE PROCEDURE fitcoeff_3d_associated
  END INTERFACE fitcoeff_associated
  
  INTERFACE fitcoeff_destroy
    MODULE PROCEDURE fitcoeff_1d_destroy
    MODULE PROCEDURE fitcoeff_2d_destroy
    MODULE PROCEDURE fitcoeff_3d_destroy
  END INTERFACE fitcoeff_destroy
  
  INTERFACE fitcoeff_create
    MODULE PROCEDURE fitcoeff_1d_create
    MODULE PROCEDURE fitcoeff_2d_create
    MODULE PROCEDURE fitcoeff_3d_create
  END INTERFACE fitcoeff_create
  
  INTERFACE fitcoeff_setvalue
    MODULE PROCEDURE fitcoeff_1d_setvalue
    MODULE PROCEDURE fitcoeff_2d_setvalue
    MODULE PROCEDURE fitcoeff_3d_setvalue
  END INTERFACE fitcoeff_setvalue
  
  INTERFACE fitcoeff_inspect
    MODULE PROCEDURE fitcoeff_1d_inspect
    MODULE PROCEDURE fitcoeff_2d_inspect
    MODULE PROCEDURE fitcoeff_3d_inspect
  END INTERFACE fitcoeff_inspect
  
  INTERFACE fitcoeff_validrelease
    MODULE PROCEDURE fitcoeff_1d_validrelease
    MODULE PROCEDURE fitcoeff_2d_validrelease
    MODULE PROCEDURE fitcoeff_3d_validrelease
  END INTERFACE fitcoeff_validrelease
  
  INTERFACE fitcoeff_info
    MODULE PROCEDURE fitcoeff_1d_info
    MODULE PROCEDURE fitcoeff_2d_info
    MODULE PROCEDURE fitcoeff_3d_info
  END INTERFACE fitcoeff_info
  
  INTERFACE fitcoeff_readfile
    MODULE PROCEDURE fitcoeff_1d_readfile
    MODULE PROCEDURE fitcoeff_2d_readfile
    MODULE PROCEDURE fitcoeff_3d_readfile
  END INTERFACE fitcoeff_readfile
  
  INTERFACE fitcoeff_writefile
    MODULE PROCEDURE fitcoeff_1d_writefile
    MODULE PROCEDURE fitcoeff_2d_writefile
    MODULE PROCEDURE fitcoeff_3d_writefile
  END INTERFACE fitcoeff_writefile
  
  INTERFACE OPERATOR(==)
    MODULE PROCEDURE fitcoeff_1d_equal
    MODULE PROCEDURE fitcoeff_2d_equal
    MODULE PROCEDURE fitcoeff_3d_equal
  END INTERFACE OPERATOR(==)


  ! -----------------
  ! Module parameters
  ! -----------------
  CHARACTER(*), PARAMETER :: module_version_id = &
    '$Id: FitCoeff_Define.f90 60152 2015-08-13 19:19:13Z paul.vandelst@noaa.gov $'
  ! Release and version
  INTEGER, PARAMETER :: fitcoeff_release = 1  ! This determines structure and file formats.
  INTEGER, PARAMETER :: fitcoeff_version = 1  ! This is just the default data version.
  ! Close status for write errors
  CHARACTER(*), PARAMETER :: write_error_status = 'DELETE'
  ! Literal constants
  REAL(fp), PARAMETER :: zero = 0.0_fp
  REAL(fp), PARAMETER :: one  = 1.0_fp
  ! String lengths
  INTEGER, PARAMETER :: ml = 256 ! Message length
  INTEGER, PARAMETER :: sl =  80 ! String length
  ! Maximum number of dimensions
  INTEGER, PARAMETER :: fitcoeff_max_n_dimensions = 3  ! Only implemented up to 3-D arrays so far


  ! ----------------------------------
  ! FitCoeff data type definitions
  ! ----------------------------------
  !:tdoc+:
  TYPE :: fitcoeff_1d_type
    ! Allocation indicator
    LOGICAL :: is_allocated = .false.
    ! Release and version information
    INTEGER(Long) :: release = fitcoeff_release
    INTEGER(Long) :: version = fitcoeff_version
    ! Dimensions
    INTEGER(Long) :: dimensions(1) = 0
    ! Data
    REAL(Double), ALLOCATABLE :: c(:)
  END TYPE fitcoeff_1d_type
  !:tdoc-:

  !:tdoc+:
  TYPE :: fitcoeff_2d_type
    ! Allocation indicator
    LOGICAL :: is_allocated = .false.
    ! Release and version information
    INTEGER(Long) :: release = fitcoeff_release
    INTEGER(Long) :: version = fitcoeff_version
    ! Dimensions
    INTEGER(Long) :: dimensions(2) = 0
    ! Data
    REAL(Double), ALLOCATABLE :: c(:,:)
  END TYPE fitcoeff_2d_type
  !:tdoc-:

  !:tdoc+:
  TYPE :: fitcoeff_3d_type
    ! Allocation indicator
    LOGICAL :: is_allocated = .false.
    ! Release and version information
    INTEGER(Long) :: release = fitcoeff_release
    INTEGER(Long) :: version = fitcoeff_version
    ! Dimensions
    INTEGER(Long) :: dimensions(3) = 0
    ! Data
    REAL(Double), ALLOCATABLE :: c(:,:,:)
  END TYPE fitcoeff_3d_type
  !:tdoc-:


CONTAINS


!################################################################################
!################################################################################
!##                                                                            ##
!##                           ## PUBLIC PROCEDURES ##                          ##
!##                                                                            ##
!################################################################################
!################################################################################

!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       FitCoeff_Associated
!
! PURPOSE:
!       Pure function to test the status of the allocatable components
!       of the FitCoeff structure.
!
! CALLING SEQUENCE:
!       Status = FitCoeff_Associated( FitCoeff )
!
! OBJECTS:
!       FitCoeff:      Structure which is to have its member's
!                      status tested.
!                      UNITS:      N/A
!                      TYPE:       Any FitCoeff type
!                      DIMENSION:  Scalar
!                      ATTRIBUTES: INTENT(IN)
!
! FUNCTION RESULT:
!       Status:        The return value is a logical value indicating the
!                      status of the components.
!                       .TRUE.  - if ANY of the FitCoeff allocatable members
!                                 are in use.
!                       .FALSE. - if ALL of the FitCoeff allocatable members
!                                 are not in use.
!                      UNITS:      N/A
!                      TYPE:       LOGICAL
!                      DIMENSION:  Same as input
!
!:sdoc-:
!--------------------------------------------------------------------------------

  PURE FUNCTION fitcoeff_1d_associated( self ) RESULT( Status )
    TYPE(fitcoeff_1d_type), INTENT(IN) :: self
    LOGICAL :: status
    status = self%Is_Allocated
  END FUNCTION fitcoeff_1d_associated

  PURE FUNCTION fitcoeff_2d_associated( self ) RESULT( Status )
    TYPE(fitcoeff_2d_type), INTENT(IN) :: self
    LOGICAL :: status
    status = self%Is_Allocated
  END FUNCTION fitcoeff_2d_associated

  PURE FUNCTION fitcoeff_3d_associated( self ) RESULT( Status )
    TYPE(fitcoeff_3d_type), INTENT(IN) :: self
    LOGICAL :: status
    status = self%Is_Allocated
  END FUNCTION fitcoeff_3d_associated

  
!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       FitCoeff_Destroy
!
! PURPOSE:
!       Pure subroutine to re-initialize FitCoeff objects.
!
! CALLING SEQUENCE:
!       CALL FitCoeff_Destroy( FitCoeff )
!
! OBJECTS:
!       FitCoeff:     Re-initialized FitCoeff structure.
!                     UNITS:      N/A
!                     TYPE:       Any FitCoeff type
!                     DIMENSION:  Scalar
!                     ATTRIBUTES: INTENT(OUT)
!
!:sdoc-:
!--------------------------------------------------------------------------------

  PURE SUBROUTINE fitcoeff_1d_destroy( self )
    TYPE(fitcoeff_1d_type), INTENT(OUT) :: self
    include 'FitCoeff_Destroy.inc'
  END SUBROUTINE fitcoeff_1d_destroy

  PURE SUBROUTINE fitcoeff_2d_destroy( self )
    TYPE(fitcoeff_2d_type), INTENT(OUT) :: self
    include 'FitCoeff_Destroy.inc'
  END SUBROUTINE fitcoeff_2d_destroy

  PURE SUBROUTINE fitcoeff_3d_destroy( self )
    TYPE(fitcoeff_3d_type), INTENT(OUT) :: self
    include 'FitCoeff_Destroy.inc'
  END SUBROUTINE fitcoeff_3d_destroy



!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       FitCoeff_Create
!
! PURPOSE:
!       Pure subroutine to create an instance of a FitCoeff object.
!
! CALLING SEQUENCE:
!       CALL FitCoeff_Create( FitCoeff, Dimensions )
!
! OBJECTS:
!       FitCoeff:   FitCoeff object structure.
!                   UNITS:      N/A
!                   TYPE:       Any FitCoeff type
!                   DIMENSION:  Scalar
!                   ATTRIBUTES: INTENT(OUT)
!
! INPUTS:
!       Dimensions: Dimension vector for the fitting coefficient array.
!                   The number of elements of this array must agree with
!                   the rank of the FitCoeff datatype specified, e.g. 2D
!                   type requires 2 dimensions specified.
!                   Values must be > 0.
!                   UNITS:      N/A
!                   TYPE:       INTEGER
!                   DIMENSION:  Rank
!                   ATTRIBUTES: INTENT(IN)
!
!:sdoc-:
!--------------------------------------------------------------------------------

  PURE SUBROUTINE fitcoeff_1d_create( &
    self      , &  ! Output
    dimensions  )  ! Input
    ! Arguments
    TYPE(fitcoeff_1d_type), INTENT(OUT) :: self
    INTEGER               , INTENT(IN)  :: dimensions(1)
    ! Local variables
    INTEGER :: alloc_stat

    ! Check input
    IF ( any(dimensions < 1) ) RETURN

    ! Perform the allocation
    ALLOCATE( self%C(dimensions(1)), stat = alloc_stat )
    IF ( alloc_stat /= 0 ) RETURN

    ! Initialise
    ! ...Dimensions
    self%Dimensions = dimensions
    ! ...Arrays
    self%C = zero

    ! Set allocation indicator
    self%Is_Allocated = .true.

  END SUBROUTINE fitcoeff_1d_create


  PURE SUBROUTINE fitcoeff_2d_create( &
    self      , &  ! Output
    dimensions  )  ! Input
    ! Arguments
    TYPE(fitcoeff_2d_type), INTENT(OUT) :: self
    INTEGER               , INTENT(IN)  :: dimensions(2)
    ! Local variables
    INTEGER :: alloc_stat

    ! Check input
    IF ( any(dimensions < 1) ) RETURN

    ! Perform the allocation
    ALLOCATE( self%C(dimensions(1), dimensions(2)), stat = alloc_stat )
    IF ( alloc_stat /= 0 ) RETURN

    ! Initialise
    ! ...Dimensions
    self%Dimensions = dimensions
    ! ...Arrays
    self%C = zero

    ! Set allocation indicator
    self%Is_Allocated = .true.

  END SUBROUTINE fitcoeff_2d_create


  PURE SUBROUTINE fitcoeff_3d_create( &
    self      , &  ! Output
    dimensions  )  ! Input
    ! Arguments
    TYPE(fitcoeff_3d_type), INTENT(OUT) :: self
    INTEGER               , INTENT(IN)  :: dimensions(3)
    ! Local variables
    INTEGER :: alloc_stat

    ! Check input
    IF ( any(dimensions < 1) ) RETURN

    ! Perform the allocation
    ALLOCATE( self%C(dimensions(1), dimensions(2), dimensions(3)), stat = alloc_stat )
    IF ( alloc_stat /= 0 ) RETURN

    ! Initialise
    ! ...Dimensions
    self%Dimensions = dimensions
    ! ...Arrays
    self%C = zero

    ! Set allocation indicator
    self%Is_Allocated = .true.

  END SUBROUTINE fitcoeff_3d_create



!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       FitCoeff_SetValue
!
! PURPOSE:
!       Subroutine to set the value of coefficients in a FitCoeff object.
!
! CALLING SEQUENCE:
!       CALL FitCoeff_SetValue( FitCoeff, Carray )
!
! OBJECTS:
!       FitCoeff:   FitCoeff object structure which is to have its coefficient
!                   data set.
!                   Note #1: If unallocated, the object is allocated based
!                            on the SHAPE of the Carray input.
!                   Note #2: If already allocated, the dimensions of the
!                            coefficient component must be the same as that
!                            of the Carray input.
!                   UNITS:      N/A
!                   TYPE:       Any FitCoeff type
!                   DIMENSION:  Scalar
!                   ATTRIBUTES: INTENT(IN OUT)
!
! INPUTS:
!       Carray:     Coefficient array to be assigned to FitCoeff object.
!                   The rank of this array must agree with the rank of
!                   the FitCoeff datatype specified, e.g. 2D FitCoeff
!                   type requires a rank-2 coefficient array.
!                   UNITS:      N/A
!                   TYPE:       REAL(fp)
!                   DIMENSION:  Rank conforming with FitCoeff type.
!                   ATTRIBUTES: INTENT(IN)
!
! COMMENTS:
!   If an error occurs, the FitCoeff object is deallocated.
!
!:sdoc-:
!--------------------------------------------------------------------------------

  SUBROUTINE fitcoeff_1d_setvalue( &
    self   , &  ! In/output
    C      , &  ! Input
    Version  )  ! optional input
    ! Arguments
    TYPE(FitCoeff_1D_type), INTENT(IN OUT) :: self
    REAL(fp)              , INTENT(IN)     :: C(:)
    INTEGER,      OPTIONAL, INTENT(IN)     :: Version
    include 'FitCoeff_SetValue.inc'
  END SUBROUTINE fitcoeff_1d_setvalue


  SUBROUTINE fitcoeff_2d_setvalue( &
    self   , &  ! In/output
    C      , &  ! Input
    Version  )  ! optional input
    ! Arguments
    TYPE(FitCoeff_2D_type), INTENT(IN OUT) :: self
    REAL(fp)              , INTENT(IN)     :: C(:,:)
    INTEGER,      OPTIONAL, INTENT(IN)     :: Version
    include 'FitCoeff_SetValue.inc'
  END SUBROUTINE fitcoeff_2d_setvalue


  SUBROUTINE fitcoeff_3d_setvalue( &
    self   , &  ! In/output
    C      , &  ! Input
    Version  )  ! optional input
    ! Arguments
    TYPE(FitCoeff_3D_type), INTENT(IN OUT) :: self
    REAL(fp)              , INTENT(IN)     :: C(:,:,:)
    INTEGER,      OPTIONAL, INTENT(IN)     :: Version
    include 'FitCoeff_SetValue.inc'
  END SUBROUTINE fitcoeff_3d_setvalue


!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       FitCoeff_Inspect
!
! PURPOSE:
!       Subroutine to print the contents of a FitCoeff object to stdout.
!
! CALLING SEQUENCE:
!       CALL FitCoeff_Inspect( FitCoeff )
!
! OBJECTS:
!       FitCoeff:      FitCoeff object to display.
!                      UNITS:      N/A
!                      TYPE:       Any FitCoeff type
!                      DIMENSION:  Scalar
!                      ATTRIBUTES: INTENT(IN)
!
!:sdoc-:
!--------------------------------------------------------------------------------

  SUBROUTINE fitcoeff_1d_inspect( self )
    TYPE(FitCoeff_1D_type), INTENT(IN) :: self
    WRITE(*,'(1x,"FitCoeff 1D OBJECT")')
    ! Release/version info
    WRITE(*,'(3x,"Release.Version : ",i0,".",i0)') self%Release, self%Version
    ! Dimensions
    WRITE(*,'(3x,"Dimensions : ",10(i5,:))') self%Dimensions
    IF ( .NOT. fitcoeff_1d_associated(self) ) RETURN
    ! Coefficient data
    WRITE(*,'(3x,"Coefficients:")')
    WRITE(*,'(5(1x,es13.6,:))') self%C
  END SUBROUTINE fitcoeff_1d_inspect


  SUBROUTINE fitcoeff_2d_inspect( self )
    TYPE(FitCoeff_2D_type), INTENT(IN) :: self
    INTEGER :: i
    WRITE(*,'(1x,"FitCoeff 2D OBJECT")')
    ! Release/version info
    WRITE(*,'(3x,"Release.Version : ",i0,".",i0)') self%Release, self%Version
    ! Dimensions
    WRITE(*,'(3x,"Dimensions : ",10(i5,:))') self%Dimensions
    IF ( .NOT. fitcoeff_2d_associated(self) ) RETURN
    ! Coefficient data
    WRITE(*,'(3x,"Coefficients:")')
    DO i = 1, self%Dimensions(2)
      WRITE(*,'(5x,"Outer dimension = ",i0," of ",i0)') i, self%Dimensions(2)
      WRITE(*,'(5(1x,es13.6,:))') self%C(:,i)
    END DO
  END SUBROUTINE fitcoeff_2d_inspect


  SUBROUTINE fitcoeff_3d_inspect( self )
    TYPE(FitCoeff_3D_type), INTENT(IN) :: self
    INTEGER :: i, j
    WRITE(*,'(1x,"FitCoeff 3D OBJECT")')
    ! Release/version info
    WRITE(*,'(3x,"Release.Version : ",i0,".",i0)') self%Release, self%Version
    ! Dimensions
    WRITE(*,'(3x,"Dimensions : ",10(i5,:))') self%Dimensions
    IF ( .NOT. fitcoeff_3d_associated(self) ) RETURN
    ! Coefficient data
    WRITE(*,'(3x,"Coefficients:")')
    DO j = 1, self%Dimensions(3)
      WRITE(*,'(5x,"Outer dimension = ",i0," of ",i0)') j, self%Dimensions(3)
      DO i = 1, self%Dimensions(2)
        WRITE(*,'(7x,"Middle dimension = ",i0," of ",i0)') i, self%Dimensions(2)
        WRITE(*,'(5(1x,es13.6,:))') self%C(:,i,j)
      END DO
    END DO
  END SUBROUTINE fitcoeff_3d_inspect


!----------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       FitCoeff_ValidRelease
!
! PURPOSE:
!       Function to check the FitCoeff Release value.
!
! CALLING SEQUENCE:
!       IsValid = FitCoeff_ValidRelease( FitCoeff )
!
! INPUTS:
!       FitCoeff:      FitCoeff object for which the Release component
!                      is to be checked.
!                      UNITS:      N/A
!                      TYPE:       Any FitCoeff type
!                      DIMENSION:  Scalar
!                      ATTRIBUTES: INTENT(IN)
!
! FUNCTION RESULT:
!       IsValid:       Logical value defining the release validity.
!                      UNITS:      N/A
!                      TYPE:       LOGICAL
!                      DIMENSION:  Scalar
!
!:sdoc-:
!----------------------------------------------------------------------------------

  FUNCTION validrelease( Release ) RESULT( IsValid )
    ! Arguments
    INTEGER, INTENT(IN) :: release
    ! Function result
    LOGICAL :: isvalid
    ! Local parameters
    CHARACTER(*), PARAMETER :: routine_name = 'FitCoeff_ValidRelease'
    ! Local variables
    CHARACTER(ML) :: msg

    ! Set up
    isvalid = .true.

    ! Check release is not too old
    IF ( release < fitcoeff_release ) THEN
      isvalid = .false.
      WRITE( msg,'("A FitCoeff data update is needed. ", &
                  &"FitCoeff release is ",i0,". Valid release is ",i0,"." )' ) &
                  release, fitcoeff_release
      CALL display_message( routine_name, msg, information ); RETURN
    END IF

    ! Check release is not too new
    IF ( release > fitcoeff_release ) THEN
      isvalid = .false.
      WRITE( msg,'("A FitCoeff software update is needed. ", &
                  &"FitCoeff release is ",i0,". Valid release is ",i0,"." )' ) &
                  release, fitcoeff_release
      CALL display_message( routine_name, msg, information ); RETURN
    END IF
  END FUNCTION validrelease


  FUNCTION fitcoeff_1d_validrelease( self ) RESULT( IsValid )
    TYPE(fitcoeff_1d_type), INTENT(IN) :: self
    LOGICAL :: isvalid
    isvalid = validrelease( self%Release )
  END FUNCTION fitcoeff_1d_validrelease


  FUNCTION fitcoeff_2d_validrelease( self ) RESULT( IsValid )
    TYPE(fitcoeff_2d_type), INTENT(IN) :: self
    LOGICAL :: isvalid
    isvalid = validrelease( self%Release )
  END FUNCTION fitcoeff_2d_validrelease


  FUNCTION fitcoeff_3d_validrelease( self ) RESULT( IsValid )
    TYPE(fitcoeff_3d_type), INTENT(IN) :: self
    LOGICAL :: isvalid
    isvalid = validrelease( self%Release )
  END FUNCTION fitcoeff_3d_validrelease


!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       FitCoeff_Info
!
! PURPOSE:
!       Subroutine to return a string containing version and dimension
!       information about a FitCoeff object.
!
! CALLING SEQUENCE:
!       CALL FitCoeff_Info( FitCoeff, Info )
!
! OBJECTS:
!       FitCoeff:      FitCoeff object about which info is required.
!                      UNITS:      N/A
!                      TYPE:       Any FitCoeff type
!                      DIMENSION:  Scalar
!                      ATTRIBUTES: INTENT(IN)
!
! OUTPUTS:
!       Info:          String containing version and dimension information
!                      about the FitCoeff object.
!                      UNITS:      N/A
!                      TYPE:       CHARACTER(*)
!                      DIMENSION:  Scalar
!                      ATTRIBUTES: INTENT(OUT)
!
!:sdoc-:
!--------------------------------------------------------------------------------

  SUBROUTINE fitcoeff_1d_info( self, Info )
    ! Arguments
    TYPE(FitCoeff_1D_type), INTENT(IN)  :: self
    include 'FitCoeff_Info.inc'
  END SUBROUTINE fitcoeff_1d_info
 
 
  SUBROUTINE fitcoeff_2d_info( self, Info )
    ! Arguments
    TYPE(FitCoeff_2D_type), INTENT(IN)  :: self
    include 'FitCoeff_Info.inc'
  END SUBROUTINE fitcoeff_2d_info
 
 
  SUBROUTINE fitcoeff_3d_info( self, Info )
    ! Arguments
    TYPE(FitCoeff_3D_type), INTENT(IN)  :: self
    include 'FitCoeff_Info.inc'
  END SUBROUTINE fitcoeff_3d_info
 
 
!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       FitCoeff_DefineVersion
!
! PURPOSE:
!       Subroutine to return the module version information.
!
! CALLING SEQUENCE:
!       CALL FitCoeff_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 fitcoeff_defineversion( Id )
    CHARACTER(*), INTENT(OUT) :: id
    id = module_version_id
  END SUBROUTINE fitcoeff_defineversion


!------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       FitCoeff_InquireFile
!
! PURPOSE:
!       Function to inquire FitCoeff object files.
!
! CALLING SEQUENCE:
!       Error_Status = FitCoeff_InquireFile( &
!                        Filename                   , &
!                        n_Dimensions = n_Dimensions, &
!                        Dimensions   = Dimensions  , &
!                        Release      = Release     , &
!                        Version      = Version     , &
!                        Title        = Title       , &
!                        History      = History     , &
!                        Comment      = Comment       )
!
! INPUTS:
!       Filename:           Character string specifying the name of the
!                           data file to inquire.
!                           UNITS:      N/A
!                           TYPE:       CHARACTER(*)
!                           DIMENSION:  Scalar
!                           ATTRIBUTES: INTENT(IN)
!
! OPTIONAL OUTPUTS:
!       n_Dimensions:       The rank of the coefficient data array.
!                           UNITS:      N/A
!                           TYPE:       INTEGER
!                           DIMENSION:  Scalar
!                           ATTRIBUTES: INTENT(OUT), OPTIONAL
!
!       Dimensions:         The dimension values of the coefficient data array.
!                           UNITS:      N/A
!                           TYPE:       INTEGER
!                           DIMENSION:  Rank-1
!                           ATTRIBUTES: INTENT(OUT), OPTIONAL, ALLOCATABLE
!
!       Release:            The data/file release number. Used to check
!                           for data/software mismatch.
!                           UNITS:      N/A
!                           TYPE:       INTEGER
!                           DIMENSION:  Scalar
!                           ATTRIBUTES: INTENT(OUT), OPTIONAL
!
!       Version:            The data/file version number. Used for
!                           purposes only in identifying the dataset for
!                           a particular release.
!                           UNITS:      N/A
!                           TYPE:       INTEGER
!                           DIMENSION:  Scalar
!                           ATTRIBUTES: INTENT(OUT), OPTIONAL
!
!       Title:              Character string containing a succinct description
!                           of what is in the dataset.
!                           UNITS:      N/A
!                           TYPE:       CHARACTER(*)
!                           DIMENSION:  Scalar
!                           ATTRIBUTES: INTENT(OUT), OPTIONAL
!
!       History:            Character string containing dataset creation
!                           history.
!                           UNITS:      N/A
!                           TYPE:       CHARACTER(*)
!                           DIMENSION:  Scalar
!                           ATTRIBUTES: INTENT(OUT), OPTIONAL
!
!       Comment:            Character string containing any comments about
!                           the dataset.
!                           UNITS:      N/A
!                           TYPE:       CHARACTER(*)
!                           DIMENSION:  Scalar
!                           ATTRIBUTES: INTENT(OUT), 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 inquire was successful
!                              == FAILURE an unrecoverable error occurred.
!                           UNITS:      N/A
!                           TYPE:       INTEGER
!                           DIMENSION:  Scalar
!
!:sdoc-:
!------------------------------------------------------------------------------

  FUNCTION fitcoeff_inquirefile( &
    Filename    , &  ! Input
    n_Dimensions, &  ! Optional output
    Dimensions  , &  ! Optional output
    Release     , &  ! Optional output
    Version     , &  ! Optional output
    Title       , &  ! Optional output
    History     , &  ! Optional output
    Comment     ) &  ! Optional output
  result( err_stat )
    ! Arguments
    CHARACTER(*),                        INTENT(IN)  :: filename
    INTEGER     ,              OPTIONAL, INTENT(OUT) :: n_dimensions
    INTEGER     , ALLOCATABLE, OPTIONAL, INTENT(OUT) :: dimensions(:)
    INTEGER     ,              OPTIONAL, INTENT(OUT) :: release
    INTEGER     ,              OPTIONAL, INTENT(OUT) :: version
    CHARACTER(*),              OPTIONAL, INTENT(OUT) :: title  
    CHARACTER(*),              OPTIONAL, INTENT(OUT) :: history
    CHARACTER(*),              OPTIONAL, INTENT(OUT) :: comment
    ! Function result
    INTEGER :: err_stat
    ! Function parameters
    CHARACTER(*), PARAMETER :: routine_name = 'FitCoeff_InquireFile'
    ! Function variables
    CHARACTER(ML) :: msg
    CHARACTER(ML) :: io_msg
    INTEGER :: io_stat
    INTEGER :: alloc_stat
    INTEGER :: fid
    INTEGER :: rel
    INTEGER :: ver
    INTEGER :: n_dims
    INTEGER :: dims(fitcoeff_max_n_dimensions)
 
    ! Setup
    err_stat = success
    ! ...Check that the file exists
    IF ( .NOT. file_exists( 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 release and version
    READ( fid, iostat=io_stat, iomsg=io_msg ) &
      rel, &
      ver
    IF ( io_stat /= 0 ) THEN
      msg = 'Error reading Release/Version - '//trim(io_msg)
      CALL inquire_cleanup(); RETURN
    END IF
    IF ( .NOT. validrelease( rel ) ) THEN
      msg = 'FitCoeff Release check failed.'
      CALL inquire_cleanup(); RETURN
    END IF


    ! Read the dimension data
    ! ...The number of dimensions
    READ( fid, iostat=io_stat, iomsg=io_msg ) &
      n_dims      
    IF ( io_stat /= 0 ) THEN
      msg = 'Error reading number of dimensions from '//trim(filename)//' - '//trim(io_msg)
      CALL inquire_cleanup(); RETURN
    END IF
    ! ...Check the value
    IF ( n_dims > fitcoeff_max_n_dimensions ) THEN
      WRITE( msg,'("Number of dimensions (",i0,") in ",a," is greater than maximum allowed (",i0,")")' ) &
                 n_dims, trim(filename), fitcoeff_max_n_dimensions
      CALL inquire_cleanup(); RETURN
    END IF
    ! ...The dimension values
    READ( fid, iostat=io_stat, iomsg=io_msg ) &
      dims(1:n_dims)
    IF ( io_stat /= 0 ) THEN
      msg = 'Error reading dimension values from '//trim(filename)//' - '//trim(io_msg)
      CALL inquire_cleanup(); RETURN
    END IF


    ! Read the global attributes
    err_stat = readgatts_binary_file( &
                 fid, &
                 title   = title  , &
                 history = history, &
                 comment = comment  )
    IF ( err_stat /= success ) THEN
      msg = 'Error reading global attributes'
      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


    ! Assign the return arguments
    IF ( PRESENT(release     ) ) release      = rel        
    IF ( PRESENT(version     ) ) version      = ver        
    IF ( PRESENT(n_dimensions) ) n_dimensions = n_dims
    IF ( PRESENT(dimensions  ) ) THEN
      ALLOCATE(dimensions(n_dims), stat=alloc_stat)
      IF ( alloc_stat /= 0 ) THEN
        WRITE( msg,'("Error allocating output DIMENSIONS argument. STAT=",i0)') alloc_stat
        CALL inquire_cleanup(); RETURN
      END IF
      dimensions = dims(1:n_dims)
    END IF
    
  CONTAINS
  
    SUBROUTINE inquire_cleanup()
      ! Close file if necessary
      IF ( file_open(fid) ) 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
      ! Set error status and print error message
      err_stat = failure
      CALL display_message( routine_name, msg, err_stat )
    END SUBROUTINE inquire_cleanup
    
  END FUNCTION fitcoeff_inquirefile


!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       FitCoeff_ReadFile
!
! PURPOSE:
!       Function to read FitCoeff object files.
!
! CALLING SEQUENCE:
!       Error_Status = FitCoeff_ReadFile( &
!                        FitCoeff           , &
!                        Filename           , &
!                        No_Close = No_Close, &
!                        Quiet    = Quiet   , &
!                        Title    = Title   , &
!                        History  = History , &
!                        Comment  = Comment   )
!
! OBJECTS:
!       FitCoeff:       FitCoeff object containing the data read from file.
!                       While any FitCoeff data type can be used, the rank
!                       of the data in the file must correspond to the 
!                       datatype.
!                       UNITS:      N/A
!                       TYPE:       Any FitCoeff type
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(OUT)
!
! INPUTS:
!       Filename:       Character string specifying the name of a
!                       FitCoeff data file to read.
!                       UNITS:      N/A
!                       TYPE:       CHARACTER(*)
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(IN)
!
! OPTIONAL INPUTS:
!       No_Close:       Set this logical argument to *NOT* close the datafile
!                       upon exiting this routine. This option is required if
!                       the FitCoeff data is embedded within another file.
!                       If == .FALSE., File is closed upon function exit [DEFAULT].
!                          == .TRUE.,  File is NOT closed upon function exit
!                       If not specified, default is .FALSE.
!                       UNITS:      N/A
!                       TYPE:       LOGICAL
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(IN), OPTIONAL
!
!       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:
!       Title:          Character string containing a succinct description
!                       of what is in the dataset.
!                       UNITS:      N/A
!                       TYPE:       CHARACTER(*)
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(OUT), OPTIONAL
!
!       History:        Character string containing dataset creation
!                       history.
!                       UNITS:      N/A
!                       TYPE:       CHARACTER(*)
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(OUT), OPTIONAL
!
!       Comment:        Character string containing any comments about
!                       the dataset.
!                       UNITS:      N/A
!                       TYPE:       CHARACTER(*)
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(OUT), 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 read was successful
!                          == FAILURE, an unrecoverable error occurred.
!                       UNITS:      N/A
!                       TYPE:       INTEGER
!                       DIMENSION:  Scalar
!
!:sdoc-:
!------------------------------------------------------------------------------

  FUNCTION fitcoeff_1d_readfile( &
    FitCoeff, &  ! Output
    Filename, &  ! Input
    No_Close, &  ! Optional input
    Quiet   , &  ! Optional input
    Title   , &  ! Optional output
    History , &  ! Optional output
    Comment , &  ! Optional output
    Debug   ) &  ! Optional input (Debug output control)
  result( err_stat )
    ! Arguments
    TYPE(fitcoeff_1d_type), INTENT(OUT) :: fitcoeff
    CHARACTER(*),           INTENT(IN)  :: filename
    LOGICAL     , OPTIONAL, INTENT(IN)  :: no_close
    LOGICAL     , OPTIONAL, INTENT(IN)  :: quiet
    CHARACTER(*), OPTIONAL, INTENT(OUT) :: title
    CHARACTER(*), OPTIONAL, INTENT(OUT) :: history
    CHARACTER(*), OPTIONAL, INTENT(OUT) :: comment
    LOGICAL     , OPTIONAL, INTENT(IN)  :: debug
    ! Function result
    INTEGER :: err_stat
    ! Function parameters
    CHARACTER(*), PARAMETER :: routine_name = 'FitCoeff_ReadFile'
    ! Function variables
    TYPE(fitcoeff_1d_type) :: dummy
    ! Insert common code
    include 'FitCoeff_ReadFile.inc'
  END FUNCTION fitcoeff_1d_readfile


  FUNCTION fitcoeff_2d_readfile( &
    FitCoeff, &  ! Output
    Filename, &  ! Input
    No_Close, &  ! Optional input
    Quiet   , &  ! Optional input
    Title   , &  ! Optional output
    History , &  ! Optional output
    Comment , &  ! Optional output
    Debug   ) &  ! Optional input (Debug output control)
  result( err_stat )
    ! Arguments
    TYPE(fitcoeff_2d_type), INTENT(OUT) :: fitcoeff
    CHARACTER(*),           INTENT(IN)  :: filename
    LOGICAL     , OPTIONAL, INTENT(IN)  :: no_close
    LOGICAL     , OPTIONAL, INTENT(IN)  :: quiet
    CHARACTER(*), OPTIONAL, INTENT(OUT) :: title
    CHARACTER(*), OPTIONAL, INTENT(OUT) :: history
    CHARACTER(*), OPTIONAL, INTENT(OUT) :: comment
    LOGICAL     , OPTIONAL, INTENT(IN)  :: debug
    ! Function result
    INTEGER :: err_stat
    ! Function parameters
    CHARACTER(*), PARAMETER :: routine_name = 'FitCoeff_ReadFile'
    ! Function variables
    TYPE(fitcoeff_2d_type) :: dummy
    ! Insert common code
    include 'FitCoeff_ReadFile.inc'
  END FUNCTION fitcoeff_2d_readfile


  FUNCTION fitcoeff_3d_readfile( &
    FitCoeff, &  ! Output
    Filename, &  ! Input
    No_Close, &  ! Optional input
    Quiet   , &  ! Optional input
    Title   , &  ! Optional output
    History , &  ! Optional output
    Comment , &  ! Optional output
    Debug   ) &  ! Optional input (Debug output control)
  result( err_stat )
    ! Arguments
    TYPE(fitcoeff_3d_type), INTENT(OUT) :: fitcoeff
    CHARACTER(*),           INTENT(IN)  :: filename
    LOGICAL     , OPTIONAL, INTENT(IN)  :: no_close
    LOGICAL     , OPTIONAL, INTENT(IN)  :: quiet
    CHARACTER(*), OPTIONAL, INTENT(OUT) :: title
    CHARACTER(*), OPTIONAL, INTENT(OUT) :: history
    CHARACTER(*), OPTIONAL, INTENT(OUT) :: comment
    LOGICAL     , OPTIONAL, INTENT(IN)  :: debug
    ! Function result
    INTEGER :: err_stat
    ! Function parameters
    CHARACTER(*), PARAMETER :: routine_name = 'FitCoeff_ReadFile'
    ! Function variables
    TYPE(fitcoeff_3d_type) :: dummy
    ! Insert common code
    include 'FitCoeff_ReadFile.inc'
  END FUNCTION fitcoeff_3d_readfile


!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       FitCoeff_WriteFile
!
! PURPOSE:
!       Function to write FitCoeff object files.
!
! CALLING SEQUENCE:
!       Error_Status = FitCoeff_WriteFile( &
!                        FitCoeff           , &
!                        Filename           , &
!                        No_Close = No_Close, &
!                        Quiet    = Quiet   , &
!                        Title    = Title   , &
!                        History  = History , &
!                        Comment  = Comment   )
!
! OBJECTS:
!       FitCoeff:   FitCoeff object containing the data to write to file.
!                       UNITS:      N/A
!                       TYPE:       FitCoeff_type
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(IN)
!
! INPUTS:
!       Filename:       Character string specifying the name of a
!                       FitCoeff format data file to write.
!                       UNITS:      N/A
!                       TYPE:       CHARACTER(*)
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(IN)
!
! OPTIONAL INPUTS:
!       No_Close:       Set this logical argument to *NOT* close the datafile
!                       upon exiting this routine. This option is required if
!                       the FitCoeff data is to be embedded within another file.
!                       If == .FALSE., File is closed upon function exit [DEFAULT].
!                          == .TRUE.,  File is NOT closed upon function exit
!                       If not specified, default is .FALSE.
!                       UNITS:      N/A
!                       TYPE:       LOGICAL
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(IN), OPTIONAL
!
!       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
!
!       Title:          Character string containing a succinct description
!                       of what is in the dataset.
!                       UNITS:      N/A
!                       TYPE:       CHARACTER(*)
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(IN), OPTIONAL
!
!       History:        Character string containing dataset creation
!                       history.
!                       UNITS:      N/A
!                       TYPE:       CHARACTER(*)
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(IN), OPTIONAL
!
!       Comment:        Character string containing any comments about
!                       the dataset.
!                       UNITS:      N/A
!                       TYPE:       CHARACTER(*)
!                       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
!
!:sdoc-:
!------------------------------------------------------------------------------

  FUNCTION fitcoeff_1d_writefile( &
    FitCoeff, &  ! Input
    Filename, &  ! Input
    No_Close, &  ! Optional input
    Quiet   , &  ! Optional input
    Title   , &  ! Optional input
    History , &  ! Optional input
    Comment , &  ! Optional input
    Debug   ) &  ! Optional input (Debug output control)
  result( err_stat )
    ! Arguments
    TYPE(fitcoeff_1d_type), INTENT(IN) :: fitcoeff
    CHARACTER(*),           INTENT(IN) :: filename
    LOGICAL     , OPTIONAL, INTENT(IN) :: no_close
    LOGICAL     , OPTIONAL, INTENT(IN) :: quiet
    CHARACTER(*), OPTIONAL, INTENT(IN) :: title
    CHARACTER(*), OPTIONAL, INTENT(IN) :: history
    CHARACTER(*), OPTIONAL, INTENT(IN) :: comment
    LOGICAL     , OPTIONAL, INTENT(IN) :: debug
    ! Function result
    INTEGER :: err_stat
    ! Function parameters
    CHARACTER(*), PARAMETER :: routine_name = 'FitCoeff_WriteFile'
    ! Insert common code
    include 'FitCoeff_WriteFile.inc'
  END FUNCTION fitcoeff_1d_writefile

  
  FUNCTION fitcoeff_2d_writefile( &
    FitCoeff, &  ! Input
    Filename, &  ! Input
    No_Close, &  ! Optional input
    Quiet   , &  ! Optional input
    Title   , &  ! Optional input
    History , &  ! Optional input
    Comment , &  ! Optional input
    Debug   ) &  ! Optional input (Debug output control)
  result( err_stat )
    ! Arguments
    TYPE(fitcoeff_2d_type), INTENT(IN) :: fitcoeff
    CHARACTER(*),           INTENT(IN) :: filename
    LOGICAL     , OPTIONAL, INTENT(IN) :: no_close
    LOGICAL     , OPTIONAL, INTENT(IN) :: quiet
    CHARACTER(*), OPTIONAL, INTENT(IN) :: title
    CHARACTER(*), OPTIONAL, INTENT(IN) :: history
    CHARACTER(*), OPTIONAL, INTENT(IN) :: comment
    LOGICAL     , OPTIONAL, INTENT(IN) :: debug
    ! Function result
    INTEGER :: err_stat
    ! Function parameters
    CHARACTER(*), PARAMETER :: routine_name = 'FitCoeff_WriteFile'
    ! Insert common code
    include 'FitCoeff_WriteFile.inc'
  END FUNCTION fitcoeff_2d_writefile

  
  FUNCTION fitcoeff_3d_writefile( &
    FitCoeff, &  ! Input
    Filename, &  ! Input
    No_Close, &  ! Optional input
    Quiet   , &  ! Optional input
    Title   , &  ! Optional input
    History , &  ! Optional input
    Comment , &  ! Optional input
    Debug   ) &  ! Optional input (Debug output control)
  result( err_stat )
    ! Arguments
    TYPE(fitcoeff_3d_type), INTENT(IN) :: fitcoeff
    CHARACTER(*),           INTENT(IN) :: filename
    LOGICAL     , OPTIONAL, INTENT(IN) :: no_close
    LOGICAL     , OPTIONAL, INTENT(IN) :: quiet
    CHARACTER(*), OPTIONAL, INTENT(IN) :: title
    CHARACTER(*), OPTIONAL, INTENT(IN) :: history
    CHARACTER(*), OPTIONAL, INTENT(IN) :: comment
    LOGICAL     , OPTIONAL, INTENT(IN) :: debug
    ! Function result
    INTEGER :: err_stat
    ! Function parameters
    CHARACTER(*), PARAMETER :: routine_name = 'FitCoeff_WriteFile'
    ! Insert common code
    include 'FitCoeff_WriteFile.inc'
  END FUNCTION fitcoeff_3d_writefile

  
!################################################################################
!################################################################################
!##                                                                            ##
!##                          ## PRIVATE PROCEDURES ##                          ##
!##                                                                            ##
!################################################################################
!################################################################################

!--------------------------------------------------------------------------------
!
! NAME:
!       FitCoeff_Equal
!
! PURPOSE:
!       Pure function to test the equality of two FitCoeff objects.
!       Used in OPERATOR(==) interface block.
!
! CALLING SEQUENCE:
!       is_equal = FitCoeff_Equal( x, y )
!
!         or
!
!       IF ( x == y ) THEN
!         ...
!       END IF
!
! OBJECTS:
!       x, y:          Two FitCoeff objects to be compared.
!                      UNITS:      N/A
!                      TYPE:       Any FitCoeff 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.
!
!--------------------------------------------------------------------------------

  PURE FUNCTION fitcoeff_1d_equal( x, y ) RESULT( is_equal )
    TYPE(fitcoeff_1d_type), INTENT(IN) :: x, y
    include 'FitCoeff_Equal.inc'
  END FUNCTION fitcoeff_1d_equal


  PURE FUNCTION fitcoeff_2d_equal( x, y ) RESULT( is_equal )
    TYPE(fitcoeff_2d_type), INTENT(IN) :: x, y
    include 'FitCoeff_Equal.inc'
  END FUNCTION fitcoeff_2d_equal


  PURE FUNCTION fitcoeff_3d_equal( x, y ) RESULT( is_equal )
    TYPE(fitcoeff_3d_type), INTENT(IN) :: x, y
    include 'FitCoeff_Equal.inc'
  END FUNCTION fitcoeff_3d_equal

END MODULE fitcoeff_define