MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
ncmodelexportmodule::ncmodelexporttype Type Reference

base class for an export model More...

Inheritance diagram for ncmodelexportmodule::ncmodelexporttype:
Inheritance graph
Collaboration diagram for ncmodelexportmodule::ncmodelexporttype:
Collaboration graph

Public Member Functions

procedure init (this, modelname, modeltype, modelfname, nc_fname, disenum, nctype, iout)
 initialization of model netcdf export
procedure get (this, idx)
 retrieve dynamic export object from package list
procedure input_attribute (this, pkgname, idt)
 build modflow_input attribute string
procedure istp (this)
 step index for timeseries data
procedure destroy (this)
 destroy model netcdf export object

Public Attributes

type(listtype) pkglist
character(len=lenmodelname) modelname
 name of model
character(len=lencomponentname) modeltype
 type of model
character(len=linelength) modelfname
 name of model input file
character(len=linelength) nc_fname
 name of netcdf export file
character(len=linelength) gridmap_name
 name of grid mapping variable
character(len=linelength) mesh_name = 'mesh'
 name of mesh container variable
character(len=lenmempath) dis_mempath
 discretization input mempath
character(len=lenmempath) ncf_mempath
 netcdf utility package input mempath
character(len=lenbigline) wkt
 WKT1 (OGC 01-009) user string.
character(len=lenbigline) crs_wkt
 WKT2 (ISO 19162:2019) user string; falls back to wkt if empty.
character(len=linelength) datetime
 export file creation time
character(len=linelength) xname
 dependent variable name
character(len=linelength) lenunits
 unidata udunits length units
type(ncexportannotation) annotation
 export file annotation
real(dp), dimension(:), pointer, contiguous x
 dependent variable pointer
integer(i4b) disenum
 type of discretization
integer(i4b) ncid
 netcdf file descriptor
integer(i4b) totnstp
 simulation total number of steps
integer(i4b), pointer deflate
 variable deflate level
integer(i4b), pointer shuffle
 variable shuffle filter
integer(i4b), pointer input_attr
 assign variable input attr
integer(i4b), pointer chunk_time
 chunking parameter for time dimension
integer(i4b) iout
 lst file descriptor
logical(lgp) chunking_active
 have chunking parameters been provided

Detailed Description

Definition at line 84 of file NCModel.f90.

Member Function/Subroutine Documentation

◆ destroy()

procedure ncmodelexportmodule::ncmodelexporttype::destroy ( class(ncmodelexporttype), intent(inout) this)

Definition at line 115 of file NCModel.f90.

◆ get()

procedure ncmodelexportmodule::ncmodelexporttype::get ( class(ncmodelexporttype), intent(inout) this,
integer(i4b), intent(in) idx )

Definition at line 112 of file NCModel.f90.

◆ init()

procedure ncmodelexportmodule::ncmodelexporttype::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 111 of file NCModel.f90.

◆ input_attribute()

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

Definition at line 113 of file NCModel.f90.

◆ istp()

procedure ncmodelexportmodule::ncmodelexporttype::istp ( class(ncmodelexporttype), intent(inout) this)

Definition at line 114 of file NCModel.f90.

Member Data Documentation

◆ annotation

type(ncexportannotation) ncmodelexportmodule::ncmodelexporttype::annotation

Definition at line 99 of file NCModel.f90.

99 type(NCExportAnnotation) :: annotation !< export file annotation

◆ chunk_time

integer(i4b), pointer ncmodelexportmodule::ncmodelexporttype::chunk_time

Definition at line 107 of file NCModel.f90.

107 integer(I4B), pointer :: chunk_time !< chunking parameter for time dimension

◆ chunking_active

logical(lgp) ncmodelexportmodule::ncmodelexporttype::chunking_active

Definition at line 109 of file NCModel.f90.

109 logical(LGP) :: chunking_active !< have chunking parameters been provided

◆ crs_wkt

character(len=lenbigline) ncmodelexportmodule::ncmodelexporttype::crs_wkt

Definition at line 95 of file NCModel.f90.

95 character(len=LENBIGLINE) :: crs_wkt !< WKT2 (ISO 19162:2019) user string; falls back to wkt if empty

◆ datetime

character(len=linelength) ncmodelexportmodule::ncmodelexporttype::datetime

Definition at line 96 of file NCModel.f90.

96 character(len=LINELENGTH) :: datetime !< export file creation time

◆ deflate

integer(i4b), pointer ncmodelexportmodule::ncmodelexporttype::deflate

Definition at line 104 of file NCModel.f90.

104 integer(I4B), pointer :: deflate !< variable deflate level

◆ dis_mempath

character(len=lenmempath) ncmodelexportmodule::ncmodelexporttype::dis_mempath

Definition at line 92 of file NCModel.f90.

92 character(len=LENMEMPATH) :: dis_mempath !< discretization input mempath

◆ disenum

integer(i4b) ncmodelexportmodule::ncmodelexporttype::disenum

Definition at line 101 of file NCModel.f90.

101 integer(I4B) :: disenum !< type of discretization

◆ gridmap_name

character(len=linelength) ncmodelexportmodule::ncmodelexporttype::gridmap_name

Definition at line 90 of file NCModel.f90.

90 character(len=LINELENGTH) :: gridmap_name !< name of grid mapping variable

◆ input_attr

integer(i4b), pointer ncmodelexportmodule::ncmodelexporttype::input_attr

Definition at line 106 of file NCModel.f90.

106 integer(I4B), pointer :: input_attr !< assign variable input attr

◆ iout

integer(i4b) ncmodelexportmodule::ncmodelexporttype::iout

Definition at line 108 of file NCModel.f90.

108 integer(I4B) :: iout !< lst file descriptor

◆ lenunits

character(len=linelength) ncmodelexportmodule::ncmodelexporttype::lenunits

Definition at line 98 of file NCModel.f90.

98 character(len=LINELENGTH) :: lenunits !< unidata udunits length units

◆ mesh_name

character(len=linelength) ncmodelexportmodule::ncmodelexporttype::mesh_name = 'mesh'

Definition at line 91 of file NCModel.f90.

◆ modelfname

character(len=linelength) ncmodelexportmodule::ncmodelexporttype::modelfname

Definition at line 88 of file NCModel.f90.

88 character(len=LINELENGTH) :: modelfname !< name of model input file

◆ modelname

character(len=lenmodelname) ncmodelexportmodule::ncmodelexporttype::modelname

Definition at line 86 of file NCModel.f90.

86 character(len=LENMODELNAME) :: modelname !< name of model

◆ modeltype

character(len=lencomponentname) ncmodelexportmodule::ncmodelexporttype::modeltype

Definition at line 87 of file NCModel.f90.

87 character(len=LENCOMPONENTNAME) :: modeltype !< type of model

◆ nc_fname

character(len=linelength) ncmodelexportmodule::ncmodelexporttype::nc_fname

Definition at line 89 of file NCModel.f90.

89 character(len=LINELENGTH) :: nc_fname !< name of netcdf export file

◆ ncf_mempath

character(len=lenmempath) ncmodelexportmodule::ncmodelexporttype::ncf_mempath

Definition at line 93 of file NCModel.f90.

93 character(len=LENMEMPATH) :: ncf_mempath !< netcdf utility package input mempath

◆ ncid

integer(i4b) ncmodelexportmodule::ncmodelexporttype::ncid

Definition at line 102 of file NCModel.f90.

102 integer(I4B) :: ncid !< netcdf file descriptor

◆ pkglist

type(listtype) ncmodelexportmodule::ncmodelexporttype::pkglist

Definition at line 85 of file NCModel.f90.

85 type(ListType) :: pkglist

◆ shuffle

integer(i4b), pointer ncmodelexportmodule::ncmodelexporttype::shuffle

Definition at line 105 of file NCModel.f90.

105 integer(I4B), pointer :: shuffle !< variable shuffle filter

◆ totnstp

integer(i4b) ncmodelexportmodule::ncmodelexporttype::totnstp

Definition at line 103 of file NCModel.f90.

103 integer(I4B) :: totnstp !< simulation total number of steps

◆ wkt

character(len=lenbigline) ncmodelexportmodule::ncmodelexporttype::wkt

Definition at line 94 of file NCModel.f90.

94 character(len=LENBIGLINE) :: wkt !< WKT1 (OGC 01-009) user string

◆ x

real(dp), dimension(:), pointer, contiguous ncmodelexportmodule::ncmodelexporttype::x

Definition at line 100 of file NCModel.f90.

100 real(DP), dimension(:), pointer, contiguous :: x !< dependent variable pointer

◆ xname

character(len=linelength) ncmodelexportmodule::ncmodelexporttype::xname

Definition at line 97 of file NCModel.f90.

97 character(len=LINELENGTH) :: xname !< dependent variable name

The documentation for this type was generated from the following file:
  • /home/runner/work/modflow6/modflow6/src/Utilities/Export/NCModel.f90