nml_real_array Function

public function nml_real_array(name, tgt, doc, units, required, dead_on_ocean_path) result(key)

Construct a real-array key, capturing the current target as default (whole-array compare for is_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
character(len=*), intent(in), optional :: dead_on_ocean_path

Return Value type(nml_real_array_key_t)


Called by

proc~~nml_real_array~~CalledByGraph proc~nml_real_array nml_real_array proc~register_boundary register_boundary proc~register_boundary->proc~nml_real_array proc~register_ocean_bc register_ocean_bc proc~register_ocean_bc->proc~nml_real_array proc~register_ocean_diag register_ocean_diag proc~register_ocean_diag->proc~nml_real_array proc~register_ocean_hvisc register_ocean_hvisc proc~register_ocean_hvisc->proc~nml_real_array proc~register_ocean_ic register_ocean_ic proc~register_ocean_ic->proc~nml_real_array proc~register_ocean_ice register_ocean_ice proc~register_ocean_ice->proc~nml_real_array proc~register_vcoord register_vcoord proc~register_vcoord->proc~nml_real_array proc~build_rdb_schema build_rdb_schema proc~build_rdb_schema->proc~register_boundary proc~build_rdb_schema->proc~register_ocean_bc 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_vcoord 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_array(name, tgt, doc, units, required, dead_on_ocean_path) result(key)
      !! Construct a real-array key, capturing the current target as
      !! default (whole-array compare for is_default).
      character(len=*), intent(in) :: name, doc
      real(rk), pointer, intent(in) :: tgt(:)
      character(len=*), intent(in), optional :: units
      logical, intent(in), optional :: required
      character(len=*), intent(in), optional :: dead_on_ocean_path
      type(nml_real_array_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
   end function nml_real_array