Module Documentation

Last modified: Tue Jan 11 13:52:15 2005.


List of Modules


Module Descriptions

NETCDF_UTILITY

[Next Module] [List of Modules]
 NAME:
       netCDF_Utility

 PURPOSE:
       Module containing utility routines for netCDF file access. This module
       also provides access to the Dimension, Attribute, and Variable module
       routines.

 CATEGORY:
       netCDF

 LANGUAGE:
       Fortran-95

 CALLING SEQUENCE:
       USE netCDF_Utility

 MODULES:
       Type_Kinds:                Module containing data type kind
                                  definitions.

       Error_Handler:             Module to define error codes and handle
                                  error conditions
                                  USEs: FILE_UTILITY module

       netcdf:                    Module supplied with the Fortran 90 version
                                  of the netCDF libraries (at least v3.5.0).
                                  See http://www.unidata.ucar.edu/packages/netcdf

       netCDF_Dimension_Utility:  Module containing utility routines
                                  for netCDF file dimension access.
                                  USEs: TYPE_KINDS module
                                        ERROR_HANDLER module
                                        netcdf module

       netCDF_Variable_Utility:   Module containing utility routines
                                  for netCDF file variable access.
                                  USEs: TYPE_KINDS module
                                        ERROR_HANDLER module
                                        netcdf module

       netCDF_Attribute_Utility:  Module containing utility routines
                                  for netCDF file attribute access.
                                  USEs: TYPE_KINDS module
                                        ERROR_HANDLER module
                                        netcdf module

 CONTAINS:
       Remove_NULL_Characters:  Subroutine to remove NULL characters (ASCII 0)
                                from an input string. Strings retrieved from
                                netCDF files are terminated with the NULL
                                character (\0 in C).

       Open_netCDF:             Function to open an existing netCDF data file.
                                This is simply a wrapper for NF90_OPEN so that
                                the netcdf library module is not required in
                                the user calling routine.

       Close_netCDF:            Function to close an open netCDF data file.
                                This is simply a wrapper for NF90_CLOSE so
                                that the netcdf library module is not required
                                in the user calling routine.

 EXTERNALS:
       None.

 COMMON BLOCKS:
       None.

 CREATION HISTORY:
       Written by:   Paul van Delst, CIMSS/SSEC, 20-Nov-2000
                     paul.vandelst@ssec.wisc.edu

  Copyright (C) 2000 Paul van Delst

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 2
  of the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

(See netcdf_utility.f90)


NETCDF_DIMENSION_UTILITY

[Previous Module] [Next Module] [List of Modules]
 NAME:
       netCDF_Dimension_Utility

 PURPOSE:
       Module containing utility routines for netCDF file dimension access.

 CATEGORY:
       netCDF

 LANGUAGE:
       Fortran-95

 CALLING SEQUENCE:
       USE netCDF_Dimension_Utility

 MODULES:
       Type_Kinds:    Module containing data type kind definitions.

       Error_Handler: Module to define error codes and handle error
                      conditions
                      USEs: FILE_UTILITY module

       netcdf:        Module supplied with the Fortran 90 version of the
                      netCDF libraries (at least v3.5.0).
                      See http://www.unidata.ucar.edu/packages/netcdf

 CONTAINS:
       Get_netCDF_Dimension:  Function to retrieve a netCDF file dimension
                              by name. This function is a wrapper for some
                              of the NetCDF library functions to simplify
                              the retrieval of a dimension with error
                              checking.

 EXTERNALS:
       None

 COMMON BLOCKS:
       None.

 CREATION HISTORY:
       Written by:   Paul van Delst, CIMSS/SSEC, 20-Nov-2000
                     paul.vandelst@ssec.wisc.edu

  Copyright (C) 2000 Paul van Delst

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 2
  of the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

(See netcdf_dimension_utility.f90)


NETCDF_VARIABLE_UTILITY

[Previous Module] [Next Module] [List of Modules]
 NAME:
       netCDF_Variable_Utility

 PURPOSE:
       Module containing utility routines for netCDF file variable access.

 CATEGORY:
       netCDF

 LANGUAGE:
       Fortran-95

 CALLING SEQUENCE:
       USE netCDF_Variable_Utility

 MODULES:
       Type_Kinds:    Module containing data type kind definitions.

       Error_Handler: Module to define error codes and handle error
                      conditions
                      USEs: FILE_UTILITY module

       netcdf:        Module supplied with the Fortran 90 version of the
                      netCDF libraries (at least v3.5.0).
                      See http://www.unidata.ucar.edu/packages/netcdf

 CONTAINS:
       Get_netCDF_Variable:  Function to retrieve a netCDF file variable
                             by name. This function is simply a wrapper
                             for some of the NetCDF library functions to
                             simplify the retrieval of variable data with
                             error checking.

       Put_netCDF_Variable:  Function to write a netCDF file variable
                             by name. This function is simply a wrapper
                             for some of the NetCDF library functions to
                             simplify the writing of variable data with
                             error checking.

 EXTERNALS:
       None.

 COMMON BLOCKS:
       None.

 CREATION HISTORY:
       Written by:   Paul van Delst, CIMSS/SSEC, 20-Nov-2000
                     paul.vandelst@ssec.wisc.edu

  Copyright (C) 2000, 2004 Paul van Delst

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 2
  of the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

(See netcdf_variable_utility.f90)


NETCDF_ATTRIBUTE_UTILITY

[Previous Module] [List of Modules]
 NAME:
       netCDF_Attribute_Utility

 PURPOSE:
       Module containing some utility routines for netCDF file attribute access.

 CATEGORY:
       netCDF

 LANGUAGE:
       Fortran-95

 CALLING SEQUENCE:
       USE netCDF_Attribute_Utility

 MODULES:
       Type_Kinds:    Module containing data type kind definitions.

       Error_Handler: Module to define error codes and handle error
                      conditions
                      USEs: FILE_UTILITY module

       netcdf:        Module supplied with the Fortran 90 version of the
                      netCDF libraries (at least v3.5.0).
                      See http://www.unidata.ucar.edu/packages/netcdf

 CONTAINS:
       Get_netCDF_Attribute: Function to retrieve a netCDF variable attribute
                             by name. This function is simply a wrapper
                             for some of the NetCDF library functions to
                             simplify the retrieval of an attribute with
                             error checking.

       Put_netCDF_Attribute: Function to write a netCDF variable attribute
                             by name. This function is simply a wrapper
                             for some of the NetCDF library functions to
                             simplify the writing of an attribute with
                             error checking.

 EXTERNALS:
       None

 COMMON BLOCKS:
       None.

 SIDE EFFECTS:
       For PUT operations, attribute values can be overwritten if they
       already exist in the output file.

 RESTRICTIONS:
       Interfaces are available only for scalar and rank-1 attribute data,
       except for character attributes which only have a scalar interface.

 CREATION HISTORY:
       Written by:   Paul van Delst, CIMSS/SSEC, 11-Feb-2003
                     paul.vandelst@ssec.wisc.edu

  Copyright (C) 2003, 2004 Paul van Delst

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 2
  of the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

(See netcdf_attribute_utility.f90)