<HTML> <BODY BGCOLOR=#ccccdd LINK=#0000aa VLINK=#0000ff ALINK=#ff0000 ><BASE TARGET="bottom_target"><PRE>
!
! CSvar_Define
!
! Module defining the CRTM CloudScatter module internal
! variable object.
!
!
! CREATION HISTORY:
! Written by: Paul van Delst, 14-Feb-2012
! paul.vandelst@noaa.gov
!
<A NAME='CSVAR_DEFINE'><A href='../../html_code/crtm/CSvar_Define.f90.html#CSVAR_DEFINE' TARGET='top_target'><IMG SRC="../../gif/bar_purple.gif" border=0></A>
MODULE CSvar_Define 5,8
! -----------------
! Environment setup
! -----------------
! Module use
USE Type_Kinds
, ONLY: fp
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
USE CRTM_Interpolation , ONLY: NPTS , &
LPoly_type
! Disable implicit typing
IMPLICIT NONE
! ------------
! Visibilities
! ------------
! Everything private by default
PRIVATE
! Datatypes
PUBLIC :: CSvar_type
PUBLIC :: CSinterp_type
! Operators
PUBLIC :: OPERATOR(==)
! Procedures
PUBLIC :: CSvar_Associated
PUBLIC :: CSvar_Destroy
PUBLIC :: CSvar_Create
PUBLIC :: CSvar_Inspect
PUBLIC :: CSvar_ValidRelease
PUBLIC :: CSvar_Info
PUBLIC :: CSvar_DefineVersion
PUBLIC :: CSvar_InquireFile
PUBLIC :: CSvar_ReadFile
PUBLIC :: CSvar_WriteFile
! ---------------------
! Procedure overloading
! ---------------------
<A NAME='OPERATOR'><A href='../../html_code/crtm/CSvar_Define.f90.html#OPERATOR' TARGET='top_target'><IMG SRC="../../gif/bar_red.gif" border=0></A>
INTERFACE OPERATOR(==)
MODULE PROCEDURE
END INTERFACE OPERATOR(==)
! -----------------
! Module parameters
! -----------------
CHARACTER(*), PARAMETER :: MODULE_VERSION_ID = &
'$Id: CSvar_Define.f90 29405 2013-06-20 20:19:52Z paul.vandelst@noaa.gov $'
! Release and version
INTEGER, PARAMETER :: CSVAR_RELEASE = 1 ! This determines structure and file formats.
INTEGER, PARAMETER :: CSVAR_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
! ---------------------
! Structure definitions
! ---------------------
! The interpolation routine structure
TYPE :: CSinterp_type
! The interpolating polynomials
TYPE(LPoly_type) :: wlp ! Frequency
TYPE(LPoly_type) :: xlp ! Effective radius
TYPE(LPoly_type) :: ylp ! Temperature
! The LUT interpolation indices
INTEGER :: i1, i2 ! Frequency
INTEGER :: j1, j2 ! Effective radius
INTEGER :: k1, k2 ! Temperature
! The LUT interpolation boundary check
LOGICAL :: f_outbound ! Frequency
LOGICAL :: r_outbound ! Effective radius
LOGICAL :: t_outbound ! Temperature
! The interpolation input
REAL(fp) :: f_int ! Frequency
REAL(fp) :: r_int ! Effective radius
REAL(fp) :: t_int ! Temperature
! The data to be interpolated
REAL(fp) :: f(NPTS) ! Frequency
REAL(fp) :: r(NPTS) ! Effective radius
REAL(fp) :: t(NPTS) ! Temperature
END TYPE CSinterp_type
! The internal variable definition to hold information
! between FWD, TL, AD, and K-matrix calls
TYPE :: CSvar_type
! Allocation indicator
LOGICAL :: Is_Allocated = .FALSE.
! Release and version information
INTEGER :: Release = CSVAR_RELEASE
INTEGER :: Version = CSVAR_VERSION
! Dimensions
INTEGER :: n_Legendre_Terms = 0 ! I1
INTEGER :: n_Phase_Elements = 0 ! I2
INTEGER :: n_Layers = 0 ! I3
INTEGER :: n_Clouds = 0 ! I4
! The interpolating data
TYPE(CSinterp_type), ALLOCATABLE :: csi(:,:) ! I3 x I4
! The interpolation results
REAL(fp), ALLOCATABLE :: ke(:,:) ! I3 x I4 Mass extinction coefficient
REAL(fp), ALLOCATABLE :: w(:,:) ! I3 x I4 Single Scatter Albedo
REAL(fp), ALLOCATABLE :: g(:,:) ! I3 x I4 Asymmetry factor
REAL(fp), ALLOCATABLE :: pcoeff(:,:,:,:) ! 0:I1 x I2 x I3 x I4 Phase coefficients
! The accumulated scattering coefficient
REAL(fp), ALLOCATABLE :: total_bs(:) ! I3 Volume scattering coefficient
END TYPE CSvar_type
CONTAINS
!################################################################################
!################################################################################
!## ##
!## ## PUBLIC PROCEDURES ## ##
!## ##
!################################################################################
!################################################################################
<A NAME='CSVAR_ASSOCIATED'><A href='../../html_code/crtm/CSvar_Define.f90.html#CSVAR_ASSOCIATED' TARGET='top_target'><IMG SRC="../../gif/bar_green.gif" border=0></A>
ELEMENTAL FUNCTION CSvar_Associated( self ) RESULT( Status )
TYPE(CSvar_type), INTENT(IN) :: self
LOGICAL :: Status
Status = self%Is_Allocated
END FUNCTION CSvar_Associated
<A NAME='CSVAR_DESTROY'><A href='../../html_code/crtm/CSvar_Define.f90.html#CSVAR_DESTROY' TARGET='top_target'><IMG SRC="../../gif/bar_red.gif" border=0></A>
ELEMENTAL SUBROUTINE CSvar_Destroy( self ) 1
TYPE(CSvar_type), INTENT(OUT) :: self
self%Is_Allocated = .FALSE.
self%n_Legendre_Terms = 0
self%n_Phase_Elements = 0
self%n_Layers = 0
self%n_Clouds = 0
END SUBROUTINE CSvar_Destroy
<A NAME='CSVAR_CREATE'><A href='../../html_code/crtm/CSvar_Define.f90.html#CSVAR_CREATE' TARGET='top_target'><IMG SRC="../../gif/bar_red.gif" border=0></A>
ELEMENTAL SUBROUTINE CSvar_Create( & 5
self , & ! Output
n_Legendre_Terms, & ! Input
n_Phase_Elements, & ! Input
n_Layers , & ! Input
n_Clouds ) ! Input
! Arguments
TYPE(CSvar_type), INTENT(OUT) :: self
INTEGER , INTENT(IN) :: n_Legendre_Terms
INTEGER , INTENT(IN) :: n_Phase_Elements
INTEGER , INTENT(IN) :: n_Layers
INTEGER , INTENT(IN) :: n_Clouds
! Local variables
INTEGER :: alloc_stat
! Check input
IF ( n_Legendre_Terms < 1 .OR. &
n_Phase_Elements < 1 .OR. &
n_Layers < 1 .OR. &
n_Clouds < 1 ) RETURN
! Perform the allocation
ALLOCATE( self%csi(n_Layers, n_Clouds), &
self%ke(n_Layers, n_Clouds), &
self%w(n_Layers, n_Clouds), &
self%g(n_Layers, n_Clouds), &
self%pcoeff(0:n_Legendre_Terms,n_Phase_Elements,n_Layers, n_Clouds), &
self%total_bs(n_Layers), &
STAT = alloc_stat )
IF ( alloc_stat /= 0 ) RETURN
! Initialise dimensions only!
self%n_Legendre_Terms = n_Legendre_Terms
self%n_Phase_Elements = n_Phase_Elements
self%n_Layers = n_Layers
self%n_Clouds = n_Clouds
! Set allocation indicator
self%Is_Allocated = .TRUE.
END SUBROUTINE CSvar_Create
<A NAME='CSVAR_INSPECT'><A href='../../html_code/crtm/CSvar_Define.f90.html#CSVAR_INSPECT' TARGET='top_target'><IMG SRC="../../gif/bar_red.gif" border=0></A>
SUBROUTINE CSvar_Inspect( self)
TYPE(CSvar_type), INTENT(IN) :: self
INTEGER :: i2, i3, i4
WRITE(*,'(1x,"CSvar OBJECT")')
! Release/version info
WRITE(*,'(3x,"Release.Version :",1x,i0,".",i0)') self%Release, self%Version
! Dimensions
WRITE(*,'(3x,"n_Legendre_Terms :",1x,i0)') self%n_Legendre_Terms
WRITE(*,'(3x,"n_Phase_Elements :",1x,i0)') self%n_Phase_Elements
WRITE(*,'(3x,"n_Layers :",1x,i0)') self%n_Layers
WRITE(*,'(3x,"n_Clouds :",1x,i0)') self%n_Clouds
IF ( .NOT. CSvar_Associated(self) ) RETURN
! Data
WRITE(*,'(3x,"Mass extinction coefficient (ke) :")')
DO i4 = 1, self%n_Clouds
WRITE(*,'(5x,"ke Cloud index #",i0)') i4
WRITE(*,'(5(1x,es13.6,:))') self%ke(:,i4)
END DO
WRITE(*,'(3x,"Single scatter albedo (w) :")')
DO i4 = 1, self%n_Clouds
WRITE(*,'(5x,"w Cloud index #",i0)') i4
WRITE(*,'(5(1x,es13.6,:))') self%w(:,i4)
END DO
WRITE(*,'(3x,"Asymmetry factor (g) :")')
DO i4 = 1, self%n_Clouds
WRITE(*,'(5x,"g Cloud index #",i0)') i4
WRITE(*,'(5(1x,es13.6,:))') self%g(:,i4)
END DO
WRITE(*,'(3x,"Phase coefficients (pcoeff) :")')
DO i4 = 1, self%n_Clouds
WRITE(*,'(5x,"pcoeff Cloud index #",i0)') i4
DO i3 = 1, self%n_Layers
WRITE(*,'(7x,"pcoeff Layer index #",i0)') i3
DO i2 = 1, self%n_Phase_Elements
WRITE(*,'(9x,"pcoeff Phase element index #",i0)') i2
WRITE(*,'(5(1x,es13.6,:))') self%pcoeff(0:,i2,i3,i4)
END DO
END DO
END DO
WRITE(*,'(3x,"Volume scattering coefficient (total_bs) :")')
WRITE(*,'(5(1x,es13.6,:))') self%total_bs
END SUBROUTINE CSvar_Inspect
<A NAME='CSVAR_VALIDRELEASE'><A href='../../html_code/crtm/CSvar_Define.f90.html#CSVAR_VALIDRELEASE' TARGET='top_target'><IMG SRC="../../gif/bar_green.gif" border=0></A>
FUNCTION CSvar_ValidRelease( self ) RESULT( IsValid ),2
! Arguments
TYPE(CSvar_type), INTENT(IN) :: self
! Function result
LOGICAL :: IsValid
! Local parameters
CHARACTER(*), PARAMETER :: ROUTINE_NAME = 'CSvar_ValidRelease'
! Local variables
CHARACTER(ML) :: msg
! Set up
IsValid = .TRUE.
! Check release is not too old
IF ( self%Release < CSVAR_RELEASE ) THEN
IsValid = .FALSE.
WRITE( msg,'("An CSvar data update is needed. ", &
&"CSvar release is ",i0,". Valid release is ",i0,"." )' ) &
self%Release, CSVAR_RELEASE
CALL Display_Message( ROUTINE_NAME, msg, INFORMATION ); RETURN
END IF
! Check release is not too new
IF ( self%Release > CSVAR_RELEASE ) THEN
IsValid = .FALSE.
WRITE( msg,'("An CSvar software update is needed. ", &
&"CSvar release is ",i0,". Valid release is ",i0,"." )' ) &
self%Release, CSVAR_RELEASE
CALL Display_Message( ROUTINE_NAME, msg, INFORMATION ); RETURN
END IF
END FUNCTION CSvar_ValidRelease
<A NAME='CSVAR_INFO'><A href='../../html_code/crtm/CSvar_Define.f90.html#CSVAR_INFO' TARGET='top_target'><IMG SRC="../../gif/bar_red.gif" border=0></A>
SUBROUTINE CSvar_Info( self, Info ) 2
! Arguments
TYPE(CSvar_type), INTENT(IN) :: self
CHARACTER(*), INTENT(OUT) :: Info
! Parameters
INTEGER, PARAMETER :: CARRIAGE_RETURN = 13
INTEGER, PARAMETER :: LINEFEED = 10
! Local variables
CHARACTER(2000) :: Long_String
! Write the required data to the local string
WRITE( Long_String, &
'(a,1x,"CSvar RELEASE.VERSION: ",i2,".",i2.2,a,3x, &
&"N_LEGENDRE_TERMS=",i0,2x,&
&"N_PHASE_ELEMENTS=",i0,2x,&
&"N_LAYERS=",i0,2x,&
&"N_CLOUDS=",i0 )' ) &
ACHAR(CARRIAGE_RETURN)//ACHAR(LINEFEED), &
self%Release, self%Version, &
ACHAR(CARRIAGE_RETURN)//ACHAR(LINEFEED), &
self%n_Legendre_Terms, &
self%n_Phase_Elements, &
self%n_Layers , &
self%n_Clouds
! Trim the output based on the
! dummy argument string length
Info = Long_String(1:MIN(LEN(Info), LEN_TRIM(Long_String)))
END SUBROUTINE CSvar_Info
<A NAME='CSVAR_DEFINEVERSION'><A href='../../html_code/crtm/CSvar_Define.f90.html#CSVAR_DEFINEVERSION' TARGET='top_target'><IMG SRC="../../gif/bar_red.gif" border=0></A>
SUBROUTINE CSvar_DefineVersion( Id )
CHARACTER(*), INTENT(OUT) :: Id
Id = MODULE_VERSION_ID
END SUBROUTINE CSvar_DefineVersion
<A NAME='CSVAR_INQUIREFILE'><A href='../../html_code/crtm/CSvar_Define.f90.html#CSVAR_INQUIREFILE' TARGET='top_target'><IMG SRC="../../gif/bar_green.gif" border=0></A>
FUNCTION CSvar_InquireFile( &,9
Filename , & ! Input
n_Legendre_Terms, & ! Optional output
n_Phase_Elements, & ! Optional output
n_Layers , & ! Optional output
n_Clouds , & ! 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_Legendre_Terms
INTEGER , OPTIONAL, INTENT(OUT) :: n_Phase_Elements
INTEGER , OPTIONAL, INTENT(OUT) :: n_Layers
INTEGER , OPTIONAL, INTENT(OUT) :: n_Clouds
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 = 'CSvar_InquireFile'
! Function variables
CHARACTER(ML) :: msg
CHARACTER(ML) :: io_msg
INTEGER :: io_stat
INTEGER :: fid
TYPE(CSvar_type) :: CSvar
! 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 ) &
CSvar%Release, &
CSvar%Version
IF ( io_stat /= 0 ) THEN
msg = 'Error reading Release/Version - '//TRIM(io_msg)
CALL Inquire_Cleanup(); RETURN
END IF
IF ( .NOT. CSvar_ValidRelease( CSvar ) ) THEN
msg = 'CSvar Release check failed.'
CALL Inquire_Cleanup(); RETURN
END IF
! Read the dimensions
READ( fid, IOSTAT=io_stat, IOMSG=io_msg ) &
CSvar%n_Legendre_Terms, &
CSvar%n_Phase_Elements, &
CSvar%n_Layers , &
CSvar%n_Clouds
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(n_Legendre_Terms) ) n_Legendre_Terms = CSvar%n_Legendre_Terms
IF ( PRESENT(n_Phase_Elements) ) n_Phase_Elements = CSvar%n_Phase_Elements
IF ( PRESENT(n_Layers ) ) n_Layers = CSvar%n_Layers
IF ( PRESENT(n_Clouds ) ) n_Clouds = CSvar%n_Clouds
IF ( PRESENT(Release ) ) Release = CSvar%Release
IF ( PRESENT(Version ) ) Version = CSvar%Version
CONTAINS
<A NAME='INQUIRE_CLEANUP'><A href='../../html_code/crtm/CSvar_Define.f90.html#INQUIRE_CLEANUP' TARGET='top_target'><IMG SRC="../../gif/bar_red.gif" border=0></A>
SUBROUTINE Inquire_CleanUp() 158,27
! 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 CSvar_InquireFile
<A NAME='CSVAR_READFILE'><A href='../../html_code/crtm/CSvar_Define.f90.html#CSVAR_READFILE' TARGET='top_target'><IMG SRC="../../gif/bar_green.gif" border=0></A>
FUNCTION CSvar_ReadFile( &,19
CSvar , & ! 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(CSvar_type), INTENT(OUT) :: CSvar
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 = 'CSvar_ReadFile'
! Function variables
CHARACTER(ML) :: msg
CHARACTER(ML) :: io_msg
LOGICAL :: close_file
LOGICAL :: noisy
INTEGER :: io_stat
INTEGER :: fid
TYPE(CSvar_type) :: dummy
! Setup
err_stat = SUCCESS
! ...Check No_Close argument
close_file = .TRUE.
IF ( PRESENT(No_Close) ) close_file = .NOT. No_Close
! ...Check Quiet argument
noisy = .TRUE.
IF ( PRESENT(Quiet) ) noisy = .NOT. Quiet
! ...Override Quiet settings if debug set.
IF ( PRESENT(Debug) ) THEN
IF ( Debug ) noisy = .TRUE.
END IF
! Check if the file is open.
IF ( File_Open( Filename ) ) THEN
! ...Inquire for the logical unit number
INQUIRE( FILE=Filename, NUMBER=fid )
! ...Ensure it's valid
IF ( fid < 0 ) THEN
msg = 'Error inquiring '//TRIM(Filename)//' for its FileID'
CALL Read_CleanUp(); RETURN
END IF
ELSE
! ...Open the file if it exists
IF ( File_Exists( Filename ) ) THEN
err_stat = Open_Binary_File( Filename, fid )
IF ( err_Stat /= SUCCESS ) THEN
msg = 'Error opening '//TRIM(Filename)
CALL Read_CleanUp(); RETURN
END IF
ELSE
msg = 'File '//TRIM(Filename)//' not found.'
CALL Read_CleanUp(); RETURN
END IF
END IF
! Read and check the release and version
READ( fid, IOSTAT=io_stat, IOMSG=io_msg ) &
dummy%Release, &
dummy%Version
IF ( io_stat /= 0 ) THEN
msg = 'Error reading Release/Version - '//TRIM(io_msg)
CALL Read_Cleanup(); RETURN
END IF
IF ( .NOT. CSvar_ValidRelease( dummy ) ) THEN
msg = 'CSvar Release check failed.'
CALL Read_Cleanup(); RETURN
END IF
! Read the dimensions
READ( fid, IOSTAT=io_stat, IOMSG=io_msg ) &
dummy%n_Legendre_Terms, &
dummy%n_Phase_Elements, &
dummy%n_Layers , &
dummy%n_Clouds
IF ( io_stat /= 0 ) THEN
msg = 'Error reading data dimensions - '//TRIM(io_msg)
CALL Read_Cleanup(); RETURN
END IF
! ...Allocate the object
CALL CSvar_Create( &
CSvar , &
dummy%n_Legendre_Terms, &
dummy%n_Phase_Elements, &
dummy%n_Layers , &
dummy%n_Clouds )
IF ( .NOT. CSvar_Associated( CSvar ) ) THEN
msg = 'CSvar object allocation failed.'
CALL Read_Cleanup(); RETURN
END IF
! ...Explicitly assign the version number
CSvar%Version = dummy%Version
! 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 Read_Cleanup(); RETURN
END IF
! Read the data
! ...Mass extinction coefficient
READ( fid, IOSTAT=io_stat, IOMSG=io_msg ) &
CSvar%ke
IF ( io_stat /= 0 ) THEN
msg = 'Error reading mass extinction coefficient - '//TRIM(io_msg)
CALL Read_Cleanup(); RETURN
END IF
! ...Single scatter albedo
READ( fid, IOSTAT=io_stat, IOMSG=io_msg ) &
CSvar%w
IF ( io_stat /= 0 ) THEN
msg = 'Error reading single scatter albedo - '//TRIM(io_msg)
CALL Read_Cleanup(); RETURN
END IF
! ...Asymmetry factor
READ( fid, IOSTAT=io_stat, IOMSG=io_msg ) &
CSvar%g
IF ( io_stat /= 0 ) THEN
msg = 'Error reading asymmetry factor - '//TRIM(io_msg)
CALL Read_Cleanup(); RETURN
END IF
! ...Phase coefficients
READ( fid, IOSTAT=io_stat, IOMSG=io_msg ) &
CSvar%pcoeff
IF ( io_stat /= 0 ) THEN
msg = 'Error reading phase coefficients - '//TRIM(io_msg)
CALL Read_Cleanup(); RETURN
END IF
! ...Total volume scattering coefficient
READ( fid, IOSTAT=io_stat, IOMSG=io_msg ) &
CSvar%total_bs
IF ( io_stat /= 0 ) THEN
msg = 'Error reading total volume scattering coefficient - '//TRIM(io_msg)
CALL Read_Cleanup(); RETURN
END IF
! Close the file
IF ( close_file ) THEN
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
END IF
! Output an info message
IF ( noisy ) THEN
CALL CSvar_Info( CSvar, msg )
CALL Display_Message( ROUTINE_NAME, 'FILE: '//TRIM(Filename)//'; '//TRIM(msg), INFORMATION )
END IF
CONTAINS
<A NAME='READ_CLEANUP'><A href='../../html_code/crtm/CSvar_Define.f90.html#READ_CLEANUP' TARGET='top_target'><IMG SRC="../../gif/bar_red.gif" border=0></A>
SUBROUTINE Read_CleanUp() 334,61
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 CSvar_Destroy( CSvar )
err_stat = FAILURE
CALL Display_Message( ROUTINE_NAME, msg, err_stat )
END SUBROUTINE Read_CleanUp
END FUNCTION CSvar_ReadFile
<A NAME='CSVAR_WRITEFILE'><A href='../../html_code/crtm/CSvar_Define.f90.html#CSVAR_WRITEFILE' TARGET='top_target'><IMG SRC="../../gif/bar_green.gif" border=0></A>
FUNCTION CSvar_WriteFile( &,16
CSvar , & ! 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(CSvar_type), INTENT(IN) :: CSvar
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 = 'CSvar_WriteFile'
! Function variables
CHARACTER(ML) :: msg
CHARACTER(ML) :: io_msg
LOGICAL :: close_file
LOGICAL :: noisy
INTEGER :: io_stat
INTEGER :: fid
! Setup
err_stat = SUCCESS
! ...Check No_Close argument
close_file = .TRUE.
IF ( PRESENT(No_Close) ) close_file = .NOT. No_Close
! ...Check Quiet argument
noisy = .TRUE.
IF ( PRESENT(Quiet) ) noisy = .NOT. Quiet
! ...Override Quiet settings if debug set.
IF ( PRESENT(Debug) ) THEN
IF ( Debug ) noisy = .TRUE.
END IF
! ...Check there is data to write
IF ( .NOT. CSvar_Associated( CSvar ) ) THEN
msg = 'CSvar object is empty.'
CALL Write_Cleanup(); RETURN
END IF
! Check if the file is open.
IF ( File_Open( FileName ) ) THEN
! ...Inquire for the logical unit number
INQUIRE( FILE=Filename, NUMBER=fid )
! ...Ensure it's valid
IF ( fid < 0 ) THEN
msg = 'Error inquiring '//TRIM(Filename)//' for its FileID'
CALL Write_CleanUp(); RETURN
END IF
ELSE
! ...Open the file for output
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
END IF
! Write the release and version
WRITE( fid, IOSTAT=io_stat, IOMSG=io_msg ) &
CSvar%Release, &
CSvar%Version
IF ( io_stat /= 0 ) THEN
msg = 'Error writing Release/Version - '//TRIM(io_msg)
CALL Write_Cleanup(); RETURN
END IF
! Write the dimensions
WRITE( fid, IOSTAT=io_stat, IOMSG=io_msg ) &
CSvar%n_Legendre_Terms, &
CSvar%n_Phase_Elements, &
CSvar%n_Layers , &
CSvar%n_Clouds
IF ( io_stat /= 0 ) THEN
msg = 'Error writing data dimensions - '//TRIM(io_msg)
CALL Write_Cleanup(); RETURN
END IF
! Write the global attributes
err_stat = WriteGAtts_Binary_File( &
fid, &
Write_Module = MODULE_VERSION_ID, &
Title = Title , &
History = History, &
Comment = Comment )
IF ( err_stat /= SUCCESS ) THEN
msg = 'Error writing global attributes'
CALL Write_Cleanup(); RETURN
END IF
! Write the data
! ...Mass extinction coefficient
WRITE( fid, IOSTAT=io_stat, IOMSG=io_msg ) &
CSvar%ke
IF ( io_stat /= 0 ) THEN
msg = 'Error writing mass extinction coefficient - '//TRIM(io_msg)
CALL Write_Cleanup(); RETURN
END IF
! ...Single scatter albedo
WRITE( fid, IOSTAT=io_stat, IOMSG=io_msg ) &
CSvar%w
IF ( io_stat /= 0 ) THEN
msg = 'Error writing single scatter albedo - '//TRIM(io_msg)
CALL Write_Cleanup(); RETURN
END IF
! ...Asymmetry factor
WRITE( fid, IOSTAT=io_stat, IOMSG=io_msg ) &
CSvar%g
IF ( io_stat /= 0 ) THEN
msg = 'Error writing asymmetry factor - '//TRIM(io_msg)
CALL Write_Cleanup(); RETURN
END IF
! ...Phase coefficients
WRITE( fid, IOSTAT=io_stat, IOMSG=io_msg ) &
CSvar%pcoeff
IF ( io_stat /= 0 ) THEN
msg = 'Error writing phase coefficients - '//TRIM(io_msg)
CALL Write_Cleanup(); RETURN
END IF
! ...Total volume scattering coefficient
WRITE( fid, IOSTAT=io_stat, IOMSG=io_msg ) &
CSvar%total_bs
IF ( io_stat /= 0 ) THEN
msg = 'Error writing total volume scattering coefficient - '//TRIM(io_msg)
CALL Write_Cleanup(); RETURN
END IF
! Close the file
IF ( close_file ) THEN
CLOSE( fid, 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
END IF
! Output an info message
IF ( noisy ) THEN
CALL CSvar_Info( CSvar, msg )
CALL Display_Message( ROUTINE_NAME, 'FILE: '//TRIM(Filename)//'; '//TRIM(msg), INFORMATION )
END IF
CONTAINS
<A NAME='WRITE_CLEANUP'><A href='../../html_code/crtm/CSvar_Define.f90.html#WRITE_CLEANUP' TARGET='top_target'><IMG SRC="../../gif/bar_red.gif" border=0></A>
SUBROUTINE Write_Cleanup() 283,32
IF ( File_Open(Filename) ) THEN
CLOSE( fid, IOSTAT=io_stat, IOMSG=io_msg )
IF ( io_stat /= 0 ) &
msg = TRIM(msg)//'; Error closing 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 CSvar_WriteFile
!################################################################################
!################################################################################
!## ##
!## ## PRIVATE PROCEDURES ## ##
!## ##
!################################################################################
!################################################################################
<A NAME='CSVAR_EQUAL'><A href='../../html_code/crtm/CSvar_Define.f90.html#CSVAR_EQUAL' TARGET='top_target'><IMG SRC="../../gif/bar_green.gif" border=0></A>
ELEMENTAL FUNCTION CSvar_Equal( x, y ) RESULT( is_equal ) 1
TYPE(CSvar_type), INTENT(IN) :: x, y
LOGICAL :: is_equal
! Set up
is_equal = .FALSE.
! Check the object association status
IF ( (.NOT. CSvar_Associated(x)) .OR. &
(.NOT. CSvar_Associated(y)) ) RETURN
! Check contents
! ...Release/version info
IF ( (x%Release /= y%Release) .OR. &
(x%Version /= y%Version) ) RETURN
! ...Dimensions
IF ( (x%n_Legendre_Terms /= y%n_Legendre_Terms ) .OR. &
(x%n_Phase_Elements /= y%n_Phase_Elements ) .OR. &
(x%n_Layers /= y%n_Layers ) .OR. &
(x%n_Clouds /= y%n_Clouds ) ) RETURN
! ...Arrays
IF ( ALL(x%ke .EqualTo. y%ke ) .AND. &
ALL(x%w .EqualTo. y%w ) .AND. &
ALL(x%g .EqualTo. y%g ) .AND. &
ALL(x%pcoeff .EqualTo. y%pcoeff ) .AND. &
ALL(x%total_bs .EqualTo. y%total_bs ) ) &
is_equal = .TRUE.
END FUNCTION CSvar_Equal
END MODULE CSvar_Define