nonoverlap_vanish_tol_for Function

public pure function nonoverlap_vanish_tol_for(angstrom_h) result(tol)

The grounded-layer gate’s “vanished on one side” threshold, 2·max(angstrom_h, H_VANISHED): a layer within a factor two of the floor it can rest on. The factor is the margin that keeps every floor the Lagrangian path parks a grounded layer on inside the band — the uniform_z seed’s max(angstrom_h, 2·H_VANISHED) collapse, the conservative-floor borrow’s angstrom_h (to round-off), and the positive-definite continuity’s [angstrom_h, angstrom_h + H_VANISHED] at-floor band — while staying orders of magnitude below any layer that carries real mass.

Arguments

Type IntentOptional Attributes Name
real(kind=wp), intent(in) :: angstrom_h

&ocean_isopycnal_nml angstrom_h (m); 0 when the floor is off.

Return Value real(kind=wp)


Called by

proc~~nonoverlap_vanish_tol_for~~CalledByGraph proc~nonoverlap_vanish_tol_for nonoverlap_vanish_tol_for proc~configure_ocean_pgf configure_ocean_pgf proc~configure_ocean_pgf->proc~nonoverlap_vanish_tol_for proc~engine_setup engine_setup proc~engine_setup->proc~configure_ocean_pgf proc~complete_ocean_create complete_ocean_create proc~complete_ocean_create->proc~engine_setup proc~driver_run_ocean driver_run_ocean proc~driver_run_ocean->proc~engine_setup proc~driver_validate driver_validate proc~driver_validate->proc~engine_setup proc~driver_run driver_run proc~driver_run->proc~driver_run_ocean proc~rdb_ocean_create_finalize rdb_ocean_create_finalize proc~rdb_ocean_create_finalize->proc~complete_ocean_create proc~rdb_ocean_create_from_string rdb_ocean_create_from_string proc~rdb_ocean_create_from_string->proc~complete_ocean_create

Source Code

   pure function nonoverlap_vanish_tol_for(angstrom_h) result(tol)
      !! The grounded-layer gate's "vanished on one side" threshold,
      !! `2·max(angstrom_h, H_VANISHED)`: a layer within a factor two of the
      !! floor it can rest on.  The factor is the margin that keeps every
      !! floor the Lagrangian path parks a grounded layer on inside the band
      !! — the `uniform_z` seed's `max(angstrom_h, 2·H_VANISHED)` collapse,
      !! the conservative-floor borrow's `angstrom_h` (to round-off), and the
      !! positive-definite continuity's `[angstrom_h, angstrom_h + H_VANISHED]`
      !! at-floor band — while staying orders of magnitude below any layer
      !! that carries real mass.
      real(wp), intent(in) :: angstrom_h
         !! `&ocean_isopycnal_nml angstrom_h` (m); 0 when the floor is off.
      real(wp) :: tol
      tol = 2.0_wp*max(angstrom_h, H_VANISHED)
   end function nonoverlap_vanish_tol_for