Remove requirement for photolysis data directories to end with slash

[lizziel]

Name and Institution (Required)

Name: Lizzie Lundgren
Institution: Harvard University

Describe the update

This PR removes the expectation that data directories used for lookup tables read in photolysis_mod.F90 gave a trailing slash. This gives greater flexibility with defining these paths externally to the model.

Expected changes

This is a no diff update.

Reference(s)

None

Related Github Issue(s)

None

[yantosca]

@lizziel: I just remembered we have this routine in GeosCore/input_mod.F90:

!EOC
!------------------------------------------------------------------------------
!                  GEOS-Chem Global Chemical Transport Model                  !
!------------------------------------------------------------------------------
!BOP
!
! !IROUTINE: check_directory
!
! !DESCRIPTION: Makes sure that the given directory is valid.  Also a trailing
!  slash character will be added if necessary.
!\\
!\\
! !INTERFACE:
!
  SUBROUTINE Check_Directory( Input_Opt, dir, RC )
!
! !USES:
!
    USE ErrCode_Mod
    USE FILE_MOD,      ONLY : File_Exists
    USE Input_Opt_Mod, ONLY : OptInput
!
! !INPUT/OUTPUT PARAMETERS:
!
    TYPE(OptInput),   INTENT(INOUT) :: Input_Opt   ! Input Options object
    CHARACTER(LEN=*), INTENT(INOUT) :: dir         ! Dir to be checked
!
! !OUTPUT PARAMETERS:
!
    INTEGER,          INTENT(OUT)   :: RC          ! Success or failure
!
! !REVISION HISTORY:
!  20 Mar 2003 - R. Yantosca - Initial version
!  See https://github.com/geoschem/geos-chem for complete history
!EOP
!------------------------------------------------------------------------------
!BOC
!
! !LOCAL VARIABLES:
!
    ! Scalars
    INTEGER            :: C

    ! Strings
    CHARACTER(LEN=255) :: errMsg, thisLoc

    !=================================================================
    ! Check_Directory begins here!
    !=================================================================

    ! Initialize
    RC      = GC_SUCCESS
    errMsg  = ''
    thisLoc = ' -> at Check_Directory (in module GeosCore/input_mod.F90)'

    ! Locate the last non-white-space character of NEWDIR
    C = LEN_TRIM( dir )

    ! Add the trailing directory separator if it is not present
    IF ( dir(C:C) /= '/' ) THEN
       dir(C+1:C+1) = TRIM( '/' )
    ENDIF

    !=================================================================
    ! Test if the directory actually exists
    !=================================================================

    ! If the directory does not exist then stop w/ an error message
    IF ( .not. File_Exists( dir ) ) THEN
       errMsg = 'Invalid directory: ' // TRIM( dir )
       CALL GC_Error( errMsg, RC, thisLoc )
       RETURN
    ENDIF

  END SUBROUTINE Check_Directory

So we could write a function to do something like this:

    ! Locate the last non-white-space character of NEWDIR
    C = LEN_TRIM( dir )

    ! Remove the trailing directory separator if it is not present
    IF ( dir(C:C) /= '/' ) THEN
       dir = TRIM( dir(1:C-1) )
    ENDIF

[lizziel]

CESM does not use input_mod.F90 to set the paths, but reads it from a namelist xml file. The convention for those files is to not include a trailing slash.

[yantosca]

CESM does not use input_mod.F90 to set the paths, but reads it from a namelist xml file. The convention for those files is to not include a trailing slash.

Ah OK. I thought we could parse it on the GEOS-Chem side but maybe that's not possible here.

[yantosca]

This is a simple fix and I approve it. Thanks @lizziel. I will bring this into 14.3.1.

[yantosca]

All GEOS-Chem Classic integration tests passed:

==============================================================================
GEOS-Chem Classic: Execution Test Results

GCClassic #fc586ba GEOS-Chem submod update: Merge PR #2226 (Fix bug for ST80_25 tracer)
GEOS-Chem #a18588576 Merge PR 2225# (Don't expect photolysis dirs to end in "/")
HEMCO     #2a4bb12 Merge PR #268 (Handle 3D NEI emissions)

Using 24 OpenMP threads
Number of execution tests: 26

Submitted as SLURM job: 25619555
==============================================================================
 
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%  All execution tests passed!  %%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Also, all integration tests were zero-diff w/r/t 14.3.0 except:

• APM (known parallelization issue)
• RRTMG (numerical noise in RRTMG collection)

[yantosca]

All GCHP integration tests passed:

==============================================================================
GCHP: Execution Test Results

GCHP      #cf81166 GEOS-Chem submod update: Merge PR #2226 (Fix bug for ST80_25 tracer)
GEOS-Chem #a18588576 Merge PR 2225# (Don't expect photolysis dirs to end in "/")
HEMCO     #2a4bb12 Merge PR #268 (Handle 3D NEI emissions)

Number of execution tests: 6

Submitted as SLURM job: 25621522
==============================================================================

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%  All execution tests passed!  %%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Also, all GCHP integration tests were zero-diff w/r/t 14.3.0.