Mapping file algorithms and naming convention

Proposed naming convention for E3SM V2 and newer compsets:

Where grida and gridb are existing grid naming conventions established by the respective component.

Here we propose to standardize the suffix to denote the Tool and Algorithm (Following recommendation from @Charlie Zender for ncremap) :


  • esmf: Earth System Modeling Framework

  • nco: NCO (ncremap can generate aave maps, and also serve as a frontend to esmf and tr/mbtr)

  • tr: TempestRemap

  • mbtr: MOAB-TempestRemap

  • cstm: A custom tool (such as used for river to ocean maps)

FV to FV Algorithms: (used in E3SMv2 and higher)

  • aave: Maps which compute a common refinement (intersection) mesh and then integrate a piecewise-constant reconstruction.

    • can be produced by: ESMF, NCO and TR/MBTR

    • pros: conservative, montonone, cell averaging good for fine-to-coarse maps.

    • cons: 1st order accurate, not suitable for coarse-to-fine maps (blocky results)

    • examples: esmfaave, ncoaave, traave. Usage with ncremap:

      • ncremap -s -g -a ncoaave -m

      • ncremap -s -g -a esmfaave -m

      • ncremap -s -g -a traave -m


  • bilin: bilinear interpolation

    • can be produced by: ESMF, TR/MBTR

      • ESMF: ESMF_RegridWeightGen -s -d -w --method bilinear --extrap_method nearestidavg

      • TempestRemap:

        1. GenerateOfflineMap --a --b --out --allow_no_overlap

        2. GenerateOfflineMap --in_mesh --out_mesh --ov_mesh --in_type fv --out_type fv --method bilin --out_map

      • mbtempest: mbtempest --type 5 --load --load --intx intersection_mesh.h5m --weights --method fv --method fv --order 1 --order 1 --fvmethod bilin --file

    • pros: monotone, 2nd order accurate

    • cons: non-conservative. not suitable for fine-to-coarse maps (aliasing errors)

    • examples: esmfbilin, trbilin

  • patch: patch based algorithm (L2 projection?).

    • can be produced by: ESMF only

    • pros: accurate. good for coarse-to-fine maps. not sure how it performance on fine-to-coarse maps.

    • cons: can have small non-monotone weights

    • examples: esmfpatch

  • intbilin: Integrated bilinear or barycentric (TR/MBTR only)

    • can be produced by: TR, MBTR only.

    • pros: monotone, 2nd order, good for fine-to-coarse and coarse-to-fine maps.

    • cons: TR software may have some issues when source grid has holes.

    • examples: trintbilin, mbtrintbilin

    • trintbilin: Pass --method intbilin option to TempestRemap’s GenerateOfflineMap

    • mbtrintbilin: Pass --fvmethod intbilin option to mbtempest

  • fv2 (or fvnp2): 2nd order FV reconstruction, cell integrated on target grid (TR/MBTR only)

  • nn: nearest neighbor

    • used with river runnoff maps




Suffix = esmfaave, esmfbilin, ncoaave, trmono, trmonotrn, trintbilin, trhighorder, mbtrmono, cstmnn ...


SE to/from FV Algorithms: (no longer used by E3SM, but used for some analysis tasks)

  • mono: TR developed algorithms which use a spectral element with monotone basis functions. The degrees of freedom for the basis function (“np”) is usually denoted in the grid name, such as ne30np4. For FV grids, only np=1 is supported.

    • can be produced by: TR only

    • monoSE2FV: SE monotonic basis reconstruction integrated over FV (np=1) cells

    • monoSE2SE: projection between source and target grid monotonic reconstructions

    • monoFV2SE: does this exist?

    • pros: conservative, monotone, good for fine-to-coarse maps.

    • cons: 1st order accurate

    • coarse-to-fine maps? Probably good, except for FV source grids.

  • intbilin: Integrated bilinear vi TR’s “mono2” option. For finite element grids, the shape functions are replaced by a piecewise linear shape functions which are then integrated using a common refinement mesh

    • can be produced by: TR only

    • pros: monotone, 2nd order, good for fine-to-coarse and coarse-to-fine maps.

    • cons: SE2FV only.

  • highorder: Use of SE shape functions or higher order FV for reconstruction, projected onto SE shape functions, or integrated over FV cell (np=1)

    • The most accurate SE2SE and SE2FV maps.

    • Currently not recommended due to large negative weights

  • {algorithm}trn: For any map from gridA to gridB, one can compute an area weighted transpose map from gridB to gradA. In general, the transpose map will not preserve the properties of the original map. However, the transpose of a consistent map will be conservative and the transpose of a conservative map will be consistent. The transpose of the SE->FV “mono” map (monotone and conservative) will be monotone and conservative.



Historical usage:        ESMF conservative/monotone "area averaged" maps. NOW: esmfaave       ESMF bilinear NOW: esmfbilin       TempestRemap conservative, monotone map NOW: “mono” is reserved for when the source is an SE grid. When its FV (as in ne30pg), use traave. TempestRemap high-order, conservative, non-monotone  ( several TR options in this category )       TempestRemap integrated bilinear:   monotone, non-conservative     TempestRemap transpose of a mono map.   TempestRemap transpose of a highorder map.  (not recommended) Used for a short time for TR conservative, high-order, non-monotone maps. Confusing since "conserve" implies it's a replacement for an "aave" type map, when really that type of map is a replacement for "bilin".