nml_int Function

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

Construct an integer key, capturing the current target as default.

Arguments

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

Return Value type(nml_int_key_t)


Called by

proc~~nml_int~~CalledByGraph proc~nml_int nml_int proc~register_boundary register_boundary proc~register_boundary->proc~nml_int proc~register_epbl register_epbl proc~register_epbl->proc~nml_int proc~register_grid register_grid proc~register_grid->proc~nml_int proc~register_kappa_shear register_kappa_shear proc~register_kappa_shear->proc~nml_int proc~register_mpi register_mpi proc~register_mpi->proc~nml_int proc~register_nonhydrostatic register_nonhydrostatic proc~register_nonhydrostatic->proc~nml_int proc~register_ocean_bc register_ocean_bc proc~register_ocean_bc->proc~nml_int proc~register_ocean_bt register_ocean_bt proc~register_ocean_bt->proc~nml_int proc~register_ocean_data register_ocean_data proc~register_ocean_data->proc~nml_int proc~register_ocean_debug register_ocean_debug proc~register_ocean_debug->proc~nml_int proc~register_ocean_diag register_ocean_diag proc~register_ocean_diag->proc~nml_int proc~register_ocean_hvisc register_ocean_hvisc proc~register_ocean_hvisc->proc~nml_int proc~register_ocean_ic register_ocean_ic proc~register_ocean_ic->proc~nml_int proc~register_ocean_ice register_ocean_ice proc~register_ocean_ice->proc~nml_int proc~register_ocean_pgf register_ocean_pgf proc~register_ocean_pgf->proc~nml_int proc~register_ocean_sponge register_ocean_sponge proc~register_ocean_sponge->proc~nml_int proc~register_ocean_vmix register_ocean_vmix proc~register_ocean_vmix->proc~nml_int proc~register_output register_output proc~register_output->proc~nml_int proc~register_time register_time proc~register_time->proc~nml_int proc~register_varmix register_varmix proc~register_varmix->proc~nml_int proc~register_vcoord register_vcoord proc~register_vcoord->proc~nml_int proc~register_wavespeed register_wavespeed proc~register_wavespeed->proc~nml_int proc~build_rdb_schema build_rdb_schema proc~build_rdb_schema->proc~register_boundary proc~build_rdb_schema->proc~register_epbl proc~build_rdb_schema->proc~register_grid proc~build_rdb_schema->proc~register_kappa_shear proc~build_rdb_schema->proc~register_mpi proc~build_rdb_schema->proc~register_nonhydrostatic proc~build_rdb_schema->proc~register_ocean_bc proc~build_rdb_schema->proc~register_ocean_bt proc~build_rdb_schema->proc~register_ocean_data proc~build_rdb_schema->proc~register_ocean_debug proc~build_rdb_schema->proc~register_ocean_diag 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_pgf proc~build_rdb_schema->proc~register_ocean_sponge proc~build_rdb_schema->proc~register_ocean_vmix proc~build_rdb_schema->proc~register_output proc~build_rdb_schema->proc~register_time 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_int(name, tgt, doc, units, required, min, max, dead_on_ocean_path) result(key)
      !! Construct an integer key, capturing the current target as default.
      character(len=*), intent(in) :: name, doc
      integer, pointer, intent(in) :: tgt
      character(len=*), intent(in), optional :: units
      logical, intent(in), optional :: required
      integer, intent(in), optional :: min, max
      character(len=*), intent(in), optional :: dead_on_ocean_path
      type(nml_int_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_int