nf_mod Module

@file

$Revision$ $LastChangedDate$

@defgroup PIO_def_dim

@defgroup PIO_enddef

\defgroup PIO_redef

\defgroup PIO_inquire

\defgroup PIO_inq_dimid

\defgroup PIO_inq_dimname

\defgroup PIO_inq_dimlen

\defgroup PIO_inquire_dimension

\defgroup PIO_copy_att


Uses


Interfaces

public interface pio_def_var

\defgroup PIO_def_var

  • private function def_var_0d(File, name, type, vardesc) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(in) :: File

    copydoc: file_desc_t
    character(len=*), intent(in) :: name

    : The name of the variable to define
    integer, intent(in) :: type

    : The type of variable
    type(Var_desc_t), intent(inout) :: vardesc

    copydoc: var_desc_t

    Return Value integer

  • private function def_var_md(File, name, type, dimids, vardesc) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(in) :: File

    copydoc: file_desc_t
    character(len=*), intent(in) :: name

    : The name of the variable to define
    integer, intent(in) :: type

    : The type of variable
    integer, intent(in) :: dimids(:)
    type(Var_desc_t), intent(inout) :: vardesc

    copydoc: var_desc_t

    Return Value integer

public interface pio_inq_varid

\defgroup PIO_inq_varid

  • private function inq_varid_vid(File, name, varid) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(in) :: File

    copydoc: file_desc_t
    character(len=*), intent(in) :: name

    : Name of the returned attribute
    integer(kind=i4), intent(out) :: varid

    : variable ID

    Return Value integer

  • private function inq_varid_vardesc(File, name, vardesc) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(in) :: File

    copydoc: file_desc_t
    character(len=*), intent(in) :: name

    : Name of the returned attribute
    type(Var_desc_t), intent(inout) :: vardesc

    copydoc: var_desc_t

    Return Value integer

public interface pio_inq_att

\defgroup PIO_inq_att

  • private function inq_att_vid(File, varid, name, xtype, len) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(inout) :: File

    copydoc: file_desc_t
    integer(kind=i4), intent(in) :: varid

    : The netcdf variable identifier
    character(len=*), intent(in) :: name

    : Name of the attribute
    integer, intent(out) :: xtype

    : The type of attribute
    integer, intent(out) :: len

    : The length of the attribute

    Return Value integer

  • private function inq_att_vardesc(File, vardesc, name, xtype, len) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(inout) :: File

    copydoc: file_desc_t
    type(Var_desc_t), intent(in) :: vardesc

    copydoc: var_desc_t
    character(len=*), intent(in) :: name

    : Name of the attribute
    integer, intent(out) :: xtype

    : The type of attribute
    integer, intent(out) :: len

    : The length of the attribute

    Return Value integer

  • private function inq_att_vardesc_pio2(File, vardesc, name, xtype, len) result(ierr)

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(inout) :: File
    type(Var_desc_t), intent(in) :: vardesc
    character(len=*), intent(in) :: name
    integer, intent(out) :: xtype
    integer(kind=pio_offset), intent(out) :: len

    Return Value integer

  • private function inq_att_vid_pio2(File, varid, name, xtype, len) result(ierr)

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(inout) :: File
    integer, intent(in) :: varid
    character(len=*), intent(in) :: name
    integer, intent(out) :: xtype
    integer(kind=pio_offset), intent(out) :: len

    Return Value integer

public interface pio_inq_attlen

\defgroup PIO_inq_attlen

  • private function inq_attlen_vid(File, varid, name, len) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(inout) :: File

    copydoc: file_desc_t
    integer(kind=i4), intent(in) :: varid

    : attribute id
    character(len=*), intent(in) :: name

    : name of attribute
    integer, intent(out) :: len

    : Length of attribute

    Return Value integer

  • private function inq_attlen_vardesc(File, vardesc, name, len) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(inout) :: File

    copydoc: file_desc_t
    type(Var_desc_t), intent(in) :: vardesc

    copydoc: var_desc_t
    character(len=*), intent(in) :: name

    : name of attribute
    integer, intent(out) :: len

    : Length of attribute

    Return Value integer

  • private function inq_attlen_vardesc_pio2(File, vardesc, name, len) result(ierr)

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(inout) :: File
    type(Var_desc_t), intent(in) :: vardesc
    character(len=*), intent(in) :: name
    integer(kind=pio_offset), intent(out) :: len

    Return Value integer

  • private function inq_attlen_vid_pio2(File, vid, name, len) result(ierr)

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(inout) :: File
    integer, intent(in) :: vid
    character(len=*), intent(in) :: name
    integer(kind=pio_offset), intent(out) :: len

    Return Value integer

public interface pio_inq_attname

\defgroup PIO_inq_attname

  • private function inq_attname_vid(File, varid, attnum, name) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(inout) :: File

    copydoc: file_desc_t
    integer(kind=i4), intent(in) :: varid

    : The variable ID
    integer, intent(in) :: attnum

    : Attribute number returned from function ????
    character(len=*), intent(out) :: name

    : Name of the returned attribute

    Return Value integer

  • private function inq_attname_vardesc(File, vardesc, attnum, name) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(inout) :: File

    copydoc: file_desc_t
    type(Var_desc_t), intent(in) :: vardesc

    copydoc: var_desc_t
    integer, intent(in) :: attnum

    : Attribute number returned from function ????
    character(len=*), intent(out) :: name

    : Name of the returned attribute

    Return Value integer

public interface pio_inq_varname

\defgroup PIO_inq_varname

  • private function inq_varname_vid(File, varid, name) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(in) :: File

    copydoc: file_desc_t
    integer, intent(in) :: varid

    : The netcdf variable id.
    character(len=*), intent(out) :: name

    : The name of the netcdf variable.

    Return Value integer

  • private function inq_varname_vdesc(File, vardesc, name) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(in) :: File

    copydoc: file_desc_t
    type(Var_desc_t), intent(in) :: vardesc

    copydoc: var_desc_t
    character(len=*), intent(out) :: name

    : The name of the netcdf variable.

    Return Value integer

public interface pio_inq_varndims

\defgroup PIO_inq_varndims

  • private function inq_varndims_vid(File, varid, ndims) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(in) :: File

    copydoc: file_desc_t
    integer, intent(in) :: varid

    : The variable identifier
    integer(kind=i4), intent(out) :: ndims

    : The number of dimensions for the variable

    Return Value integer

  • private function inq_varndims_vdesc(File, vardesc, ndims) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(in) :: File

    copydoc: file_desc_t
    type(Var_desc_t), intent(in) :: vardesc

    copydoc: var_desc_t
    integer(kind=i4), intent(out) :: ndims

    : The number of dimensions for the variable

    Return Value integer

public interface pio_inq_varnatts

\defgroup PIO_inq_varnatts

  • private function inq_varnatts_vid(File, varid, natts) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(in) :: File

    copydoc: file_desc_t
    integer, intent(in) :: varid

    : The netcdf variable id
    integer(kind=i4), intent(out) :: natts

    : The number of attributes associated with the variable

    Return Value integer

  • private function inq_varnatts_vdesc(File, vardesc, natts) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(in) :: File

    copydoc: file_desc_t
    type(Var_desc_t), intent(in) :: vardesc

    copydoc: var_desc_t
    integer(kind=i4), intent(out) :: natts

    : The number of attributes associated with the variable

    Return Value integer

public interface pio_inq_vardimid

\defgroup PIO_inq_vardimid

  • private function inq_vardimid_vid(File, varid, dimids) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(in) :: File

    copydoc: file_desc_t
    integer, intent(in) :: varid

    : The variable id
    integer(kind=i4), intent(out) :: dimids(:)

    Return Value integer

  • private function inq_vardimid_vdesc(File, vardesc, dimids) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(in) :: File

    copydoc: file_desc_t
    type(Var_desc_t), intent(in) :: vardesc

    copydoc: var_desc_t
    integer(kind=i4), intent(out) :: dimids(:)

    Return Value integer

public interface pio_inq_vartype

\defgroup PIO_inq_vartype

  • private function inq_vartype_vid(File, varid, type) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(in) :: File

    copydoc: file_desc_t
    integer, intent(in) :: varid

    : The netcdf variable id
    integer(kind=i4), intent(out) :: type

    : The type of variable

    Return Value integer

  • private function inq_vartype_vdesc(File, vardesc, type) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(in) :: File

    copydoc: file_desc_t
    type(Var_desc_t), intent(in) :: vardesc

    copydoc: var_desc_t
    integer(kind=i4), intent(out) :: type

    : The type of variable

    Return Value integer

public interface pio_inquire_variable

\defgroup PIO_inquire_variable

  • private function inquire_variable_vid(ncid, varid, name, xtype, ndims, dimids, natts) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(in) :: ncid

    : A netcdf file descriptor returned by \ref PIO_openfile or \ref PIO_createfile.
    integer, intent(in) :: varid

    : The netcdf variable ID.
    character(len=*), intent(out), optional :: name

    : The name of the variable
    integer, intent(out), optional :: xtype

    : The type of the variable
    integer, intent(out), optional :: ndims

    : The type of the variable : The number of dimensions for the variable.
    integer, intent(out), optional, dimension(:) :: dimids

    : The dimension identifier returned by \ref PIO_def_dim
    integer, intent(out), optional :: natts

    : Number of attributes associated with the variable

    Return Value integer

  • private function inquire_variable_vdesc(ncid, vardesc, name, xtype, ndims, dimids, natts) result(ierr)

    @public @details

    Arguments

    Type IntentOptional Attributes Name
    type(File_desc_t), intent(in) :: ncid

    : A netcdf file descriptor returned by \ref PIO_openfile or \ref PIO_createfile.
    type(Var_desc_t), intent(in) :: vardesc

    copydoc: var_desc_t
    character(len=*), intent(out), optional :: name

    : The name of the variable
    integer, intent(out), optional :: xtype

    : The type of the variable
    integer, intent(out), optional :: ndims

    : The type of the variable : The number of dimensions for the variable.
    integer, intent(out), optional, dimension(:) :: dimids

    : The dimension identifier returned by \ref PIO_def_dim
    integer, intent(out), optional :: natts

    : Number of attributes associated with the variable

    Return Value integer


Functions

public function pio_inquire(File, nDimensions, nVariables, nAttributes, unlimitedDimID) result(ierr)

Gets metadata information for netcdf file.

Read more…

Arguments

Type IntentOptional Attributes Name
type(File_desc_t), intent(in) :: File

copydoc: file_desc_t
integer, intent(out), optional :: nDimensions

: Number of dimensions defined for the netcdf file
integer, intent(out), optional :: nVariables

: Number of dimensions defined for the netcdf file : Number of variables defined for the netcdf file
integer, intent(out), optional :: nAttributes

: Number of dimensions defined for the netcdf file : Number of variables defined for the netcdf file : Number of attributes defined for the netcdf file
integer, intent(out), optional :: unlimitedDimID

: Number of dimensions defined for the netcdf file : Number of variables defined for the netcdf file : Number of attributes defined for the netcdf file : the Unlimited dimension ID

Return Value integer

public function pio_inq_dimid(File, name, dimid) result(ierr)

Returns the netcdf dimension id for the name.

Read more…

Arguments

Type IntentOptional Attributes Name
type(File_desc_t), intent(in) :: File

copydoc: file_desc_t
character(len=*), intent(in) :: name

: The name of the netcdf dimension.
integer, intent(out) :: dimid

: The netcdf dimension id.

Return Value integer

public function pio_inq_dimname(File, dimid, dimname) result(ierr)

Gets the name of a dimension given its ID

Read more…

Arguments

Type IntentOptional Attributes Name
type(File_desc_t), intent(in) :: File

copydoc: file_desc_t
integer, intent(in) :: dimid

: The netcdf dimension id.
character(len=*), intent(out) :: dimname

: The name associated with the netcdf dimension id.

Return Value integer

public function pio_inq_dimlen(File, dimid, dimlen) result(ierr)

Returns the extent of a netCDF dimension

Read more…

Arguments

Type IntentOptional Attributes Name
type(File_desc_t), intent(in) :: File

copydoc: file_desc_t
integer(kind=i4), intent(in) :: dimid

: The netcdf dimension.
integer(kind=i4), intent(out) :: dimlen

: The extent of the netcdf dimension.

Return Value integer

public function PIO_enddef(File) result(ierr)

Exits netcdf define mode.

Read more…

Arguments

Type IntentOptional Attributes Name
type(File_desc_t), intent(inout) :: File

copydoc: file_desc_t

Return Value integer

public function PIO_redef(File) result(ierr)

Re-enters netcdf define mode.

Read more…

Arguments

Type IntentOptional Attributes Name
type(File_desc_t), intent(inout) :: File

copydoc: file_desc_t

Return Value integer

public function PIO_def_dim(File, name, len, dimid) result(ierr)

Defines the netcdf dimension

Read more…

Arguments

Type IntentOptional Attributes Name
type(File_desc_t), intent(in) :: File

copydoc: file_desc_t
character(len=*), intent(in) :: name

: The name of the dimension to define
integer(kind=i4), intent(in) :: len

: The size of the dimension
integer(kind=i4), intent(out) :: dimid

: The dimension identifier

Return Value integer

public function pio_copy_att(infile, invarid, name, outfile, outvarid) result(ierr)

No idea what this function does

Read more…

Arguments

Type IntentOptional Attributes Name
type(File_desc_t), intent(in) :: infile

copydoc: file_desc_t
integer, intent(in) :: invarid

:
character(len=*), intent(in) :: name

:
type(File_desc_t), intent(in) :: outfile

:
integer, intent(in) :: outvarid

: :

Return Value integer

public function PIO_inquire_dimension(ncid, dimid, name, len) result(ierr)

Get information about a particular dimension in netcdf file

Read more…

Arguments

Type IntentOptional Attributes Name
type(File_desc_t), intent(in) :: ncid

: A netcdf file descriptor returned by \ref PIO_openfile or \ref PIO_createfile.
integer, intent(in) :: dimid

: The netcdf dimension ID.
character(len=*), intent(out), optional :: name

: The name of the dimension.
integer, intent(out), optional :: len

: The length of the dimesions name.

Return Value integer