ncmodelexportmodule Module Reference

This module contains the NCModelExportModule. More...

Data Types
type	exportpackagetype
type	ncexportannotation
	netcdf export attribute annotations More...
type	ncmodelexporttype
	base class for an export model More...
type	ncbasemodelexporttype
	abstract type for model netcdf export type More...
interface	model_define
	abstract interfaces for model netcdf export type More...
interface	model_step
interface	package_export
interface	package_export_ilayer

Enumerations
enum
	netcdf export types enumerator More...

Functions/Subroutines
subroutine	epkg_init (this, mf6_input, mshape, param_names, nparam)
	initialize dynamic package export object More...
subroutine	epkg_destroy (this)
	destroy dynamic package export object More...
subroutine	set (this, modelname, modeltype, modelfname, nctype)
	set netcdf file scoped attributes More...
subroutine	export_init (this, modelname, modeltype, modelfname, disenum, nctype, iout)
	initialization of model netcdf export More...
class(exportpackagetype) function, pointer	export_get (this, idx)
	retrieve dynamic export object from package list More...
character(len=linelength) function	input_attribute (this, pkgname, idt)
	build modflow6_input attribute string More...
character(len=linelength) function, public	export_longname (longname, pkgname, tagname, layer, iper)
	build netcdf variable longname More...
subroutine	export_input (this)
	netcdf dynamic package period export More...
subroutine	export_destroy (this)
	destroy model netcdf export object More...

Variables
@, public	netcdf_undef = 0
	undefined netcdf export type More...
@, public	netcdf_ugrid = 1
	netcdf mesh export More...
@, public	netcdf_structured = 2
	netcdf structrured export More...

Detailed Description

This module defines a model export and base type for supported netcdf files and is not dependent on netcdf libraries.

Enumeration Type Documentation

anonymous enum

anonymous enum

private

Definition at line 30 of file NCModel.f90.

Function/Subroutine Documentation

epkg_destroy()

subroutine ncmodelexportmodule::epkg_destroy

(

class(exportpackagetype), intent(inout)

this

)

Definition at line 184 of file NCModel.f90.

    use inputdefinitionmodule, only: inputparamdefinitiontype
    ! -- dummy
    class(ExportPackageType), intent(inout) :: this
    if (allocated(this%param_names)) deallocate (this%param_names)

epkg_init()

subroutine ncmodelexportmodule::epkg_init ( class(exportpackagetype), intent(inout)  this, type(modflowinputtype), intent(in)  mf6_input, integer(i4b), dimension(:), intent(in), pointer, contiguous  mshape, character(len=linelength), dimension(:), intent(in), allocatable  param_names, integer(i4b), intent(in)  nparam  )

private

Parameters

[in]

mshape

model shape

Definition at line 139 of file NCModel.f90.

    use simvariablesmodule, only: idm_context
    use memorymanagermodule, only: mem_setptr
    use memorymanagerextmodule, only: mem_set_value
    use memoryhelpermodule, only: create_mem_path
    ! -- dummy
    class(ExportPackageType), intent(inout) :: this
    type(ModflowInputType), intent(in) :: mf6_input
    integer(I4B), dimension(:), pointer, contiguous, intent(in) :: mshape !< model shape
    character(len=LINELENGTH), dimension(:), allocatable, &
      intent(in) :: param_names
    integer(I4B), intent(in) :: nparam
    integer(I4B) :: n
    character(len=LENVARNAME) :: rs_varname
    character(len=LENMEMPATH) :: input_mempath
    integer(I4B), pointer :: rsvar
    !
    this%mf6_input = mf6_input
    this%mshape => mshape
    this%nparam = nparam
    this%iper_export = 0
    !
    input_mempath = create_mem_path(component=mf6_input%component_name, &
                                    subcomponent=mf6_input%subcomponent_name, &
                                    context=idm_context)
    !
    ! -- allocate param arrays
    allocate (this%param_names(nparam))
    allocate (this%param_reads(nparam))
    !
    ! -- set param arrays
    do n = 1, nparam
      this%param_names(n) = param_names(n)
      rs_varname = rsv_name(param_names(n))
      call mem_setptr(rsvar, rs_varname, mf6_input%mempath)
      this%param_reads(n)%invar => rsvar
    end do
    !
    ! -- set pointer to loaded input period
    call mem_setptr(this%iper, 'IPER', mf6_input%mempath)

Here is the call graph for this function:

export_destroy()

subroutine ncmodelexportmodule::export_destroy

(

class(ncmodelexporttype), intent(inout)

this

)

Definition at line 489 of file NCModel.f90.

    use memorymanagerextmodule, only: memorystore_remove
    use simvariablesmodule, only: idm_context
    class(NCModelExportType), intent(inout) :: this
    !
    ! -- override in derived class
    deallocate (this%deflate)
    deallocate (this%shuffle)
    deallocate (this%input_attr)
    deallocate (this%chunk_time)
    !
    ! -- Deallocate idm memory
    if (this%ncf_mempath /= '') then
      call memorystore_remove(this%modelname, 'NCF', idm_context)
    end if

Here is the call graph for this function:

export_get()

class(exportpackagetype) function, pointer ncmodelexportmodule::export_get	(	class(ncmodelexporttype), intent(inout)	this,
		integer(i4b), intent(in)	idx
	)

Definition at line 381 of file NCModel.f90.

    use listmodule, only: listtype
    class(NCModelExportType), intent(inout) :: this
    integer(I4B), intent(in) :: idx
    class(ExportPackageType), pointer :: res
    class(*), pointer :: obj
    !
    nullify (res)
    obj => this%pkglist%GetItem(idx)
    if (associated(obj)) then
      select type (obj)
      class is (exportpackagetype)
        res => obj
      end select
    end if

export_init()

subroutine ncmodelexportmodule::export_init	(	class(ncmodelexporttype), intent(inout)	this,
		character(len=*), intent(in)	modelname,
		character(len=*), intent(in)	modeltype,
		character(len=*), intent(in)	modelfname,
		integer(i4b), intent(in)	disenum,
		integer(i4b), intent(in)	nctype,
		integer(i4b), intent(in)	iout
	)

Definition at line 260 of file NCModel.f90.

    use simvariablesmodule, only: isim_mode, idm_context
    use tdismodule, only: datetime0, nstp
    use constantsmodule, only: mvalidate
    use memorymanagermodule, only: mem_setptr
    use memoryhelpermodule, only: create_mem_path
    use memorymanagerextmodule, only: mem_set_value
    use inputoutputmodule, only: lowcase
    use utlncfinputmodule, only: utlncfparamfoundtype
    class(NCModelExportType), intent(inout) :: this
    character(len=*), intent(in) :: modelname
    character(len=*), intent(in) :: modeltype
    character(len=*), intent(in) :: modelfname
    integer(I4B), intent(in) :: disenum
    integer(I4B), intent(in) :: nctype
    integer(I4B), intent(in) :: iout
    character(len=LENMEMPATH) :: model_mempath
    type(UtlNcfParamFoundType) :: found
    logical(LGP) :: found_mempath
    !
    ! -- allocate
    allocate (this%deflate)
    allocate (this%shuffle)
    allocate (this%input_attr)
    allocate (this%chunk_time)
    !
    ! -- initialize
    this%modelname = modelname
    this%modeltype = modeltype
    this%modelfname = modelfname
    this%nc_fname = trim(modelname)//'.nc'
    this%gridmap_name = ''
    this%ncf_mempath = ''
    this%ogc_wkt = ''
    this%datetime = ''
    this%xname = ''
    this%disenum = disenum
    this%ncid = 0
    this%stepcnt = 0
    this%totnstp = 0
    this%deflate = -1
    this%shuffle = 0
    this%input_attr = 1
    this%chunk_time = -1
    this%iout = iout
    this%chunking_active = .false.
    !
    call lowcase(this%nc_fname)
    !
    ! -- set file scoped attributes
    call this%annotation%set(modelname, modeltype, modelfname, nctype)
    !
    ! -- set dependent variable basename
    select case (modeltype)
    case ('GWF')
      this%xname = 'head'
    case ('GWT')
      this%xname = 'concentration'
    case ('GWE')
      this%xname = 'temperature'
    case default
      errmsg = trim(modeltype)//' models not supported for NetCDF export.'
      call store_error(errmsg)
      call store_error_filename(modelfname)
    end select
    !
    ! -- set discretization input mempath
    if (disenum == dis) then
      this%dis_mempath = create_mem_path(modelname, 'DIS', idm_context)
    else if (disenum == disu) then
      this%dis_mempath = create_mem_path(modelname, 'DISU', idm_context)
    else if (disenum == disv) then
      this%dis_mempath = create_mem_path(modelname, 'DISV', idm_context)
    end if
    !
    ! -- set dependent variable pointer
    model_mempath = create_mem_path(component=modelname)
    call mem_setptr(this%x, 'X', model_mempath)
    !
    ! --set ncf_mempath if provided
    call mem_set_value(this%ncf_mempath, 'NCF6_MEMPATH', this%dis_mempath, &
                       found_mempath)
    !
    if (found_mempath) then
      call mem_set_value(this%ogc_wkt, 'OGC_WKT', this%ncf_mempath, &
                         found%ogc_wkt)
      call mem_set_value(this%deflate, 'DEFLATE', this%ncf_mempath, &
                         found%deflate)
      call mem_set_value(this%shuffle, 'SHUFFLE', this%ncf_mempath, &
                         found%shuffle)
      call mem_set_value(this%input_attr, 'ATTR_OFF', this%ncf_mempath, &
                         found%attr_off)
      call mem_set_value(this%chunk_time, 'CHUNK_TIME', this%ncf_mempath, &
                         found%chunk_time)
    end if
    !
    if (found%ogc_wkt) then
      this%gridmap_name = 'projection'
    end if
    !
    ! -- ATTR_OFF turns off modflow 6 input attributes
    if (found%attr_off) then
      this%input_attr = 0
    end if
    !
    ! -- set datetime string
    if (isim_mode /= mvalidate .and. datetime0 == '') then
      errmsg = 'TDIS parameter START_DATE_TIME required for NetCDF export.'
      call store_error(errmsg)
      call store_error_filename(modelfname)
    else
      this%datetime = 'days since '//trim(datetime0)
    end if
    !
    ! -- set total nstp
    this%totnstp = sum(nstp)

Here is the call graph for this function:

export_input()

subroutine ncmodelexportmodule::export_input

(

class(ncbasemodelexporttype), intent(inout)

this

)

Definition at line 450 of file NCModel.f90.

    use tdismodule, only: kper
    use arrayhandlersmodule, only: ifind
    class(NCBaseModelExportType), intent(inout) :: this
    integer(I4B) :: idx, ilayer
    class(ExportPackageType), pointer :: export_pkg
    character(len=LENVARNAME) :: ilayer_varname
    !
    do idx = 1, this%pkglist%Count()
      !
      export_pkg => this%get(idx)
      ! -- last loaded data is not current period
      if (export_pkg%iper /= kper) cycle
      ! -- period input already exported
      if (export_pkg%iper_export >= export_pkg%iper) cycle
      ! -- set exported iper
      export_pkg%iper_export = export_pkg%iper
      !
      ! -- initialize ilayer
      ilayer = 0
      !
      ! -- set expected ilayer index variable name
      ilayer_varname = 'I'//trim(export_pkg%mf6_input%subcomponent_type(1:3))
      !
      ! -- is ilayer variable in param name list
      ilayer = ifind(export_pkg%param_names, ilayer_varname)
      !
      ! -- layer index variable is required to be first defined in period block
      if (ilayer == 1) then
        call this%package_step_ilayer(export_pkg, ilayer_varname, ilayer)
      else
        call this%package_step(export_pkg)
      end if
      !
    end do

export_longname()

character(len=linelength) function, public ncmodelexportmodule::export_longname	(	character(len=*), intent(in)	longname,
		character(len=*), intent(in)	pkgname,
		character(len=*), intent(in)	tagname,
		integer(i4b), intent(in)	layer,
		integer(i4b), intent(in), optional	iper
	)

Definition at line 419 of file NCModel.f90.

    use inputoutputmodule, only: lowcase
    character(len=*), intent(in) :: longname
    character(len=*), intent(in) :: pkgname
    character(len=*), intent(in) :: tagname
    integer(I4B), intent(in) :: layer
    integer(I4B), optional, intent(in) :: iper
    character(len=LINELENGTH) :: lname
    character(len=LINELENGTH) :: pname, vname
    !
    pname = pkgname
    vname = tagname
    call lowcase(pname)
    call lowcase(vname)
    if (longname == '') then
      lname = trim(pname)//' '//trim(vname)
    else
      lname = longname
    end if
    if (layer > 0) then
      write (lname, '(a,i0)') trim(lname)//' layer=', layer
    end if
    if (present(iper)) then
      if (iper > 0) then
        write (lname, '(a,i0)') trim(lname)//' period=', iper
      end if
    end if

Here is the call graph for this function:

Here is the caller graph for this function:

input_attribute()

character(len=linelength) function ncmodelexportmodule::input_attribute	(	class(ncmodelexporttype), intent(inout)	this,
		character(len=*), intent(in)	pkgname,
		type(inputparamdefinitiontype), intent(in), pointer	idt
	)

Definition at line 400 of file NCModel.f90.

    use inputoutputmodule, only: lowcase
    use memoryhelpermodule, only: mempathseparator
    use inputdefinitionmodule, only: inputparamdefinitiontype
    class(NCModelExportType), intent(inout) :: this
    character(len=*), intent(in) :: pkgname
    type(InputParamDefinitionType), pointer, intent(in) :: idt
    character(len=LINELENGTH) :: attr
    !
    attr = ''
    !
    if (this%input_attr > 0) then
      attr = trim(this%modelname)//mempathseparator//trim(pkgname)// &
             mempathseparator//trim(idt%mf6varname)
    end if

Here is the call graph for this function:

set()

subroutine ncmodelexportmodule::set	(	class(ncexportannotation), intent(inout)	this,
		character(len=*), intent(in)	modelname,
		character(len=*), intent(in)	modeltype,
		character(len=*), intent(in)	modelfname,
		integer(i4b), intent(in)	nctype
	)

Definition at line 193 of file NCModel.f90.

    use versionmodule, only: version
    class(NCExportAnnotation), intent(inout) :: this
    character(len=*), intent(in) :: modelname
    character(len=*), intent(in) :: modeltype
    character(len=*), intent(in) :: modelfname
    integer(I4B), intent(in) :: nctype
    character(len=LINELENGTH) :: fullname
    integer :: values(8)
    !
    this%title = ''
    this%model = ''
    this%grid = ''
    this%history = ''
    this%source = ''
    this%conventions = ''
    this%stdname = ''
    this%longname = ''
    !
    ! -- set file conventions
    this%conventions = 'CF-1.11'
    if (nctype == netcdf_ugrid) this%conventions = &
      trim(this%conventions)//' UGRID-1.0'
    !
    ! -- set model specific attributes
    select case (modeltype)
    case ('GWF')
      fullname = 'Groundwater Flow'
      this%title = trim(modelname)//' hydraulic head'
      this%longname = 'head'
    case ('GWT')
      fullname = 'Groundwater Transport'
      this%title = trim(modelname)//' concentration'
      this%longname = 'concentration'
    case ('GWE')
      fullname = 'Groundwater Energy'
      this%title = trim(modelname)//' temperature'
      this%longname = 'temperature'
    case default
      errmsg = trim(modeltype)//' models not supported for NetCDF export.'
      call store_error(errmsg)
      call store_error_filename(modelfname)
    end select
    !
    ! -- set export type
    if (nctype == netcdf_ugrid) then
      this%grid = 'LAYERED MESH'
    else if (nctype == netcdf_structured) then
      this%grid = 'STRUCTURED'
    end if
    !
    ! -- model description string
    this%model = trim(modelname)//': MODFLOW 6 '//trim(fullname)// &
                 ' ('//trim(modeltype)//') model'
    !
    ! -- modflow6 version string
    this%source = 'MODFLOW 6 '//trim(adjustl(version))
    !
    ! -- create timestamp
    call date_and_time(values=values)
    write (this%history, '(a,i0,a,i0,a,i0,a,i0,a,i0,a,i0,a,i0)') &
      'first created ', values(1), '/', values(2), '/', values(3), ' ', &
      values(5), ':', values(6), ':', values(7), '.', values(8)

Here is the call graph for this function:

Variable Documentation

netcdf_structured

@, public ncmodelexportmodule::netcdf_structured = 2

Definition at line 33 of file NCModel.f90.

    ENUMERATOR :: NETCDF_STRUCTURED = 2 !< netcdf structrured export

netcdf_ugrid

@, public ncmodelexportmodule::netcdf_ugrid = 1

Definition at line 32 of file NCModel.f90.

    ENUMERATOR :: NETCDF_UGRID = 1 !< netcdf mesh export

netcdf_undef

@, public ncmodelexportmodule::netcdf_undef = 0

Definition at line 31 of file NCModel.f90.

    ENUMERATOR :: NETCDF_UNDEF = 0 !< undefined netcdf export type