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, naux, 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, disenum)
	set netcdf file scoped attributes More...
subroutine	export_init (this, modelname, modeltype, modelfname, nc_fname, 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 modflow_input attribute string More...
integer(i4b) function	istp (this)
	step index for timeseries data More...
character(len=linelength) function, public	export_varname (pkgname, tagname, mempath, layer, iaux)
	build netcdf variable name More...
character(len=linelength) function, public	export_longname (longname, pkgname, tagname, mempath, layer, iaux, component_type, subcomponent_type)
	build netcdf variable longname More...
subroutine	export_input (this)
	netcdf dynamic package period export More...
character(len=linelength) function, public	wkt_to_cf_gridmapping (wkt)
	map a WKT string to a CF-1.11 grid_mapping_name More...
subroutine	export_destroy (this)
	destroy model netcdf export object More...

Variables
@, public	netcdf_undef = 0
	undefined netcdf export type More...
@, public	netcdf_structured = 1
	netcdf structrured export More...
@, public	netcdf_mesh2d = 2
	netcdf ugrid layered mesh 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 32 of file NCModel.f90.

Function/Subroutine Documentation

epkg_destroy()

subroutine ncmodelexportmodule::epkg_destroy

(

class(exportpackagetype), intent(inout)

this

)

Definition at line 195 of file NCModel.f90.

    use inputdefinitionmodule, only: inputparamdefinitiontype
    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, integer(i4b), intent(in)  naux, character(len=linelength), dimension(:), intent(in), allocatable  param_names, integer(i4b), intent(in)  nparam  )

private

Parameters

[in]

mshape

model shape

Definition at line 147 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
    class(ExportPackageType), intent(inout) :: this
    type(ModflowInputType), intent(in) :: mf6_input
    integer(I4B), dimension(:), pointer, contiguous, intent(in) :: mshape !< model shape
    integer(I4B), intent(in) :: naux
    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%naux = naux
    this%eper = 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))
    allocate (this%varids_param(nparam, mshape(1)))
    allocate (this%varids_aux(naux, mshape(1)))
 
    ! 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 648 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 400 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,
		character(len=*), intent(in)	nc_fname,
		integer(i4b), intent(in)	disenum,
		integer(i4b), intent(in)	nctype,
		integer(i4b), intent(in)	iout
	)

Definition at line 278 of file NCModel.f90.

    use tdismodule, only: datetime0, nper, nstp
    use memorymanagermodule, only: mem_setptr
    use memoryhelpermodule, only: create_mem_path
    use memorymanagerextmodule, only: mem_set_value
    use inputoutputmodule, only: lowcase
    use sourcecommonmodule, only: filein_fname
    use utlncfinputmodule, only: utlncfparamfoundtype
    class(NCModelExportType), intent(inout) :: this
    character(len=*), intent(in) :: modelname
    character(len=*), intent(in) :: modeltype
    character(len=*), intent(in) :: modelfname
    character(len=*), intent(in) :: nc_fname
    integer(I4B), intent(in) :: disenum
    integer(I4B), intent(in) :: nctype
    integer(I4B), intent(in) :: iout
    character(len=LENMEMPATH) :: model_mempath
    type(UtlNcfParamFoundType) :: ncf_found
 
    ! 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 = nc_fname
    this%gridmap_name = ''
    this%ncf_mempath = ''
    this%wkt = ''
    this%crs_wkt = ''
    this%datetime = ''
    this%xname = ''
    this%lenunits = ''
    this%disenum = disenum
    this%ncid = 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.
 
    ! set file scoped attributes
    call this%annotation%set(modelname, modeltype, modelfname, nctype, disenum)
 
    ! 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
    if (filein_fname(this%ncf_mempath, 'NCF6_MEMPATH', this%dis_mempath, &
                     modelfname)) then
      call mem_set_value(this%wkt, 'WKT', this%ncf_mempath, &
                         ncf_found%wkt)
      call mem_set_value(this%crs_wkt, 'CRS_WKT', this%ncf_mempath, &
                         ncf_found%crs_wkt)
      call mem_set_value(this%deflate, 'DEFLATE', this%ncf_mempath, &
                         ncf_found%deflate)
      call mem_set_value(this%shuffle, 'SHUFFLE', this%ncf_mempath, &
                         ncf_found%shuffle)
      call mem_set_value(this%input_attr, 'ATTR_OFF', this%ncf_mempath, &
                         ncf_found%attr_off)
      call mem_set_value(this%chunk_time, 'CHUNK_TIME', this%ncf_mempath, &
                         ncf_found%chunk_time)
    end if
 
    if (ncf_found%wkt .or. ncf_found%crs_wkt) then
      this%gridmap_name = 'projection'
    end if
 
    ! ATTR_OFF turns off modflow 6 input attributes
    if (ncf_found%attr_off) then
      this%input_attr = 0
    end if
 
    ! set datetime string
    if (datetime0 /= '') then
      this%datetime = 'days since '//trim(datetime0)
    else
      ! January 1, 1970 at 00:00:00 UTC
      this%datetime = 'days since 1970-01-01T00:00:00'
    end if
 
    ! set total nstp
    if (isim_mode == mvalidate) then
      this%totnstp = nper
    else
      this%totnstp = sum(nstp)
    end if

Here is the call graph for this function:

export_input()

subroutine ncmodelexportmodule::export_input

(

class(ncbasemodelexporttype), intent(inout)

this

)

Definition at line 545 of file NCModel.f90.

    use tdismodule, only: kper
    class(NCBaseModelExportType), intent(inout) :: this
    integer(I4B) :: idx
    class(ExportPackageType), pointer :: export_pkg
    do idx = 1, this%pkglist%Count()
      export_pkg => this%get(idx)
      ! period input already exported
      if (export_pkg%eper >= kper) cycle
      ! update export package
      call this%package_step(export_pkg)
      ! update exported iper
      export_pkg%eper = kper
    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,
		character(len=*), intent(in)	mempath,
		integer(i4b), intent(in), optional	layer,
		integer(i4b), intent(in), optional	iaux,
		character(len=*), intent(in), optional	component_type,
		character(len=*), intent(in), optional	subcomponent_type
	)

Definition at line 491 of file NCModel.f90.

    use memorymanagermodule, only: mem_setptr
    use characterstringmodule, only: characterstringtype
    use inputoutputmodule, only: lowcase
    use idmdfnselectormodule, only: idm_multi_package
    character(len=*), intent(in) :: longname
    character(len=*), intent(in) :: pkgname
    character(len=*), intent(in) :: tagname
    character(len=*), intent(in) :: mempath
    integer(I4B), optional, intent(in) :: layer
    integer(I4B), optional, intent(in) :: iaux
    character(len=*), optional, intent(in) :: component_type
    character(len=*), optional, intent(in) :: subcomponent_type
    character(len=LINELENGTH) :: lname
    type(CharacterStringType), dimension(:), pointer, &
      contiguous :: auxnames
    character(len=LINELENGTH) :: pname, vname, auxname
    pname = pkgname
    vname = tagname
    call lowcase(pname)
    call lowcase(vname)
    if (longname == '') then
      lname = trim(pname)//' '//trim(vname)
    else
      lname = longname
      if (present(component_type) .and. present(subcomponent_type)) then
        if (idm_multi_package(component_type, subcomponent_type)) then
          lname = trim(pname)//' '//trim(lname)
        end if
      end if
    end if
 
    if (present(iaux)) then
      if (iaux > 0) then
        if (tagname == 'AUX') then
          ! reset vname to auxiliary variable name
          call mem_setptr(auxnames, 'AUXILIARY', mempath)
          auxname = auxnames(iaux)
          call lowcase(auxname)
          lname = trim(lname)//' '//trim(auxname)
        end if
      end if
    end if
 
    if (present(layer)) then
      if (layer > 0) then
        write (lname, '(a,i0)') trim(lname)//' layer ', layer
      end if
    end if

Here is the call graph for this function:

Here is the caller graph for this function:

export_varname()

character(len=linelength) function, public ncmodelexportmodule::export_varname	(	character(len=*), intent(in)	pkgname,
		character(len=*), intent(in)	tagname,
		character(len=*), intent(in)	mempath,
		integer(i4b), intent(in), optional	layer,
		integer(i4b), intent(in), optional	iaux
	)

Definition at line 450 of file NCModel.f90.

    use memorymanagermodule, only: mem_setptr
    use characterstringmodule, only: characterstringtype
    use inputoutputmodule, only: lowcase
    character(len=*), intent(in) :: pkgname
    character(len=*), intent(in) :: tagname
    character(len=*), intent(in) :: mempath
    integer(I4B), optional, intent(in) :: layer
    integer(I4B), optional, intent(in) :: iaux
    character(len=LINELENGTH) :: varname
    type(CharacterStringType), dimension(:), pointer, &
      contiguous :: auxnames
    character(len=LINELENGTH) :: pname, vname
    vname = tagname
    pname = pkgname
 
    if (present(iaux)) then
      if (iaux > 0) then
        if (tagname == 'AUX') then
          ! reset vname to auxiliary variable name
          call mem_setptr(auxnames, 'AUXILIARY', mempath)
          vname = auxnames(iaux)
        end if
      end if
    end if
 
    call lowcase(vname)
    call lowcase(pname)
    varname = trim(pname)//'_'//trim(vname)
 
    if (present(layer)) then
      if (layer > 0) then
        !write (varname, '(a,i0)') trim(varname)//'_L', layer
        write (varname, '(a,i0)') trim(varname)//'_l', layer
      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 418 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%tagname)
      call lowcase(attr)
    end if

Here is the call graph for this function:

istp()

integer(i4b) function ncmodelexportmodule::istp

(

class(ncmodelexporttype), intent(inout)

this

)

Definition at line 436 of file NCModel.f90.

    use tdismodule, only: kstp, kper, nstp
    class(NCModelExportType), intent(inout) :: this
    integer(I4B) :: n, istp
    istp = kstp
    if (kper > 1) then
      do n = 1, kper - 1
        istp = istp + nstp(n)
      end do
    end if

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,
		integer(i4b), intent(in)	disenum
	)

Definition at line 203 of file NCModel.f90.

    use versionmodule, only: fullversion
    use inputoutputmodule, only: lowcase
    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
    integer(I4B), intent(in) :: disenum
    integer :: values(8)
 
    this%title = ''
    this%model = ''
    this%mesh = ''
    this%grid = ''
    this%history = ''
    this%source = ''
    this%conventions = ''
    this%stdname = ''
    this%longname = ''
 
    ! set file conventions
    this%conventions = 'CF-1.11'
    if (nctype == netcdf_mesh2d) this%conventions = &
      trim(this%conventions)//' UGRID-1.0'
 
    ! set model specific attributes
    select case (modeltype)
    case ('GWF')
      this%title = trim(modelname)//' hydraulic head'
      this%longname = 'head'
    case ('GWT')
      this%title = trim(modelname)//' concentration'
      this%longname = 'concentration'
    case ('GWE')
      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
 
    if (isim_mode == mvalidate) then
      this%title = trim(this%title)//' array input'
    end if
 
    ! set mesh type
    if (nctype == netcdf_mesh2d) then
      this%mesh = 'layered'
    end if
 
    ! set grid type
    if (disenum == dis) then
      this%grid = 'structured'
    else if (disenum == disv) then
      this%grid = 'vertex'
    end if
 
    ! model description string (lowercase, no version suffix, matching CF convention)
    this%model = trim(modeltype)//': '//trim(modelname)
    call lowcase(this%model)
 
    ! modflow6 version string
    this%source = 'MODFLOW 6 '//trim(adjustl(fullversion))
 
    ! 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:

wkt_to_cf_gridmapping()

character(len=linelength) function, public ncmodelexportmodule::wkt_to_cf_gridmapping

(

character(len=*), intent(in)

wkt

)

Accepts either WKT1 (OGC 01-009, PROJECTION["name"]) or WKT2 (ISO 19162:2019, METHOD["name"]) format. WKT1 is tried first; if PROJECTION[ is absent the WKT2 METHOD[ path is attempted. Returns '' for geographic CRS or unrecognised projection names. Only common groundwater projections included. Matching is case-insensitive.

Definition at line 570 of file NCModel.f90.

    use inputoutputmodule, only: upcase
    character(len=*), intent(in) :: wkt
    character(len=LINELENGTH) :: gmname
    character(len=LINELENGTH) :: proj_name
    character(len=LENBIGLINE) :: wkt_upper
    integer :: istart, iend
 
    gmname = ''
    proj_name = ''
 
    ! uppercase copy for case-insensitive keyword search
    wkt_upper = wkt
    call upcase(wkt_upper)
 
    ! --- WKT1 path: PROJECTION["name"] ---
    istart = index(wkt_upper, 'PROJECTION[')
    if (istart /= 0) then
      istart = istart + len('PROJECTION[')
      do while (istart <= len(wkt))
        if (wkt(istart:istart) == '"') exit
        istart = istart + 1
      end do
      if (istart > len(wkt)) return
      istart = istart + 1
      iend = index(wkt(istart:), '"')
      if (iend == 0) return
      iend = istart + iend - 2
      if (iend < istart) return
      proj_name = wkt(istart:iend)
      call upcase(proj_name)
      select case (trim(proj_name))
      case ('TRANSVERSE_MERCATOR')
        gmname = 'transverse_mercator'
      case ('LAMBERT_CONFORMAL_CONIC_2SP', 'LAMBERT_CONFORMAL_CONIC_1SP')
        gmname = 'lambert_conformal_conic'
      case ('ALBERS_CONIC_EQUAL_AREA')
        gmname = 'albers_conical_equal_area'
      case ('MERCATOR_1SP', 'MERCATOR_2SP')
        gmname = 'mercator'
      case ('POLAR_STEREOGRAPHIC')
        gmname = 'polar_stereographic'
      end select
      return
    end if
 
    ! --- WKT2 path: METHOD["name"] ---
    istart = index(wkt_upper, 'METHOD[')
    if (istart == 0) return
    istart = istart + len('METHOD[')
    do while (istart <= len(wkt))
      if (wkt(istart:istart) == '"') exit
      istart = istart + 1
    end do
    if (istart > len(wkt)) return
    istart = istart + 1
    iend = index(wkt(istart:), '"')
    if (iend == 0) return
    iend = istart + iend - 2
    if (iend < istart) return
    proj_name = wkt(istart:iend)
    call upcase(proj_name)
    select case (trim(proj_name))
    case ('TRANSVERSE MERCATOR')
      gmname = 'transverse_mercator'
    case ('LAMBERT CONIC CONFORMAL (2SP)', 'LAMBERT CONIC CONFORMAL (1SP)')
      gmname = 'lambert_conformal_conic'
    case ('ALBERS EQUAL AREA')
      gmname = 'albers_conical_equal_area'
    case ('MERCATOR (VARIANT A)', 'MERCATOR (VARIANT B)')
      gmname = 'mercator'
    case ('POLAR STEREOGRAPHIC (VARIANT A)', 'POLAR STEREOGRAPHIC (VARIANT B)')
      gmname = 'polar_stereographic'
    end select

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

netcdf_mesh2d

@, public ncmodelexportmodule::netcdf_mesh2d = 2

Definition at line 35 of file NCModel.f90.

    ENUMERATOR :: NETCDF_MESH2D = 2 !< netcdf ugrid layered mesh export

netcdf_structured

@, public ncmodelexportmodule::netcdf_structured = 1

Definition at line 34 of file NCModel.f90.

    ENUMERATOR :: NETCDF_STRUCTURED = 1 !< netcdf structrured export

netcdf_undef

@, public ncmodelexportmodule::netcdf_undef = 0

Definition at line 33 of file NCModel.f90.

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