aniso_mode_is_implemented Function

public pure function aniso_mode_is_implemented(mode) result(ok)

.true. iff the anisotropy-direction mode has an implemented direction tensor. Only mode 0 (grid-relative (n1,n2) = aniso_dir, a constant tensor) is built; the MOM6 flow-aligned modes are not ported. Drives the configure-time fail-loud guard in validate_config so a requested-but-unimplemented mode aborts the run instead of silently falling back to the grid-i default.

Arguments

Type IntentOptional Attributes Name
integer, intent(in) :: mode

Return Value logical


Called by

proc~~aniso_mode_is_implemented~~CalledByGraph proc~aniso_mode_is_implemented aniso_mode_is_implemented proc~validate_config validate_config proc~validate_config->proc~aniso_mode_is_implemented proc~build_pending_handle build_pending_handle proc~build_pending_handle->proc~validate_config proc~rdb_ocean_create_from_string rdb_ocean_create_from_string proc~rdb_ocean_create_from_string->proc~build_pending_handle proc~rdb_ocean_create_pending rdb_ocean_create_pending proc~rdb_ocean_create_pending->proc~build_pending_handle

Source Code

   pure function aniso_mode_is_implemented(mode) result(ok)
      !! `.true.` iff the anisotropy-direction mode has an implemented
      !! direction tensor.  Only mode 0 (grid-relative `(n1,n2) = aniso_dir`,
      !! a constant tensor) is built; the MOM6 flow-aligned modes are not
      !! ported.  Drives the configure-time fail-loud guard in
      !! `validate_config` so a requested-but-unimplemented mode aborts the
      !! run instead of silently falling back to the grid-i default.
      integer, intent(in) :: mode
      logical :: ok
      ok = (mode == 0)
   end function aniso_mode_is_implemented