varNameList_mod

link to source code

Dependency Diagrams:

varNameList_mod.svg

Direct Dependency Diagram

varNameList_mod_rev.svg

Reverse Dependency Diagram

Description

MODULE varNameList_mod (prefix=’vnl’ category=’7. Low-level data objects’)

Purpose

Contains a list of all possible variable names that can be used as analysis variables along with additional information for each and procedures for accessing this information

Quick access

Variables

vnl_numvarmax, vnl_numvarmax2d, vnl_numvarmax3d, vnl_numvarmaxcloud, vnl_numvarmaxother, vnl_varnamelist, vnl_varnamelist2d, vnl_varnamelist3d, vnl_varnamelistcloud, vnl_varnamelistother

Routines

vnl_addtovarnames(), vnl_iscloudvar(), vnl_isphysicsvar(), vnl_varkindfromvarname(), vnl_varlevelfromvarname(), vnl_varlevelfromvarnum(), vnl_varlistindex(), vnl_varlistindex2d(), vnl_varlistindex3d(), vnl_varlistindexother(), vnl_varmassfromvarname(), vnl_varmassfromvarnum(), vnl_varnamefromvarnum(), vnl_varnameisvalid(), vnl_varnamesfromexistlist(), vnl_varnumfromvarname()

Needed modules

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

  • midasmpi_mod: MODULE midasMpi_mod (prefix=’mmpi’ category=’8. Low-level utilities and constants’)

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

  • mathphysconstants_mod: MODULE mathPhysConstants_mod (prefix=’mpc’ category=’8. Low-level utilities and constants’)

Variables

  • varnamelist_mod/vnl_numvarmax [integer,parameter/public]
  • varnamelist_mod/vnl_numvarmax2d [integer,parameter/public]
  • varnamelist_mod/vnl_numvarmax3d [integer,parameter/public]
  • varnamelist_mod/vnl_numvarmaxcloud [integer,parameter/public]
  • varnamelist_mod/vnl_numvarmaxother [integer,parameter/public]
  • varnamelist_mod/vnl_varnamelist (95) [character,parameter/public]
  • varnamelist_mod/vnl_varnamelist2d (37) [character,parameter/public]
  • varnamelist_mod/vnl_varnamelist3d (52) [character,parameter/public]
  • varnamelist_mod/vnl_varnamelistcloud (5) [character,parameter/public]
  • varnamelist_mod/vnl_varnamelistother (6) [character,parameter/public]

Subroutines and functions

function  varnamelist_mod/vnl_varlistindex3d(varname)
Purpose

To get the 3d list index from the variable name

Arguments

varname [character ,in]

Return

listindex [integer ]

Call to

utl_abort()

function  varnamelist_mod/vnl_varlistindex2d(varname)
Purpose

To get the 2d list index from the variable name

Arguments

varname [character ,in]

Return

listindex [integer ]

Call to

utl_abort()

function  varnamelist_mod/vnl_varlistindexother(varname)
Purpose

To get the “Other” list index from the variable name

Arguments

varname [character ,in]

Return

listindex [integer ]

Called from

vco_getnumlev()

Call to

utl_abort()

function  varnamelist_mod/vnl_varlistindex(varname)
Purpose

To get the varlist index from the variable name

Arguments

varname [character ,in]

Return

listindex [integer ]

Called from

col_allocate(), col_getoffsetfromvarno(), col_getpressure(), col_getheight(), col_getallcolumns(), col_getcolumn(), col_getelem(), gio_readfile(), gio_writetofile(), gio_fileunitstostateunits(), gsv_getoffsetfromvarname(), gsv_getnumlevfromvarname(), gsv_allocate(), gsv_modifyvarname(), gsv_getfield_r48(), gsv_getfield3d_r8(), gsv_getfield3d_r4(), gvt_setupreffromtrialfiles(), logch_ens(), expch_tlm(), ch_bounds(), inn_setupcolumnsonanlinclev(), vnl_varlevelfromvarname(), vnl_varlevelfromvarnum(), vnl_varkindfromvarname()

Call to

utl_abort()

function  varnamelist_mod/vnl_varnameisvalid(varname)
Purpose

Check if the supplied variable name is known by MIDAS.

Arguments

varname [character ,in]

Return

isvalid [logical ]

Called from

vco_setupfromfile(), vco_setupoceanfromfile()

function  varnamelist_mod/vnl_varnamefromvarnum(varnumber[, varnumberchm_opt[, modelname_opt]])
Purpose

To get the variable name from the variable number

Arguments

varnumber [integer ,in]

Options

  • varnumberchm_opt [integer ,in,]

  • modelname_opt [character ,in,]

Return

varname [character ]

Called from

col_getoffsetfromvarno(), oer_sw(), oop_ppp_nl(), oop_hydro_nl(), oop_ice_nl(), vnl_varlevelfromvarnum(), vqc_listrej()

Call to

utl_abort()

function  varnamelist_mod/vnl_varnumfromvarname(varname[, varkind_opt])
Purpose

Identifies varNumber from varName for use in assimilating obs in the CH family. Here, for weather variables, there is a 1-1 association between a variable name and an observation unit. So one must provide the name directly associated to a single BUFR code. As such, weather variable varNames may not necessarily be a member of the vnl_varNameList for this routine only.

For constituents, the varNumber refers only to the field/ variable and not units. As consequence, there is a unique pairing of varNumbers with the varNames from vnl_VarNameList.

Arguments

varname [character ,in]

Options

varkind_opt [character ,in,]

Return

varnumber [integer ]

Called from

eob_init()

Call to

utl_abort()

function  varnamelist_mod/vnl_varlevelfromvarname(varname)
Purpose

To get variable level list from variable name

Arguments

varname [character ,in]

Return

varlevel [character ]

Called from

adv_ensemble_tl_r8(), adv_ensemble_tl_r4(), adv_ensemble_ad(), adv_statevector_tl(), adv_statevector_ad(), aer_dayssincelastobs(), aer_computeanlerrorstd(), bcsc_rdspstd_newfmt(), bcsc_rdstd3d(), bmat1d_setupbens(), setupensemble(), ben_getperturbation(), ben_getensmean(), addensmember(), addensmemberad(), bhi_rdspstd(), bhi_rdstd(), bhi_rdspstd_newfmt(), copytostatevector(), copyfromstatevector(), write3d(), writepowerspec(), calcvertmodesspec(), vertmodesfilter(), csl_setup(), scalestddev(), col_allocate(), enkf_letkfanalyses(), epp_printrmsstats(), ens_copymember(), ens_insertmember(), ens_recenter(), gio_readfile(), gio_writetofile(), gsv_allocate(), gsv_modifyvarname(), gsv_scalevertical(), lqtohu(), hutolq_gsv(), lqtohu_tlm(), hutolq_tlm(), lprtopr_gsv(), prtolpr_gsv(), lvistovis(), expch_tlm(), ch_bounds(), gvt_oceanicecontinuous(), gvt_sstspread(), vinterp_gsv_r8(), vinterp_gsv_r4(), int_vinterp_col(), statevectorinterface(), bmd_setup(), calchorizlocalizationradii(), calcvertlocalizationradii(), osd_calcinflation(), s2c_setupinterpinfo(), vco_setupoceanfromfile(), vms_setup(), vms_computemodesfromfunction(), vms_transform(), midas_diagbmatrix, midas_extractbmatrixfor1dvar

Call to

utl_isnamelistpresent(), utl_abort(), vnl_varlistindex()

function  varnamelist_mod/vnl_varlevelfromvarnum(varnumber[, varnumberchm_opt[, modelname_opt]])
Purpose

To get variable level list from the variable number

Arguments

varnumber [integer ,in]

Options

  • varnumberchm_opt [integer ,in,]

  • modelname_opt [character ,in,]

Return

varlevel [character ]

Called from

oer_sw(), filt_toposurface(), oop_vobslyrs(), oop_ppp_nl(), oop_zzz_nl(), oop_sfc_nl(), oop_had(), setfgefam(), setfgefamz(), setfgett(), setfgesurf(), setfgegps()

Call to

vnl_varnamefromvarnum(), vnl_varlistindex()

function  varnamelist_mod/vnl_varkindfromvarname(varname)
Purpose

To get variable kind list from the variable number

Arguments

varname [character ,in]

Return

varkind [character ]

Called from

bcsc_setupch(), bchm_bsqrt(), bchm_bsqrtad(), setupensemble(), col_setup(), enkf_letkfanalyses(), ens_recenter(), gio_writetofile(), gio_fileunitstostateunits(), gsv_setup(), gsv_varkindexist(), gvt_setupreffromtrialfiles(), gvt_transform_gsv(), gvt_transform_ens(), ch_bounds(), inn_setupcolumnsonanlinclev(), osd_calcinflation(), vco_setupfromfile(), vco_setupoceanfromfile()

Call to

vnl_varlistindex()

subroutine  varnamelist_mod/vnl_varnamesfromexistlist(varnames, varexistlist)
Purpose

To get variable names from the variable existList

Arguments

  • varnames (*) [character ,out,pointer]

  • varexistlist (*) [logical ,in]

Called from

inc_interpolateandadd()

Call to

utl_abort()

function  varnamelist_mod/vnl_varmassfromvarnum(varnumber)
Purpose

Identifies constituent molar mass from varNum for use in conversions for the CH family.

Arguments

varnumber [integer ,in]

Return

varmass [real ]

Call to

utl_abort()

function  varnamelist_mod/vnl_varmassfromvarname(varname)
Purpose

Identifies constituent molar mass from varName for use in conversions for the CH family.

Arguments

varname [character ,in]

Return

varmass [real ]

Called from

gio_writetofile(), gio_fileunitstostateunits()

Call to

utl_abort()

function  varnamelist_mod/vnl_isphysicsvar(varname)
Purpose

Signals if variable is expected to be on the “physics” grid.

Arguments

varname [character ,in]

Return

isphysicsvar [logical ]

Called from

gio_readfile()

function  varnamelist_mod/vnl_iscloudvar(varname)
Purpose

determine if varName is cloud variable.

Arguments

varname [character ,in]

Return

iscloud [logical ]

Called from

qlim_rttovlimit_gsv(), qlim_rttovlimit_ens(), inn_setupcolumnsonanlinclev()

function  varnamelist_mod/vnl_addtovarnames(varnamesin, varnametoadd)
Purpose

Add an additional varName to an existing list of varNames

Arguments

  • varnamesin (*) [character ,in]

  • varnametoadd [character ,in]

Return

varnamesout (*) [character ,pointer]

Called from

inc_interpolateandadd()