mom_io::mom_read_data Interface Reference

Detailed Description

Read a data field from a file.

Definition at line 74 of file MOM_io.F90.

Private functions
subroutine	mom_read_data_4d (filename, fieldname, data, MOM_Domain, timelevel, position, scale)
	This function uses the fms_io function read_data to read a distributed 4-D data field named "fieldname" from file "filename". Valid values for "position" include CORNER, CENTER, EAST_FACE and NORTH_FACE. More...
subroutine	mom_read_data_3d (filename, fieldname, data, MOM_Domain, timelevel, position, scale)
	This function uses the fms_io function read_data to read a distributed 3-D data field named "fieldname" from file "filename". Valid values for "position" include CORNER, CENTER, EAST_FACE and NORTH_FACE. More...
subroutine	mom_read_data_2d (filename, fieldname, data, MOM_Domain, timelevel, position, scale)
	This function uses the fms_io function read_data to read a distributed 2-D data field named "fieldname" from file "filename". Valid values for "position" include CORNER, CENTER, EAST_FACE and NORTH_FACE. More...
subroutine	mom_read_data_1d (filename, fieldname, data, timelevel, scale)
	This function uses the fms_io function read_data to read 1-D data field named "fieldname" from file "filename". More...

Functions and subroutines

mom_read_data_1d()

subroutine mom_io::mom_read_data::mom_read_data_1d ( character(len=*), intent(in)  filename, character(len=*), intent(in)  fieldname, real, dimension(:), intent(inout)  data, integer, intent(in), optional  timelevel, real, intent(in), optional  scale  )

private

This function uses the fms_io function read_data to read 1-D data field named "fieldname" from file "filename".

Parameters

[in]	filename	The name of the file to read
[in]	fieldname	The variable name of the data in the file
[in,out]	data	The 1-dimensional array into which the data
[in]	timelevel	The time level in the file to read
[in]	scale	A scaling factor that the field is multiplied by before they are returned.

Definition at line 850 of file MOM_io.F90.

  character(len=*),       intent(in)    :: filename  !< The name of the file to read
  character(len=*),       intent(in)    :: fieldname !< The variable name of the data in the file
  real, dimension(:),     intent(inout) :: data      !< The 1-dimensional array into which the data
  integer,      optional, intent(in)    :: timelevel !< The time level in the file to read
  real,         optional, intent(in)    :: scale     !< A scaling factor that the field is multiplied
                                                     !! by before they are returned.
 
  call read_data(filename, fieldname, data, timelevel=timelevel, no_domain=.true.)
 
  if (present(scale)) then ; if (scale /= 1.0) then
    data(:) = scale*data(:)
  endif ; endif
 

mom_read_data_2d()

subroutine mom_io::mom_read_data::mom_read_data_2d ( character(len=*), intent(in)  filename, character(len=*), intent(in)  fieldname, real, dimension(:,:), intent(inout)  data, type(mom_domain_type), intent(in)  MOM_Domain, integer, intent(in), optional  timelevel, integer, intent(in), optional  position, real, intent(in), optional  scale  )

private

This function uses the fms_io function read_data to read a distributed 2-D data field named "fieldname" from file "filename". Valid values for "position" include CORNER, CENTER, EAST_FACE and NORTH_FACE.

Parameters

[in]	filename	The name of the file to read
[in]	fieldname	The variable name of the data in the file
[in,out]	data	The 2-dimensional array into which the data should be read
[in]	mom_domain	The MOM_Domain that describes the decomposition
[in]	timelevel	The time level in the file to read
[in]	position	A flag indicating where this data is located
[in]	scale	A scaling factor that the field is multiplied by before they are returned.

Definition at line 870 of file MOM_io.F90.

  character(len=*),       intent(in)    :: filename  !< The name of the file to read
  character(len=*),       intent(in)    :: fieldname !< The variable name of the data in the file
  real, dimension(:,:),   intent(inout) :: data      !< The 2-dimensional array into which the data
                                                     !! should be read
  type(MOM_domain_type),  intent(in)    :: MOM_Domain !< The MOM_Domain that describes the decomposition
  integer,      optional, intent(in)    :: timelevel !< The time level in the file to read
  integer,      optional, intent(in)    :: position  !< A flag indicating where this data is located
  real,         optional, intent(in)    :: scale     !< A scaling factor that the field is multiplied
                                                     !! by before they are returned.
 
  integer :: is, ie, js, je
 
  call read_data(filename, fieldname, data, mom_domain%mpp_domain, &
                 timelevel=timelevel, position=position)
 
  if (present(scale)) then ; if (scale /= 1.0) then
    call get_simple_array_i_ind(mom_domain, size(data,1), is, ie)
    call get_simple_array_j_ind(mom_domain, size(data,2), js, je)
    data(is:ie,js:je) = scale*data(is:ie,js:je)
  endif ; endif
 

mom_read_data_3d()

subroutine mom_io::mom_read_data::mom_read_data_3d ( character(len=*), intent(in)  filename, character(len=*), intent(in)  fieldname, real, dimension(:,:,:), intent(inout)  data, type(mom_domain_type), intent(in)  MOM_Domain, integer, intent(in), optional  timelevel, integer, intent(in), optional  position, real, intent(in), optional  scale  )

private

This function uses the fms_io function read_data to read a distributed 3-D data field named "fieldname" from file "filename". Valid values for "position" include CORNER, CENTER, EAST_FACE and NORTH_FACE.

Parameters

[in]	filename	The name of the file to read
[in]	fieldname	The variable name of the data in the file
[in,out]	data	The 3-dimensional array into which the data should be read
[in]	mom_domain	The MOM_Domain that describes the decomposition
[in]	timelevel	The time level in the file to read
[in]	position	A flag indicating where this data is located
[in]	scale	A scaling factor that the field is multiplied by before they are returned.

Definition at line 898 of file MOM_io.F90.

  character(len=*),       intent(in)    :: filename  !< The name of the file to read
  character(len=*),       intent(in)    :: fieldname !< The variable name of the data in the file
  real, dimension(:,:,:), intent(inout) :: data      !< The 3-dimensional array into which the data
                                                     !! should be read
  type(MOM_domain_type),  intent(in)    :: MOM_Domain !< The MOM_Domain that describes the decomposition
  integer,      optional, intent(in)    :: timelevel !< The time level in the file to read
  integer,      optional, intent(in)    :: position  !< A flag indicating where this data is located
  real,         optional, intent(in)    :: scale     !< A scaling factor that the field is multiplied
                                                     !! by before they are returned.
 
  integer :: is, ie, js, je
 
  call read_data(filename, fieldname, data, mom_domain%mpp_domain, &
                 timelevel=timelevel, position=position)
 
  if (present(scale)) then ; if (scale /= 1.0) then
    call get_simple_array_i_ind(mom_domain, size(data,1), is, ie)
    call get_simple_array_j_ind(mom_domain, size(data,2), js, je)
    data(is:ie,js:je,:) = scale*data(is:ie,js:je,:)
  endif ; endif
 

mom_read_data_4d()

subroutine mom_io::mom_read_data::mom_read_data_4d ( character(len=*), intent(in)  filename, character(len=*), intent(in)  fieldname, real, dimension(:,:,:,:), intent(inout)  data, type(mom_domain_type), intent(in)  MOM_Domain, integer, intent(in), optional  timelevel, integer, intent(in), optional  position, real, intent(in), optional  scale  )

private

This function uses the fms_io function read_data to read a distributed 4-D data field named "fieldname" from file "filename". Valid values for "position" include CORNER, CENTER, EAST_FACE and NORTH_FACE.

Parameters

[in]	filename	The name of the file to read
[in]	fieldname	The variable name of the data in the file
[in,out]	data	The 4-dimensional array into which the data should be read
[in]	mom_domain	The MOM_Domain that describes the decomposition
[in]	timelevel	The time level in the file to read
[in]	position	A flag indicating where this data is located
[in]	scale	A scaling factor that the field is multiplied by before they are returned.

Definition at line 926 of file MOM_io.F90.

  character(len=*),       intent(in)    :: filename  !< The name of the file to read
  character(len=*),       intent(in)    :: fieldname !< The variable name of the data in the file
  real, dimension(:,:,:,:), intent(inout) :: data    !< The 4-dimensional array into which the data
                                                     !! should be read
  type(MOM_domain_type),  intent(in)    :: MOM_Domain !< The MOM_Domain that describes the decomposition
  integer,      optional, intent(in)    :: timelevel !< The time level in the file to read
  integer,      optional, intent(in)    :: position  !< A flag indicating where this data is located
  real,         optional, intent(in)    :: scale     !< A scaling factor that the field is multiplied
                                                     !! by before they are returned.
 
  integer :: is, ie, js, je
 
  call read_data(filename, fieldname, data, mom_domain%mpp_domain, &
                 timelevel=timelevel, position=position)
 
  if (present(scale)) then ; if (scale /= 1.0) then
    call get_simple_array_i_ind(mom_domain, size(data,1), is, ie)
    call get_simple_array_j_ind(mom_domain, size(data,2), js, je)
    data(is:ie,js:je,:,:) = scale*data(is:ie,js:je,:,:)
  endif ; endif
 

---

The documentation for this interface was generated from the following file:

• /glade/work/altuntas/cesm.sandboxes/cesm2_2_alpha_X_mom/components/mom/MOM6/src/framework/MOM_io.F90