ncfilevarsmodule Module Reference

This module contains the NCFileVarsModule. More...

Data Types
type	ncpackagevarstype
	Type describing input variables for a package in NetCDF file. More...
type	ncfilemf6vartype
	Type which describes a modflow input variable in a netcdf file. More...
type	ncfilevarstype
	Type describing modflow6 input variables in model NetCDF file. More...

Functions/Subroutines
subroutine	ncvars_init (this, modelname)
	create netcdf package variable lists More...
integer(i4b) function	ncvars_varid (this, tagname, layer, period, iaux)
	return a netcdf variable id for a package tagname More...
subroutine	ncvars_destroy (this)
	destroy netcdf package variable lists More...
subroutine	fv_init (this, modelname, nc_fname, ncid, grid)
	initialize netcdf model variable description type More...
subroutine	fv_add (this, pkgname, tagname, layer, period, iaux, varid)
	add netcdf modflow6 input variable to list More...
subroutine	fv_destroy (this)
	destroy netcdf model variable description type More...
subroutine	create_varlists (this, modelname, pkgname, nc_vars)
	create list of variables that correspond to a package More...
class(ncfilemf6vartype) function, pointer	ncvar_get (nc_vars, idx)
	get modflow6 input variable description at position idx More...

Detailed Description

These data structures organize package input information associated with a single model netcdf input file.

Function/Subroutine Documentation

create_varlists()

subroutine ncfilevarsmodule::create_varlists ( class(ncfilevarstype)  this, character(len=*), intent(in)  modelname, character(len=*), intent(in)  pkgname, type(ncpackagevarstype), intent(inout), pointer  nc_vars  )

private

Definition at line 227 of file NCFileVars.f90.

    class(NCFileVarsType) :: this
    character(len=*), intent(in) :: modelname
    character(len=*), intent(in) :: pkgname
    type(NCPackageVarsType), pointer, intent(inout) :: nc_vars
    integer(I4B) :: n
    class(NCFileMf6VarType), pointer :: invar, nc_var
    class(*), pointer :: obj
 
    do n = 1, this%mf6invar%count()
      invar => ncvar_get(this%mf6invar, n)
      if (invar%pkgname == pkgname) then
        ! create package variable description
        allocate (nc_var)
        nc_var%pkgname = invar%pkgname
        nc_var%tagname = invar%tagname
        nc_var%layer = invar%layer
        nc_var%period = invar%period
        nc_var%iaux = invar%iaux
        nc_var%varid = invar%varid
        obj => nc_var
        call nc_vars%nc_vars%Add(obj)
      end if
    end do
 
    ! set modelname
    nc_vars%modelname = modelname
 
    ! set file attribute pointers
    nc_vars%ncid => this%ncid
    nc_vars%nc_fname => this%nc_fname
    nc_vars%grid => this%grid

Here is the call graph for this function:

fv_add()

subroutine ncfilevarsmodule::fv_add	(	class(ncfilevarstype)	this,
		character(len=*), intent(in)	pkgname,
		character(len=*), intent(in)	tagname,
		integer(i4b), intent(in)	layer,
		integer(i4b), intent(in)	period,
		integer(i4b), intent(in)	iaux,
		integer(i4b), intent(in)	varid
	)

Definition at line 188 of file NCFileVars.f90.

    use arrayhandlersmodule, only: expandarray
    class(NCFileVarsType) :: this
    character(len=*), intent(in) :: pkgname
    character(len=*), intent(in) :: tagname
    integer(I4B), intent(in) :: layer
    integer(I4B), intent(in) :: period
    integer(I4B), intent(in) :: iaux
    integer(I4B), intent(in) :: varid
    class(NCFileMf6VarType), pointer :: invar
    class(*), pointer :: obj
    ! add mf6 variable to file list
    allocate (invar)
    invar%pkgname = pkgname
    invar%tagname = tagname
    invar%layer = layer
    invar%period = period
    invar%iaux = iaux
    invar%varid = varid
    obj => invar
    call this%mf6invar%Add(obj)

fv_destroy()

subroutine ncfilevarsmodule::fv_destroy

(

class(ncfilevarstype)

this

)

Definition at line 213 of file NCFileVars.f90.

    class(NCFileVarsType) :: this
    class(NCFileMf6VarType), pointer :: invar
    integer(I4B) :: n
    do n = 1, this%mf6invar%Count()
      invar => ncvar_get(this%mf6invar, n)
      deallocate (invar)
      nullify (invar)
    end do
    call this%mf6invar%Clear()

Here is the call graph for this function:

fv_init()

subroutine ncfilevarsmodule::fv_init ( class(ncfilevarstype)  this, character(len=*), intent(in)  modelname, character(len=*), intent(in)  nc_fname, integer(i4b), intent(in)  ncid, character(len=*), intent(in)  grid  )

private

Definition at line 156 of file NCFileVars.f90.

    use constantsmodule, only: lenmempath
    use memorymanagermodule, only: mem_allocate
    use memoryhelpermodule, only: create_mem_path
    use simvariablesmodule, only: idm_context
    class(NCFileVarsType) :: this
    character(len=*), intent(in) :: modelname
    character(len=*), intent(in) :: nc_fname
    integer(I4B), intent(in) :: ncid
    character(len=*), intent(in) :: grid
    character(len=LENMEMPATH) :: mempath
    integer(I4B) :: ilen
 
    ! set mempath
    mempath = create_mem_path(component=modelname, &
                              context=idm_context)
    ! initialize strlen
    ilen = linelength
 
    ! allocate managed memory
    call mem_allocate(this%grid, ilen, 'NETCDF_GRID', mempath)
    call mem_allocate(this%nc_fname, ilen, 'NETCDF_FNAME', mempath)
    call mem_allocate(this%ncid, 'NCID', mempath)
 
    ! set
    this%grid = grid
    this%nc_fname = nc_fname
    this%ncid = ncid

Here is the call graph for this function:

ncvar_get()

class(ncfilemf6vartype) function, pointer ncfilevarsmodule::ncvar_get ( type(listtype)  nc_vars, integer(i4b), intent(in)  idx  )

private

Parameters

[in]

idx

package number

Definition at line 263 of file NCFileVars.f90.

    type(ListType) :: nc_vars
    integer(I4B), intent(in) :: idx !< package number
    class(NCFileMf6VarType), pointer :: res
    class(*), pointer :: obj
 
    ! initialize res
    res => null()
 
    ! get the package from the list
    obj => nc_vars%GetItem(idx)
    if (associated(obj)) then
      select type (obj)
      class is (ncfilemf6vartype)
        res => obj
      end select
    end if

Here is the caller graph for this function:

ncvars_destroy()

subroutine ncfilevarsmodule::ncvars_destroy ( class(ncpackagevarstype)  this )

private

Definition at line 141 of file NCFileVars.f90.

    class(NCPackageVarsType) :: this
    class(NCFileMf6VarType), pointer :: nc_var
    integer(I4B) :: n
    ! deallocate allocated memory
    do n = 1, this%nc_vars%Count()
      nc_var => ncvar_get(this%nc_vars, n)
      deallocate (nc_var)
      nullify (nc_var)
    end do
    call this%nc_vars%Clear()

Here is the call graph for this function:

ncvars_init()

subroutine ncfilevarsmodule::ncvars_init ( class(ncpackagevarstype)  this, character(len=*), intent(in)  modelname  )

private

Definition at line 64 of file NCFileVars.f90.

    class(NCPackageVarsType) :: this
    character(len=*), intent(in) :: modelname
    ! set modelname
    this%modelname = modelname

ncvars_varid()

integer(i4b) function ncfilevarsmodule::ncvars_varid ( class(ncpackagevarstype)  this, character(len=*), intent(in)  tagname, integer(i4b), optional  layer, integer(i4b), optional  period, integer(i4b), optional  iaux  )

private

Definition at line 73 of file NCFileVars.f90.

    class(NCPackageVarsType) :: this
    character(len=*), intent(in) :: tagname
    integer(I4B), optional :: layer
    integer(I4B), optional :: period
    integer(I4B), optional :: iaux
    integer(I4B) :: varid
    integer(I4B) :: n, l, p, a
    class(NCFileMf6VarType), pointer :: nc_var
 
    ! initialize
    varid = -1
    l = -1
    p = -1
    a = -1
 
    ! set search layer if provided
    if (present(layer)) then
      l = layer
    end if
 
    ! set search period if provided
    if (present(period)) then
      p = period
    end if
    ! set search iaux if provided
    if (present(iaux)) then
      a = iaux
    end if
 
    do n = 1, this%nc_vars%Count()
      nc_var => ncvar_get(this%nc_vars, n)
      if (nc_var%tagname == tagname .and. &
          nc_var%layer == l .and. &
          nc_var%period == p .and. &
          nc_var%iaux == a) then
        varid = nc_var%varid
      end if
    end do
 
    ! set error and exit if variable not in NetCDF input
    if (varid == -1) then
      if (this%nc_fname /= '') then
        write (errmsg, '(a)') &
          'NetCDF variable not found, tagname="'//trim(tagname)//'"'
        if (present(layer)) then
          write (errmsg, '(a,i0)') trim(errmsg)//', ilayer=', layer
        end if
        if (present(period)) then
          write (errmsg, '(a,i0)') trim(errmsg)//', period=', period
        end if
        if (present(iaux)) then
          write (errmsg, '(a,i0)') trim(errmsg)//', iaux=', iaux
        end if
        write (errmsg, '(a)') trim(errmsg)//'.'
        call store_error(errmsg)
        call store_error_filename(this%nc_fname)
      else
        write (errmsg, '(a)') &
          'NetCDF variable not found, tagname="'//trim(tagname)// &
          '". NetCDF input not provided for model "'//trim(this%modelname)//'".'
        call store_error(errmsg, .true.)
      end if
    end if

Here is the call graph for this function: