gtvargetattr.f90 File Reference

Numeric attribute input. More...

Go to the source code of this file.

Functions/Subroutines
subroutine	gtvargetattri (var, attrname, value, default)
subroutine	gtvargetattrr (var, attrname, value, default)
subroutine	gtvargetattrd (var, attrname, value, default)
subroutine	gtvargetattrip (var, name, value)
subroutine	gtvargetattrrp (var, name, value)
subroutine	gtvargetattrdp (var, name, value)
subroutine	gtvargetattria (var, name, value, default)
subroutine	gtvargetattrra (var, name, value, default)
subroutine	gtvargetattrda (var, name, value, default)

Detailed Description

Numeric attribute input.

Author

Eizi TOYODA, Yasuhiro MORIKAWA

Copyright

Copyright (C) GFD Dennou Club, 2000-2026. All rights reserved.
License is BSD-2-Clause. See COPYRIGHT in detail

Definition in file gtvargetattr.f90.

Function/Subroutine Documentation

gtvargetattrd()

subroutine gtvargetattrd	(	type(gt_variable), intent(in)	var,
		character(len = *), intent(in)	attrname,
		real(dp), intent(out)	value,
		real(dp), intent(in), optional	default
	)

Get attribute value (double precision scalar)

Parameters

[in]	var	Variable handle
[in]	attrname	Attribute name
[out]	value	Attribute value (double precision)
[in]	default	Default value (optional)

Definition at line 166 of file gtvargetattr.f90.

  use gtdata_types, only: gt_variable
  use gtdata_internal_map, only: var_class, vtb_class_netcdf
  use gtdata_netcdf_generic, only: get_attr
  use gtdata_netcdf_types, only: gd_nc_variable
  use dc_error, only: gt_enotvar, storeerror
  use dc_types, only: dp
  use netcdf, only: nf90_fill_double
  implicit none
  type(GT_VARIABLE), intent(in):: var
  character(len = *), intent(in):: attrname
  real(DP), intent(out):: value
  real(DP), intent(in), optional:: default
  integer:: stat
  real(DP):: buffer(1)
  integer:: class, cid
continue
  call var_class(var, class, cid)
  select case(class)
  case (vtb_class_netcdf)
    call get_attr(gd_nc_variable(cid), attrname, value=buffer, &
      & stat=stat, default=default)
    if (stat >= 1) then
      value = buffer(1)
      return
    end if
  case default
    call storeerror(gt_enotvar, "GTVarGetAttrR")
  end select
  value = nf90_fill_double
  if (present(default)) value = default

References dc_types::dp, dc_error::gt_enotvar, dc_error::storeerror(), and gtdata_internal_map::var_class().

Here is the call graph for this function:

gtvargetattrda()

subroutine gtvargetattrda	(	type(gt_variable), intent(in)	var,
		character(len = *), intent(in)	name,
		real(dp), dimension(:), intent(out)	value,
		real(dp), intent(in)	default
	)

Get attribute value (double precision fixed-length array)

Parameters

[in]	var	Variable handle
[in]	name	Attribute name
[out]	value	Attribute value (double precision array)
[in]	default	Default fill value

Definition at line 413 of file gtvargetattr.f90.

  use gtdata_types, only: gt_variable
  use gtdata_generic, only: friend => get_attr
  use gtdata_internal_map, only: var_class, vtb_class_netcdf
  use gtdata_netcdf_generic, only: get_attr
  use gtdata_netcdf_types, only: gd_nc_variable
  use dc_types, only: dp
  use dc_error, only: gt_enotvar, storeerror
  implicit none
  type(GT_VARIABLE), intent(in):: var
  character(len = *), intent(in):: name
  real(DP), intent(out):: value(:)
  real(DP), intent(in):: default
  integer:: stat, class, cid
continue
  call var_class(var, class, cid)
  if (class == vtb_class_netcdf) then
    call get_attr(gd_nc_variable(cid), name, value, stat, default)
  else
    call storeerror(gt_enotvar, "GTVarGetAttrRA")
  endif

References dc_types::dp, dc_error::gt_enotvar, dc_error::storeerror(), and gtdata_internal_map::var_class().

Here is the call graph for this function:

gtvargetattrdp()

subroutine gtvargetattrdp	(	type(gt_variable), intent(in)	var,
		character(len = *), intent(in)	name,
		real(dp), dimension(:), pointer	value
	)

Get attribute value (double precision pointer array)

Parameters

[in]	var	Variable handle
[in]	name	Attribute name
[out]	value	Attribute value (double precision pointer)

Definition at line 293 of file gtvargetattr.f90.

  use gtdata_types, only: gt_variable
  use gtdata_internal_map, only: var_class, vtb_class_netcdf
  use gtdata_netcdf_generic, only: get_attr
  use gtdata_netcdf_types, only: gd_nc_variable
  use dc_types, only: dp
  use dc_error, only: gt_enotvar, storeerror
  implicit none
  type(GT_VARIABLE), intent(in):: var
  character(len = *), intent(in):: name
  real(DP), pointer:: value(:) !(out)
  integer:: stat, class, cid
continue
  call var_class(var, class, cid)
  if (class == vtb_class_netcdf) then
    allocate(value(1))
    call get_attr(gd_nc_variable(cid), name, value(1:0), stat)
    deallocate(value)
    if (stat < 1) return
    allocate(value(stat))
    call get_attr(gd_nc_variable(cid), name, value, stat)
    if (stat < 1) deallocate(value)
  else
    call storeerror(gt_enotvar, "GTVarGetAttrRP")
  endif

References dc_types::dp, dc_error::gt_enotvar, dc_error::storeerror(), and gtdata_internal_map::var_class().

Here is the call graph for this function:

gtvargetattri()

subroutine gtvargetattri	(	type(gt_variable), intent(in)	var,
		character(len = *), intent(in)	attrname,
		integer, intent(out)	value,
		integer, intent(in), optional	default
	)

Get attribute value (integer scalar)

Returns the value of attribute attrname attached to variable var. Get_Attr is a generic name for multiple subroutines, so value can accept various types of variables (including pointers).

If the attribute value cannot be retrieved normally and default is provided, that value is returned. Default values when default is not provided are:

• character: "" (empty string)
• real: NF90_FILL_REAL
• real(DP): NF90_FILL_DOUBLE
• integer: NF90_FILL_INT

When value is a pointer, it is automatically allocated according to the attribute value. Always pass it in a null state.

When value is a fixed-length array, default is required because Fortran language specifications require different interfaces for pointer and non-pointer forms.

Parameters

[in]	var	Variable handle
[in]	attrname	Attribute name
[out]	value	Attribute value (integer)
[in]	default	Default value (optional)

Definition at line 76 of file gtvargetattr.f90.

  use gtdata_types, only: gt_variable
  use gtdata_internal_map, only: var_class, vtb_class_netcdf
  use gtdata_netcdf_generic, only: get_attr
  use gtdata_netcdf_types, only: gd_nc_variable
  use netcdf, only: nf90_fill_int
  use dc_error, only: gt_enotvar, storeerror
  implicit none
  type(GT_VARIABLE), intent(in):: var
  character(len = *), intent(in):: attrname
  integer, intent(out):: value
  integer, intent(in), optional:: default
  integer:: stat, buffer(1), class, cid
continue
  call var_class(var, class, cid)
  if (class == vtb_class_netcdf) then
    call get_attr(gd_nc_variable(cid), attrname, buffer, stat, default)
    if (stat >= 1) then
      value = buffer(1)
      return
    end if
  else
    call storeerror(gt_enotvar, "GTVarGetAttrI")
  endif
  value = nf90_fill_int
  if (present(default)) value = default

References dc_error::gt_enotvar, dc_error::storeerror(), and gtdata_internal_map::var_class().

Here is the call graph for this function:

gtvargetattria()

subroutine gtvargetattria	(	type(gt_variable), intent(in)	var,
		character(len = *), intent(in)	name,
		integer, dimension(:), intent(out)	value,
		integer, intent(in)	default
	)

Get attribute value (integer fixed-length array)

When receiving as a fixed-length array, excess attribute values are truncated. When attribute length is insufficient, default values fill the remainder (default is required unlike pointer form).

Parameters

[in]	var	Variable handle
[in]	name	Attribute name
[out]	value	Attribute value (integer array)
[in]	default	Default fill value

Definition at line 341 of file gtvargetattr.f90.

  use gtdata_types, only: gt_variable
  use gtdata_generic, only: friend => get_attr
  use gtdata_internal_map, only: var_class, vtb_class_netcdf
  use gtdata_netcdf_generic, only: get_attr
  use gtdata_netcdf_types, only: gd_nc_variable
  use dc_error, only: gt_enotvar, storeerror
  implicit none
  type(GT_VARIABLE), intent(in):: var
  character(len = *), intent(in):: name
  integer, intent(out):: value(:)
  integer, intent(in):: default
  integer:: stat, class, cid
continue
  call var_class(var, class, cid)
  if (class == vtb_class_netcdf) then
    call get_attr(gd_nc_variable(cid), name, value, stat, default)
  else
    call storeerror(gt_enotvar, "GTVarGetAttrIA")
  endif

References dc_error::gt_enotvar, dc_error::storeerror(), and gtdata_internal_map::var_class().

Here is the call graph for this function:

gtvargetattrip()

subroutine gtvargetattrip	(	type(gt_variable), intent(in)	var,
		character(len = *), intent(in)	name,
		integer, dimension(:), pointer	value
	)

Get attribute value (integer pointer array)

When receiving with a pointer array, entities are allocated for as many interpretable values as exist.

Parameters

[in]	var	Variable handle
[in]	name	Attribute name
[out]	value	Attribute value (integer pointer)

Definition at line 216 of file gtvargetattr.f90.

  use gtdata_types, only: gt_variable
  use gtdata_internal_map, only: var_class, vtb_class_netcdf
  use gtdata_netcdf_generic, only: get_attr
  use gtdata_netcdf_types, only: gd_nc_variable
  use dc_error, only: gt_enotvar, storeerror
  implicit none
  type(GT_VARIABLE), intent(in):: var
  character(len = *), intent(in):: name
  integer, pointer:: value(:) !(out)
  integer:: stat, class, cid
continue
  call var_class(var, class, cid)
  if (class == vtb_class_netcdf) then
    allocate(value(1))
    call get_attr(gd_nc_variable(cid), name, value(1:0), stat)
    deallocate(value)
    if (stat < 1) return
    allocate(value(stat))
    call get_attr(gd_nc_variable(cid), name, value, stat)
    if (stat < 1) deallocate(value)
  else
    call storeerror(gt_enotvar, "GTVarGetAttrIP")
  endif

References dc_error::gt_enotvar, dc_error::storeerror(), and gtdata_internal_map::var_class().

Here is the call graph for this function:

gtvargetattrr()

subroutine gtvargetattrr	(	type(gt_variable), intent(in)	var,
		character(len = *), intent(in)	attrname,
		real, intent(out)	value,
		real, intent(in), optional	default
	)

Get attribute value (real scalar)

Parameters

[in]	var	Variable handle
[in]	attrname	Attribute name
[out]	value	Attribute value (real)
[in]	default	Default value (optional)

Definition at line 118 of file gtvargetattr.f90.

  use gtdata_types, only: gt_variable
  use gtdata_netcdf_generic, only: get_attr
  use gtdata_netcdf_types, only: gd_nc_variable
  use gtdata_internal_map, only: var_class, vtb_class_netcdf
  use dc_error, only: gt_ebadvar, storeerror
  use netcdf, only: nf90_fill_float
  implicit none
  type(GT_VARIABLE), intent(in):: var
  character(len = *), intent(in):: attrname
  real, intent(out):: value
  real, intent(in), optional:: default
  integer:: stat
  real:: buffer(1)
  integer:: class, cid
continue
  call var_class(var, class, cid)
  if (class == vtb_class_netcdf) then
    call get_attr(gd_nc_variable(cid), attrname, value=buffer, &
      & stat=stat, default=default)
    if (stat >= 1) then
      value = buffer(1)
      return
    endif
  else
    call storeerror(gt_ebadvar, "GTVarGetAttrR")
  endif
  if (present(default)) then
    value = default
  else
    value = nf90_fill_float
  endif

References dc_error::gt_ebadvar, dc_error::storeerror(), and gtdata_internal_map::var_class().

Here is the call graph for this function:

gtvargetattrra()

subroutine gtvargetattrra	(	type(gt_variable), intent(in)	var,
		character(len = *), intent(in)	name,
		real, dimension(:), intent(out)	value,
		real, intent(in)	default
	)

Get attribute value (real fixed-length array)

Parameters

[in]	var	Variable handle
[in]	name	Attribute name
[out]	value	Attribute value (real array)
[in]	default	Default fill value

Definition at line 377 of file gtvargetattr.f90.

  use gtdata_types, only: gt_variable
  use gtdata_generic, only: friend => get_attr
  use gtdata_internal_map, only: var_class, vtb_class_netcdf
  use gtdata_netcdf_generic, only: get_attr
  use gtdata_netcdf_types, only: gd_nc_variable
  use dc_error, only: gt_enotvar, storeerror
  implicit none
  type(GT_VARIABLE), intent(in):: var
  character(len = *), intent(in):: name
  real, intent(out):: value(:)
  real, intent(in):: default
  integer:: class, cid, stat
continue
  call var_class(var, class, cid)
  if (class == vtb_class_netcdf) then
    call get_attr(gd_nc_variable(cid), name, value, stat, default)
  else
    call storeerror(gt_enotvar, "GTVarGetAttrRA")
  endif

References dc_error::gt_enotvar, dc_error::storeerror(), and gtdata_internal_map::var_class().

Here is the call graph for this function:

gtvargetattrrp()

subroutine gtvargetattrrp	(	type(gt_variable), intent(in)	var,
		character(len = *), intent(in)	name,
		real, dimension(:), pointer	value
	)

Get attribute value (real pointer array)

Parameters

[in]	var	Variable handle
[in]	name	Attribute name
[out]	value	Attribute value (real pointer)

Definition at line 254 of file gtvargetattr.f90.

  use gtdata_types, only: gt_variable
  use gtdata_internal_map, only: var_class, vtb_class_netcdf
  use gtdata_netcdf_generic, only: get_attr
  use gtdata_netcdf_types, only: gd_nc_variable
  use dc_error, only: gt_enotvar, storeerror
  implicit none
  type(GT_VARIABLE), intent(in):: var
  character(len = *), intent(in):: name
  real, pointer:: value(:) !(out)
  integer:: stat, class, cid
continue
  call var_class(var, class, cid)
  if (class == vtb_class_netcdf) then
    allocate(value(1))
    call get_attr(gd_nc_variable(cid), name, value(1:0), stat)
    deallocate(value)
    if (stat < 1) return
    allocate(value(stat))
    call get_attr(gd_nc_variable(cid), name, value, stat)
    if (stat < 1) deallocate(value)
  else
    nullify(value)
    call storeerror(gt_enotvar, "GTVarGetAttrRP")
  endif

References dc_error::gt_enotvar, dc_error::storeerror(), and gtdata_internal_map::var_class().

Here is the call graph for this function: