mom_hybgen_remap module reference

This module contains the hybgen remapping routines from HYCOM, with minor modifications to follow the MOM6 coding conventions.

More…

Functions/Subroutines

hybgen_plm_coefs()

Set up the coefficients for PLM remapping of a set of scalars.

hybgen_ppm_coefs()

Set up the coefficients for PPM remapping of a set of scalars.

hybgen_weno_coefs()

Set up the coefficients for PPM remapping of a set of scalars.

Detailed Description

This module contains the hybgen remapping routines from HYCOM, with minor modifications to follow the MOM6 coding conventions.

Function/Subroutine Documentation

subroutine mom_hybgen_remap/hybgen_plm_coefs(si, dpi, slope, nk, ns, thin, PCM_lay)

Set up the coefficients for PLM remapping of a set of scalars.

Parameters:

  • nk :: [in] The number of input layers

  • ns :: [in] The number of scalar fields to work on

  • si :: [in] The cell-averaged input scalar fields [A]

  • dpi :: [in] The input grid layer thicknesses [H ~> m or kg m-2]

  • slope :: [out] The PLM slope times cell width [A]

  • thin :: [in] A negligible layer thickness that can be ignored [H ~> m or kg m-2]

  • pcm_lay :: [in] If true for a layer, use PCM remapping for that layer

Called from:

mom_remapping::build_reconstructions_1d

subroutine mom_hybgen_remap/hybgen_ppm_coefs(s, h_src, edges, nk, ns, thin, PCM_lay)

Set up the coefficients for PPM remapping of a set of scalars.

Parameters:

  • nk :: [in] The number of input layers

  • ns :: [in] The scalar fields to work on

  • s :: [in] The input scalar fields [A]

  • h_src :: [in] The input grid layer thicknesses [H ~> m or kg m-2]

  • edges :: [out] The PPM interpolation edge values of the scalar fields [A]

  • thin :: [in] A negligible layer thickness that can be ignored [H ~> m or kg m-2]

  • pcm_lay :: [in] If true for a layer, use PCM remapping for that layer

Called from:

mom_remapping::build_reconstructions_1d

subroutine mom_hybgen_remap/hybgen_weno_coefs(s, h_src, edges, nk, ns, thin, PCM_lay)

Set up the coefficients for PPM remapping of a set of scalars.

Parameters:

  • nk :: [in] The number of input layers

  • ns :: [in] The number of scalar fields to work on

  • s :: [in] The input scalar fields [A]

  • h_src :: [in] The input grid layer thicknesses [H ~> m or kg m-2]

  • edges :: [out] The WENO interpolation edge values of the scalar fields [A]

  • thin :: [in] A negligible layer thickness that can be ignored [H ~> m or kg m-2]

  • pcm_lay :: [in] If true for a layer, use PCM remapping for that layer

Called from:

mom_remapping::build_reconstructions_1d