fileNames_mod

link to source code

Dependency Diagrams:

fileNames_mod.svg

Direct Dependency Diagram

fileNames_mod_rev.svg

Reverse Dependency Diagram

Description

MODULE fileNames_mod (prefix=’fln’ category=’7. Low-level data objects’)

Purpose

Routines related to file names.

Quick access

Routines

fln_ensanlfilename(), fln_ensfilename(), fln_enstrlfilename()

Needed modules

  • utilities_mod: MODULE utilities_mod (prefix=’utl’ category=’8. Low-level utilities and constants’)

  • clibinterfaces_mod: MODULE clibInterfaces_mod (prefix=’’ category=’9. Global interfaces’)

  • ramdisk_mod: MODULE ramDisk_mod (prefix=’ram’ category=’8. Low-level utilities and constants’)

  • timecoord_mod: MODULE timeCoord_mod (prefix=’tim’ category=’7. Low-level data objects’)

Variables

Subroutines and functions

subroutine  filenames_mod/fln_ensfilename(ensfilename, enspathname[, memberindex_opt[, ensfilenameprefix_opt[, ensfilebasename_opt[, shouldexist_opt[, ensemblefileextlength_opt[, copytoramdisk_opt[, resetfileinfo_opt[, filememberindex1_opt]]]]]]]])
Purpose

Return the filename of an ensemble member. Will also call routine in ramdisk_mod module that will copy the file (if shouldExist_opt is true) to the ram disk. If the memberIndex_opt is not specified, the filename is returned without the member index extension (used to read deterministic background state that is stored in the ensemble directory for LETKF).

Arguments

  • ensfilename [character ,out]

  • enspathname [character ,in]

Options

  • memberindex_opt [integer ,in,]

  • ensfilenameprefix_opt [character ,in,]

  • ensfilebasename_opt [character ,out,]

  • shouldexist_opt [logical ,in,]

  • ensemblefileextlength_opt [integer ,out,]

  • copytoramdisk_opt [logical ,in,]

  • resetfileinfo_opt [logical ,in,]

  • filememberindex1_opt [integer ,in,]

Called from

bmat1d_setupbens(), ben_setuponeinstance(), csg_setup(), calclocalvertcorrmatrix(), ens_readensemble(), ens_writeensemble(), omf_ominusfens(), midas_calcstats, midas_enspostprocess, midas_ensembleh, midas_letkf, midas_ominusf

Call to

utl_abort(), ram_fullworkingpath()

subroutine  filenames_mod/fln_ensanlfilename(ensfilename, enspathname, datestamp[, memberindex_opt[, ensfilenameprefix_opt[, ensfilenamesuffix_opt]]])
Purpose

Return the filename for an analysis state, including for ensemble members (by specifying memberIndex_opt). The member index extension is assumed to be 4 digits.

Arguments

  • ensfilename [character ,out]

  • enspathname [character ,in]

  • datestamp [integer ,in]

Options

  • memberindex_opt [integer ,in,]

  • ensfilenameprefix_opt [character ,in,]

  • ensfilenamesuffix_opt [character ,in,]

Called from

epp_postprocess(), epp_writetoallmembers(), ens_writeensemble()

subroutine  filenames_mod/fln_enstrlfilename(ensfilename, enspathname, datestamp[, memberindex_opt[, ensfilenameprefix_opt[, ensfilenamesuffix_opt]]])
Purpose

Return the filename for a trial state, including for ensemble members (by specifying memberIndex_opt). The member index extension is assumed to be 4 digits.

Arguments

  • ensfilename [character ,out]

  • enspathname [character ,in]

  • datestamp [integer ,in]

Options

  • memberindex_opt [integer ,in,]

  • ensfilenameprefix_opt [character ,in,]

  • ensfilenamesuffix_opt [character ,in,]

Called from

epp_postprocess(), midas_ensembleh, midas_letkf