nml_real Function

public function nml_real(name, tgt, doc, units, required, min, max, dead_on_ocean_path) result(key)

Construct a real key, capturing the current target as default.

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: name
real(kind=rk), intent(in), pointer :: tgt
character(len=*), intent(in) :: doc
character(len=*), intent(in), optional :: units
logical, intent(in), optional :: required
real(kind=rk), intent(in), optional :: min
real(kind=rk), intent(in), optional :: max
character(len=*), intent(in), optional :: dead_on_ocean_path

Return Value type(nml_real_key_t)


Called by

proc~~nml_real~~CalledByGraph proc~nml_real nml_real proc~add_dataovr_entry add_dataovr_entry proc~add_dataovr_entry->proc~nml_real proc~register_boundary register_boundary proc~register_boundary->proc~nml_real proc~register_conv register_conv proc~register_conv->proc~nml_real proc~register_ddiff register_ddiff proc~register_ddiff->proc~nml_real proc~register_epbl register_epbl proc~register_epbl->proc~nml_real proc~register_foxkemper register_foxkemper proc~register_foxkemper->proc~nml_real proc~register_gm register_gm proc~register_gm->proc~nml_real proc~register_grid register_grid proc~register_grid->proc~nml_real proc~register_initial_condition register_initial_condition proc~register_initial_condition->proc~nml_real proc~register_kappa_shear register_kappa_shear proc~register_kappa_shear->proc~nml_real proc~register_logging register_logging proc~register_logging->proc~nml_real proc~register_meke register_meke proc~register_meke->proc~nml_real proc~register_nonhydrostatic register_nonhydrostatic proc~register_nonhydrostatic->proc~nml_real proc~register_ocean_bc register_ocean_bc proc~register_ocean_bc->proc~nml_real proc~register_ocean_bdrag register_ocean_bdrag proc~register_ocean_bdrag->proc~nml_real proc~register_ocean_bt register_ocean_bt proc~register_ocean_bt->proc~nml_real proc~register_ocean_cavity_dyn register_ocean_cavity_dyn proc~register_ocean_cavity_dyn->proc~nml_real proc~register_ocean_cavity_melt register_ocean_cavity_melt proc~register_ocean_cavity_melt->proc~nml_real proc~register_ocean_continuity register_ocean_continuity proc~register_ocean_continuity->proc~nml_real proc~register_ocean_dataovr register_ocean_dataovr proc~register_ocean_dataovr->proc~nml_real proc~register_ocean_dataovr->proc~add_dataovr_entry proc~register_ocean_diag register_ocean_diag proc~register_ocean_diag->proc~nml_real proc~register_ocean_eos register_ocean_eos proc~register_ocean_eos->proc~nml_real proc~register_ocean_geothermal register_ocean_geothermal proc~register_ocean_geothermal->proc~nml_real proc~register_ocean_grid register_ocean_grid proc~register_ocean_grid->proc~nml_real proc~register_ocean_hdiff register_ocean_hdiff proc~register_ocean_hdiff->proc~nml_real proc~register_ocean_hvisc register_ocean_hvisc proc~register_ocean_hvisc->proc~nml_real proc~register_ocean_ic register_ocean_ic proc~register_ocean_ic->proc~nml_real proc~register_ocean_ice register_ocean_ice proc~register_ocean_ice->proc~nml_real proc~register_ocean_ice_ic register_ocean_ice_ic proc~register_ocean_ice_ic->proc~nml_real proc~register_ocean_isopycnal register_ocean_isopycnal proc~register_ocean_isopycnal->proc~nml_real proc~register_ocean_pgf register_ocean_pgf proc~register_ocean_pgf->proc~nml_real proc~register_ocean_psurf register_ocean_psurf proc~register_ocean_psurf->proc~nml_real proc~register_ocean_restore register_ocean_restore proc~register_ocean_restore->proc~nml_real proc~register_ocean_sponge register_ocean_sponge proc~register_ocean_sponge->proc~nml_real proc~register_ocean_tdrag register_ocean_tdrag proc~register_ocean_tdrag->proc~nml_real proc~register_ocean_thermo register_ocean_thermo proc~register_ocean_thermo->proc~nml_real proc~register_ocean_tides register_ocean_tides proc~register_ocean_tides->proc~nml_real proc~register_ocean_topo register_ocean_topo proc~register_ocean_topo->proc~nml_real proc~register_ocean_tracers register_ocean_tracers proc~register_ocean_tracers->proc~nml_real proc~register_ocean_vdiff register_ocean_vdiff proc~register_ocean_vdiff->proc~nml_real proc~register_ocean_vmix register_ocean_vmix proc~register_ocean_vmix->proc~nml_real proc~register_ocean_wetdry register_ocean_wetdry proc~register_ocean_wetdry->proc~nml_real proc~register_ocean_zinit register_ocean_zinit proc~register_ocean_zinit->proc~nml_real proc~register_output register_output proc~register_output->proc~nml_real proc~register_physics register_physics proc~register_physics->proc~nml_real proc~register_porous register_porous proc~register_porous->proc~nml_real proc~register_redi register_redi proc~register_redi->proc~nml_real proc~register_slopes register_slopes proc~register_slopes->proc~nml_real proc~register_tidal_mixing register_tidal_mixing proc~register_tidal_mixing->proc~nml_real proc~register_time register_time proc~register_time->proc~nml_real proc~register_tracer register_tracer proc~register_tracer->proc~nml_real proc~register_varmix register_varmix proc~register_varmix->proc~nml_real proc~register_vcoord register_vcoord proc~register_vcoord->proc~nml_real proc~register_wavespeed register_wavespeed proc~register_wavespeed->proc~nml_real proc~build_rdb_schema build_rdb_schema proc~build_rdb_schema->proc~register_boundary proc~build_rdb_schema->proc~register_conv proc~build_rdb_schema->proc~register_ddiff proc~build_rdb_schema->proc~register_epbl proc~build_rdb_schema->proc~register_foxkemper proc~build_rdb_schema->proc~register_gm proc~build_rdb_schema->proc~register_grid proc~build_rdb_schema->proc~register_initial_condition proc~build_rdb_schema->proc~register_kappa_shear proc~build_rdb_schema->proc~register_logging proc~build_rdb_schema->proc~register_meke proc~build_rdb_schema->proc~register_nonhydrostatic proc~build_rdb_schema->proc~register_ocean_bc proc~build_rdb_schema->proc~register_ocean_bdrag proc~build_rdb_schema->proc~register_ocean_bt proc~build_rdb_schema->proc~register_ocean_cavity_dyn proc~build_rdb_schema->proc~register_ocean_cavity_melt proc~build_rdb_schema->proc~register_ocean_continuity proc~build_rdb_schema->proc~register_ocean_dataovr proc~build_rdb_schema->proc~register_ocean_diag proc~build_rdb_schema->proc~register_ocean_eos proc~build_rdb_schema->proc~register_ocean_geothermal proc~build_rdb_schema->proc~register_ocean_grid proc~build_rdb_schema->proc~register_ocean_hdiff proc~build_rdb_schema->proc~register_ocean_hvisc proc~build_rdb_schema->proc~register_ocean_ic proc~build_rdb_schema->proc~register_ocean_ice proc~build_rdb_schema->proc~register_ocean_ice_ic proc~build_rdb_schema->proc~register_ocean_isopycnal proc~build_rdb_schema->proc~register_ocean_pgf proc~build_rdb_schema->proc~register_ocean_psurf proc~build_rdb_schema->proc~register_ocean_restore proc~build_rdb_schema->proc~register_ocean_sponge proc~build_rdb_schema->proc~register_ocean_tdrag proc~build_rdb_schema->proc~register_ocean_thermo proc~build_rdb_schema->proc~register_ocean_tides proc~build_rdb_schema->proc~register_ocean_topo proc~build_rdb_schema->proc~register_ocean_tracers proc~build_rdb_schema->proc~register_ocean_vdiff proc~build_rdb_schema->proc~register_ocean_vmix proc~build_rdb_schema->proc~register_ocean_wetdry proc~build_rdb_schema->proc~register_ocean_zinit proc~build_rdb_schema->proc~register_output proc~build_rdb_schema->proc~register_physics proc~build_rdb_schema->proc~register_porous proc~build_rdb_schema->proc~register_redi proc~build_rdb_schema->proc~register_slopes proc~build_rdb_schema->proc~register_tidal_mixing proc~build_rdb_schema->proc~register_time proc~build_rdb_schema->proc~register_tracer proc~build_rdb_schema->proc~register_varmix proc~build_rdb_schema->proc~register_vcoord proc~build_rdb_schema->proc~register_wavespeed proc~read_config_from_string_impl read_config_from_string_impl proc~read_config_from_string_impl->proc~build_rdb_schema proc~read_config_impl read_config_impl proc~read_config_impl->proc~build_rdb_schema proc~read_config read_config proc~read_config->proc~read_config_impl proc~read_config_from_string read_config_from_string proc~read_config_from_string->proc~read_config_from_string_impl proc~build_pending_handle build_pending_handle proc~build_pending_handle->proc~read_config_from_string

Source Code

   function nml_real(name, tgt, doc, units, required, min, max, dead_on_ocean_path) result(key)
      !! Construct a real key, capturing the current target as default.
      character(len=*), intent(in) :: name, doc
      real(rk), pointer, intent(in) :: tgt
      character(len=*), intent(in), optional :: units
      logical, intent(in), optional :: required
      real(rk), intent(in), optional :: min, max
      character(len=*), intent(in), optional :: dead_on_ocean_path
      type(nml_real_key_t) :: key

      key%name = name
      key%doc = doc
      key%units = ""
      if (present(units)) key%units = units
      if (present(required)) key%required = required
      key%dead_reason = ""
      if (present(dead_on_ocean_path)) key%dead_reason = dead_on_ocean_path
      key%tgt => tgt
      key%default = tgt
      if (present(min)) then
         key%vmin = min
         key%has_min = .true.
      end if
      if (present(max)) then
         key%vmax = max
         key%has_max = .true.
      end if
   end function nml_real