MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
disncstructuredmodule::disncstructuredtype Type Referenceabstract
Inheritance diagram for disncstructuredmodule::disncstructuredtype:
Inheritance graph
Collaboration diagram for disncstructuredmodule::disncstructuredtype:
Collaboration graph

Public Member Functions

procedure init (this, modelname, modeltype, modelfname, nc_fname, disenum, nctype, iout)
 netcdf export dis init
procedure destroy (this)
 netcdf export dis destroy
procedure df (this)
 netcdf export define
procedure df_export (this)
 define timeseries input variables
procedure step (this)
 netcdf export step
procedure export_input_array (this, pkgtype, pkgname, mempath, idt)
 netcdf export an input array
procedure export_df (this, export_pkg)
 define export package
procedure create_timeseries (this, idt, iparam, iaux, export_pkg)
 create timeseries export variable
procedure export_input_arrays (this, pkgtype, pkgname, mempath, param_dfns)
 write package gridded input data
procedure package_step (this, export_pkg)
 netcdf export package dynamic input
procedure add_pkg_data (this)
 determine packages to write gridded input
procedure add_global_att (this)
 create file (group) attributes
procedure define_dim (this)
 netcdf export define dimensions
procedure define_dependent (this)
 create the model layer dependent variables
procedure define_gridmap (this)
 create the file grid mapping container variable
procedure define_geocoords (this)
 define grid projection variables
procedure add_proj_data (this)
 add grid projection data
procedure add_grid_data (this)
 add grid coordinates
procedure export_input (this)
 netcdf dynamic package period export
procedure(model_define), deferred df (this)
procedure(package_export), deferred export_df (this, export_pkg)
procedure(model_step), deferred step (this)
procedure(package_export), deferred package_step (this, export_pkg)
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(structuredncdimidtype) dim_ids
 structured dimension ids type
type(structuredncvaridtype) var_ids
 structured variable ids type
type(distype), pointer dis => null()
 pointer to model dis package
integer(i4b) nlay
 number of layers
real(dp), dimension(:), pointer, contiguous latitude => null()
 lat input array pointer
real(dp), dimension(:), pointer, contiguous longitude => null()
 lon input array pointer
integer(i4b), pointer chunk_z
 chunking parameter for z dimension
integer(i4b), pointer chunk_y
 chunking parameter for y dimension
integer(i4b), pointer chunk_x
 chunking parameter for x dimension
integer(i4b), dimension(:), allocatable layers
 layers array
logical(lgp) latlon
 are lat and lon arrays to be written to netcdf file
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 57 of file DisNCStructured.f90.

Member Function/Subroutine Documentation

◆ add_global_att()

procedure disncstructuredmodule::disncstructuredtype::add_global_att ( class(disncstructuredtype), intent(inout) this)

Definition at line 81 of file DisNCStructured.f90.

◆ add_grid_data()

procedure disncstructuredmodule::disncstructuredtype::add_grid_data ( class(disncstructuredtype), intent(inout) this)

Definition at line 87 of file DisNCStructured.f90.

◆ add_pkg_data()

procedure disncstructuredmodule::disncstructuredtype::add_pkg_data ( class(disncstructuredtype), intent(inout) this)

Definition at line 80 of file DisNCStructured.f90.

◆ add_proj_data()

procedure disncstructuredmodule::disncstructuredtype::add_proj_data ( class(disncstructuredtype), intent(inout) this)

Definition at line 86 of file DisNCStructured.f90.

◆ create_timeseries()

procedure disncstructuredmodule::disncstructuredtype::create_timeseries ( class(disncstructuredtype), intent(inout) this,
type(inputparamdefinitiontype), intent(in), pointer idt,
integer(i4b), intent(in) iparam,
integer(i4b), intent(in) iaux,
class(exportpackagetype), intent(in), pointer export_pkg )

Definition at line 77 of file DisNCStructured.f90.

◆ define_dependent()

procedure disncstructuredmodule::disncstructuredtype::define_dependent ( class(disncstructuredtype), intent(inout) this)

Definition at line 83 of file DisNCStructured.f90.

◆ define_dim()

procedure disncstructuredmodule::disncstructuredtype::define_dim ( class(disncstructuredtype), intent(inout) this)

Definition at line 82 of file DisNCStructured.f90.

◆ define_geocoords()

procedure disncstructuredmodule::disncstructuredtype::define_geocoords ( class(disncstructuredtype), intent(inout) this)

Definition at line 85 of file DisNCStructured.f90.

◆ define_gridmap()

procedure disncstructuredmodule::disncstructuredtype::define_gridmap ( class(disncstructuredtype), intent(inout) this)

Definition at line 84 of file DisNCStructured.f90.

◆ destroy() [1/2]

procedure disncstructuredmodule::disncstructuredtype::destroy ( class(disncstructuredtype), intent(inout) this)

Definition at line 71 of file DisNCStructured.f90.

◆ destroy() [2/2]

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

Definition at line 115 of file NCModel.f90.

◆ df() [1/2]

procedure disncstructuredmodule::disncstructuredtype::df ( class(disncstructuredtype), intent(inout) this)

Definition at line 72 of file DisNCStructured.f90.

◆ df() [2/2]

procedure(model_define), deferred ncmodelexportmodule::ncbasemodelexporttype::df ( class(ncbasemodelexporttype), intent(inout) this)
pure virtualinherited

Definition at line 123 of file NCModel.f90.

◆ df_export()

procedure disncstructuredmodule::disncstructuredtype::df_export ( class(disncstructuredtype), intent(inout) this)

Definition at line 73 of file DisNCStructured.f90.

◆ export_df() [1/2]

procedure disncstructuredmodule::disncstructuredtype::export_df ( class(disncstructuredtype), intent(inout) this,
class(exportpackagetype), intent(in), pointer export_pkg )

Definition at line 76 of file DisNCStructured.f90.

◆ export_df() [2/2]

procedure(package_export), deferred ncmodelexportmodule::ncbasemodelexporttype::export_df ( class(ncbasemodelexporttype), intent(inout) this,
class(exportpackagetype), intent(in), pointer export_pkg )
pure virtualinherited

Definition at line 124 of file NCModel.f90.

◆ export_input()

procedure ncmodelexportmodule::ncbasemodelexporttype::export_input ( class(ncbasemodelexporttype), intent(inout) this)
inherited

Definition at line 122 of file NCModel.f90.

◆ export_input_array()

procedure disncstructuredmodule::disncstructuredtype::export_input_array ( class(disncstructuredtype), intent(inout) this,
character(len=*), intent(in) pkgtype,
character(len=*), intent(in) pkgname,
character(len=*), intent(in) mempath,
type(inputparamdefinitiontype), intent(in), pointer idt )

Definition at line 75 of file DisNCStructured.f90.

◆ export_input_arrays()

procedure disncstructuredmodule::disncstructuredtype::export_input_arrays ( class(disncstructuredtype), intent(inout) this,
character(len=*), intent(in) pkgtype,
character(len=*), intent(in) pkgname,
character(len=*), intent(in) mempath,
type(inputparamdefinitiontype), dimension(:), intent(in), pointer param_dfns )

Definition at line 78 of file DisNCStructured.f90.

◆ get()

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

Definition at line 112 of file NCModel.f90.

◆ init() [1/2]

procedure disncstructuredmodule::disncstructuredtype::init ( class(disncstructuredtype), 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 70 of file DisNCStructured.f90.

◆ init() [2/2]

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 )
inherited

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 )
inherited

Definition at line 113 of file NCModel.f90.

◆ istp()

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

Definition at line 114 of file NCModel.f90.

◆ package_step() [1/2]

procedure disncstructuredmodule::disncstructuredtype::package_step ( class(disncstructuredtype), intent(inout) this,
class(exportpackagetype), intent(in), pointer export_pkg )

Definition at line 79 of file DisNCStructured.f90.

◆ package_step() [2/2]

procedure(package_export), deferred ncmodelexportmodule::ncbasemodelexporttype::package_step ( class(ncbasemodelexporttype), intent(inout) this,
class(exportpackagetype), intent(in), pointer export_pkg )
pure virtualinherited

Definition at line 126 of file NCModel.f90.

◆ step() [1/2]

procedure disncstructuredmodule::disncstructuredtype::step ( class(disncstructuredtype), intent(inout) this)

Definition at line 74 of file DisNCStructured.f90.

◆ step() [2/2]

procedure(model_step), deferred ncmodelexportmodule::ncbasemodelexporttype::step ( class(ncbasemodelexporttype), intent(inout) this)
pure virtualinherited

Definition at line 125 of file NCModel.f90.

Member Data Documentation

◆ annotation

type(ncexportannotation) ncmodelexportmodule::ncmodelexporttype::annotation
inherited

Definition at line 99 of file NCModel.f90.

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

◆ chunk_time

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

Definition at line 107 of file NCModel.f90.

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

◆ chunk_x

integer(i4b), pointer disncstructuredmodule::disncstructuredtype::chunk_x

Definition at line 66 of file DisNCStructured.f90.

66 integer(I4B), pointer :: chunk_x !< chunking parameter for x dimension

◆ chunk_y

integer(i4b), pointer disncstructuredmodule::disncstructuredtype::chunk_y

Definition at line 65 of file DisNCStructured.f90.

65 integer(I4B), pointer :: chunk_y !< chunking parameter for y dimension

◆ chunk_z

integer(i4b), pointer disncstructuredmodule::disncstructuredtype::chunk_z

Definition at line 64 of file DisNCStructured.f90.

64 integer(I4B), pointer :: chunk_z !< chunking parameter for z dimension

◆ chunking_active

logical(lgp) ncmodelexportmodule::ncmodelexporttype::chunking_active
inherited

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
inherited

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
inherited

Definition at line 96 of file NCModel.f90.

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

◆ deflate

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

Definition at line 104 of file NCModel.f90.

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

◆ dim_ids

type(structuredncdimidtype) disncstructuredmodule::disncstructuredtype::dim_ids

Definition at line 58 of file DisNCStructured.f90.

58 type(StructuredNCDimIdType) :: dim_ids !< structured dimension ids type

◆ dis

type(distype), pointer disncstructuredmodule::disncstructuredtype::dis => null()

Definition at line 60 of file DisNCStructured.f90.

◆ dis_mempath

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

Definition at line 92 of file NCModel.f90.

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

◆ disenum

integer(i4b) ncmodelexportmodule::ncmodelexporttype::disenum
inherited

Definition at line 101 of file NCModel.f90.

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

◆ gridmap_name

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

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
inherited

Definition at line 106 of file NCModel.f90.

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

◆ iout

integer(i4b) ncmodelexportmodule::ncmodelexporttype::iout
inherited

Definition at line 108 of file NCModel.f90.

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

◆ latitude

real(dp), dimension(:), pointer, contiguous disncstructuredmodule::disncstructuredtype::latitude => null()

Definition at line 62 of file DisNCStructured.f90.

◆ latlon

logical(lgp) disncstructuredmodule::disncstructuredtype::latlon

Definition at line 68 of file DisNCStructured.f90.

68 logical(LGP) :: latlon !< are lat and lon arrays to be written to netcdf file

◆ layers

integer(i4b), dimension(:), allocatable disncstructuredmodule::disncstructuredtype::layers

Definition at line 67 of file DisNCStructured.f90.

67 integer(I4B), dimension(:), allocatable :: layers !< layers array

◆ lenunits

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

Definition at line 98 of file NCModel.f90.

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

◆ longitude

real(dp), dimension(:), pointer, contiguous disncstructuredmodule::disncstructuredtype::longitude => null()

Definition at line 63 of file DisNCStructured.f90.

◆ mesh_name

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

Definition at line 91 of file NCModel.f90.

◆ modelfname

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

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
inherited

Definition at line 86 of file NCModel.f90.

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

◆ modeltype

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

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
inherited

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
inherited

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
inherited

Definition at line 102 of file NCModel.f90.

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

◆ nlay

integer(i4b) disncstructuredmodule::disncstructuredtype::nlay

Definition at line 61 of file DisNCStructured.f90.

61 integer(I4B) :: nlay !< number of layers

◆ pkglist

type(listtype) ncmodelexportmodule::ncmodelexporttype::pkglist
inherited

Definition at line 85 of file NCModel.f90.

85 type(ListType) :: pkglist

◆ shuffle

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

Definition at line 105 of file NCModel.f90.

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

◆ totnstp

integer(i4b) ncmodelexportmodule::ncmodelexporttype::totnstp
inherited

Definition at line 103 of file NCModel.f90.

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

◆ var_ids

type(structuredncvaridtype) disncstructuredmodule::disncstructuredtype::var_ids

Definition at line 59 of file DisNCStructured.f90.

59 type(StructuredNCVarIdType) :: var_ids !< structured variable ids type

◆ wkt

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

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
inherited

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
inherited

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: