MODFLOW 6  version 6.6.0.dev0
USGS Modular Hydrologic Model
utlncfinputmodule Module Reference

Data Types

type  utlncfparamfoundtype
 

Variables

logical, public utl_ncf_multi_package = .false.
 
character(len=16), dimension(*), parameter, public utl_ncf_subpackages = [ ' ' ]
 
type(inputparamdefinitiontype), parameter utlncf_ogc_wkt = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'OGC_WKT', 'OGC_WKT', 'STRING', 'LENBIGLINE', 'CRS well-known text (WKT) string', .false., .false., .false., .false., .false. )
 
type(inputparamdefinitiontype), parameter utlncf_deflate = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'DEFLATE', 'DEFLATE', 'INTEGER', '', 'variable compression deflate level', .false., .false., .false., .false., .false. )
 
type(inputparamdefinitiontype), parameter utlncf_shuffle = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'SHUFFLE', 'SHUFFLE', 'KEYWORD', '', '', .false., .false., .false., .false., .false. )
 
type(inputparamdefinitiontype), parameter utlncf_chunk_record = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'CHUNK_RECORD', 'CHUNK_RECORD', 'RECORD CHUNKING CHUNK_TIME CHUNK_FACE CHUNK_Z CHUNK_Y CHUNK_X', '', 'netcdf export chunking record', .false., .false., .false., .false., .false. )
 
type(inputparamdefinitiontype), parameter utlncf_chunking = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'CHUNKING', 'CHUNKING', 'KEYWORD', '', 'keyword when defining ugrid chunking parameters', .true., .true., .false., .false., .false. )
 
type(inputparamdefinitiontype), parameter utlncf_chunk_time = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'CHUNK_TIME', 'CHUNK_TIME', 'INTEGER', '', 'chunking parameter for the time dimension', .true., .true., .false., .false., .false. )
 
type(inputparamdefinitiontype), parameter utlncf_chunk_face = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'CHUNK_FACE', 'CHUNK_FACE', 'INTEGER', '', 'chunking parameter for the ugrid face dimension', .false., .true., .false., .false., .false. )
 
type(inputparamdefinitiontype), parameter utlncf_chunk_z = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'CHUNK_Z', 'CHUNK_Z', 'INTEGER', '', 'chunking parameter for structured z', .false., .true., .false., .false., .false. )
 
type(inputparamdefinitiontype), parameter utlncf_chunk_y = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'CHUNK_Y', 'CHUNK_Y', 'INTEGER', '', 'chunking parameter for structured y', .false., .true., .false., .false., .false. )
 
type(inputparamdefinitiontype), parameter utlncf_chunk_x = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'CHUNK_X', 'CHUNK_X', 'INTEGER', '', 'chunking parameter for structured x', .false., .true., .false., .false., .false. )
 
type(inputparamdefinitiontype), parameter utlncf_attr_off = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'MODFLOW6_ATTR_OFF', 'ATTR_OFF', 'KEYWORD', '', '', .false., .false., .false., .false., .false. )
 
type(inputparamdefinitiontype), parameter utlncf_ncpl = InputParamDefinitionType ( 'UTL', 'NCF', 'DIMENSIONS', 'NCPL', 'NCPL', 'INTEGER', '', 'number of cells in layer', .false., .false., .false., .false., .false. )
 
type(inputparamdefinitiontype), parameter utlncf_lat = InputParamDefinitionType ( 'UTL', 'NCF', 'GRIDDATA', 'LAT', 'LAT', 'DOUBLE1D', 'NCPL', 'cell center latitude', .false., .false., .false., .false., .false. )
 
type(inputparamdefinitiontype), parameter utlncf_lon = InputParamDefinitionType ( 'UTL', 'NCF', 'GRIDDATA', 'LON', 'LON', 'DOUBLE1D', 'NCPL', 'cell center longitude', .false., .false., .false., .false., .false. )
 
type(inputparamdefinitiontype), dimension(*), parameter, public utl_ncf_param_definitions = [ utlncf_ogc_wkt, utlncf_deflate, utlncf_shuffle, utlncf_chunk_record, utlncf_chunking, utlncf_chunk_time, utlncf_chunk_face, utlncf_chunk_z, utlncf_chunk_y, utlncf_chunk_x, utlncf_attr_off, utlncf_ncpl, utlncf_lat, utlncf_lon ]
 
type(inputparamdefinitiontype), dimension(*), parameter, public utl_ncf_aggregate_definitions = [ InputParamDefinitionType ( '', '', '', '', '', '', '', '', .false., .false., .false., .false., .false. ) ]
 
type(inputblockdefinitiontype), dimension(*), parameter, public utl_ncf_block_definitions = [ InputBlockDefinitionType( 'OPTIONS', .false., .false., .false. ), InputBlockDefinitionType( 'DIMENSIONS', .false., .false., .false. ), InputBlockDefinitionType( 'GRIDDATA', .false., .false., .false. ) ]
 

Variable Documentation

◆ utl_ncf_aggregate_definitions

type(inputparamdefinitiontype), dimension(*), parameter, public utlncfinputmodule::utl_ncf_aggregate_definitions = [ InputParamDefinitionType ( '', '', '', '', '', '', '', '', .false., .false., .false., .false., .false. ) ]

Definition at line 310 of file utl-ncfidm.f90.

310  type(InputParamDefinitionType), parameter :: &
311  utl_ncf_aggregate_definitions(*) = &
312  [ &
313  inputparamdefinitiontype &
314  ( &
315  '', & ! component
316  '', & ! subcomponent
317  '', & ! block
318  '', & ! tag name
319  '', & ! fortran variable
320  '', & ! type
321  '', & ! shape
322  '', & ! longname
323  .false., & ! required
324  .false., & ! multi-record
325  .false., & ! preserve case
326  .false., & ! layered
327  .false. & ! timeseries
328  ) &
329  ]

◆ utl_ncf_block_definitions

type(inputblockdefinitiontype), dimension(*), parameter, public utlncfinputmodule::utl_ncf_block_definitions = [ InputBlockDefinitionType( 'OPTIONS', .false., .false., .false. ), InputBlockDefinitionType( 'DIMENSIONS', .false., .false., .false. ), InputBlockDefinitionType( 'GRIDDATA', .false., .false., .false. ) ]

Definition at line 331 of file utl-ncfidm.f90.

331  type(InputBlockDefinitionType), parameter :: &
332  utl_ncf_block_definitions(*) = &
333  [ &
334  inputblockdefinitiontype( &
335  'OPTIONS', & ! blockname
336  .false., & ! required
337  .false., & ! aggregate
338  .false. & ! block_variable
339  ), &
340  inputblockdefinitiontype( &
341  'DIMENSIONS', & ! blockname
342  .false., & ! required
343  .false., & ! aggregate
344  .false. & ! block_variable
345  ), &
346  inputblockdefinitiontype( &
347  'GRIDDATA', & ! blockname
348  .false., & ! required
349  .false., & ! aggregate
350  .false. & ! block_variable
351  ) &
352  ]

◆ utl_ncf_multi_package

logical, public utlncfinputmodule::utl_ncf_multi_package = .false.

Definition at line 31 of file utl-ncfidm.f90.

31  logical :: utl_ncf_multi_package = .false.

◆ utl_ncf_param_definitions

Definition at line 291 of file utl-ncfidm.f90.

291  type(InputParamDefinitionType), parameter :: &
292  utl_ncf_param_definitions(*) = &
293  [ &
294  utlncf_ogc_wkt, &
295  utlncf_deflate, &
296  utlncf_shuffle, &
297  utlncf_chunk_record, &
298  utlncf_chunking, &
299  utlncf_chunk_time, &
300  utlncf_chunk_face, &
301  utlncf_chunk_z, &
302  utlncf_chunk_y, &
303  utlncf_chunk_x, &
304  utlncf_attr_off, &
305  utlncf_ncpl, &
306  utlncf_lat, &
307  utlncf_lon &
308  ]

◆ utl_ncf_subpackages

character(len=16), dimension(*), parameter, public utlncfinputmodule::utl_ncf_subpackages = [ ' ' ]

Definition at line 33 of file utl-ncfidm.f90.

33  character(len=16), parameter :: &
34  utl_ncf_subpackages(*) = &
35  [ &
36  ' ' &
37  ]

◆ utlncf_attr_off

type(inputparamdefinitiontype), parameter utlncfinputmodule::utlncf_attr_off = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'MODFLOW6_ATTR_OFF', 'ATTR_OFF', 'KEYWORD', '', '', .false., .false., .false., .false., .false. )
private

Definition at line 219 of file utl-ncfidm.f90.

219  type(InputParamDefinitionType), parameter :: &
220  utlncf_attr_off = inputparamdefinitiontype &
221  ( &
222  'UTL', & ! component
223  'NCF', & ! subcomponent
224  'OPTIONS', & ! block
225  'MODFLOW6_ATTR_OFF', & ! tag name
226  'ATTR_OFF', & ! fortran variable
227  'KEYWORD', & ! type
228  '', & ! shape
229  '', & ! longname
230  .false., & ! required
231  .false., & ! multi-record
232  .false., & ! preserve case
233  .false., & ! layered
234  .false. & ! timeseries
235  )

◆ utlncf_chunk_face

type(inputparamdefinitiontype), parameter utlncfinputmodule::utlncf_chunk_face = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'CHUNK_FACE', 'CHUNK_FACE', 'INTEGER', '', 'chunking parameter for the ugrid face dimension', .false., .true., .false., .false., .false. )
private

Definition at line 147 of file utl-ncfidm.f90.

147  type(InputParamDefinitionType), parameter :: &
148  utlncf_chunk_face = inputparamdefinitiontype &
149  ( &
150  'UTL', & ! component
151  'NCF', & ! subcomponent
152  'OPTIONS', & ! block
153  'CHUNK_FACE', & ! tag name
154  'CHUNK_FACE', & ! fortran variable
155  'INTEGER', & ! type
156  '', & ! shape
157  'chunking parameter for the ugrid face dimension', & ! longname
158  .false., & ! required
159  .true., & ! multi-record
160  .false., & ! preserve case
161  .false., & ! layered
162  .false. & ! timeseries
163  )

◆ utlncf_chunk_record

type(inputparamdefinitiontype), parameter utlncfinputmodule::utlncf_chunk_record = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'CHUNK_RECORD', 'CHUNK_RECORD', 'RECORD CHUNKING CHUNK_TIME CHUNK_FACE CHUNK_Z CHUNK_Y CHUNK_X', '', 'netcdf export chunking record', .false., .false., .false., .false., .false. )
private

Definition at line 93 of file utl-ncfidm.f90.

93  type(InputParamDefinitionType), parameter :: &
94  utlncf_chunk_record = inputparamdefinitiontype &
95  ( &
96  'UTL', & ! component
97  'NCF', & ! subcomponent
98  'OPTIONS', & ! block
99  'CHUNK_RECORD', & ! tag name
100  'CHUNK_RECORD', & ! fortran variable
101  'RECORD CHUNKING CHUNK_TIME CHUNK_FACE CHUNK_Z CHUNK_Y CHUNK_X', & ! type
102  '', & ! shape
103  'netcdf export chunking record', & ! longname
104  .false., & ! required
105  .false., & ! multi-record
106  .false., & ! preserve case
107  .false., & ! layered
108  .false. & ! timeseries
109  )

◆ utlncf_chunk_time

type(inputparamdefinitiontype), parameter utlncfinputmodule::utlncf_chunk_time = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'CHUNK_TIME', 'CHUNK_TIME', 'INTEGER', '', 'chunking parameter for the time dimension', .true., .true., .false., .false., .false. )
private

Definition at line 129 of file utl-ncfidm.f90.

129  type(InputParamDefinitionType), parameter :: &
130  utlncf_chunk_time = inputparamdefinitiontype &
131  ( &
132  'UTL', & ! component
133  'NCF', & ! subcomponent
134  'OPTIONS', & ! block
135  'CHUNK_TIME', & ! tag name
136  'CHUNK_TIME', & ! fortran variable
137  'INTEGER', & ! type
138  '', & ! shape
139  'chunking parameter for the time dimension', & ! longname
140  .true., & ! required
141  .true., & ! multi-record
142  .false., & ! preserve case
143  .false., & ! layered
144  .false. & ! timeseries
145  )

◆ utlncf_chunk_x

type(inputparamdefinitiontype), parameter utlncfinputmodule::utlncf_chunk_x = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'CHUNK_X', 'CHUNK_X', 'INTEGER', '', 'chunking parameter for structured x', .false., .true., .false., .false., .false. )
private

Definition at line 201 of file utl-ncfidm.f90.

201  type(InputParamDefinitionType), parameter :: &
202  utlncf_chunk_x = inputparamdefinitiontype &
203  ( &
204  'UTL', & ! component
205  'NCF', & ! subcomponent
206  'OPTIONS', & ! block
207  'CHUNK_X', & ! tag name
208  'CHUNK_X', & ! fortran variable
209  'INTEGER', & ! type
210  '', & ! shape
211  'chunking parameter for structured x', & ! longname
212  .false., & ! required
213  .true., & ! multi-record
214  .false., & ! preserve case
215  .false., & ! layered
216  .false. & ! timeseries
217  )

◆ utlncf_chunk_y

type(inputparamdefinitiontype), parameter utlncfinputmodule::utlncf_chunk_y = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'CHUNK_Y', 'CHUNK_Y', 'INTEGER', '', 'chunking parameter for structured y', .false., .true., .false., .false., .false. )
private

Definition at line 183 of file utl-ncfidm.f90.

183  type(InputParamDefinitionType), parameter :: &
184  utlncf_chunk_y = inputparamdefinitiontype &
185  ( &
186  'UTL', & ! component
187  'NCF', & ! subcomponent
188  'OPTIONS', & ! block
189  'CHUNK_Y', & ! tag name
190  'CHUNK_Y', & ! fortran variable
191  'INTEGER', & ! type
192  '', & ! shape
193  'chunking parameter for structured y', & ! longname
194  .false., & ! required
195  .true., & ! multi-record
196  .false., & ! preserve case
197  .false., & ! layered
198  .false. & ! timeseries
199  )

◆ utlncf_chunk_z

type(inputparamdefinitiontype), parameter utlncfinputmodule::utlncf_chunk_z = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'CHUNK_Z', 'CHUNK_Z', 'INTEGER', '', 'chunking parameter for structured z', .false., .true., .false., .false., .false. )
private

Definition at line 165 of file utl-ncfidm.f90.

165  type(InputParamDefinitionType), parameter :: &
166  utlncf_chunk_z = inputparamdefinitiontype &
167  ( &
168  'UTL', & ! component
169  'NCF', & ! subcomponent
170  'OPTIONS', & ! block
171  'CHUNK_Z', & ! tag name
172  'CHUNK_Z', & ! fortran variable
173  'INTEGER', & ! type
174  '', & ! shape
175  'chunking parameter for structured z', & ! longname
176  .false., & ! required
177  .true., & ! multi-record
178  .false., & ! preserve case
179  .false., & ! layered
180  .false. & ! timeseries
181  )

◆ utlncf_chunking

type(inputparamdefinitiontype), parameter utlncfinputmodule::utlncf_chunking = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'CHUNKING', 'CHUNKING', 'KEYWORD', '', 'keyword when defining ugrid chunking parameters', .true., .true., .false., .false., .false. )
private

Definition at line 111 of file utl-ncfidm.f90.

111  type(InputParamDefinitionType), parameter :: &
112  utlncf_chunking = inputparamdefinitiontype &
113  ( &
114  'UTL', & ! component
115  'NCF', & ! subcomponent
116  'OPTIONS', & ! block
117  'CHUNKING', & ! tag name
118  'CHUNKING', & ! fortran variable
119  'KEYWORD', & ! type
120  '', & ! shape
121  'keyword when defining ugrid chunking parameters', & ! longname
122  .true., & ! required
123  .true., & ! multi-record
124  .false., & ! preserve case
125  .false., & ! layered
126  .false. & ! timeseries
127  )

◆ utlncf_deflate

type(inputparamdefinitiontype), parameter utlncfinputmodule::utlncf_deflate = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'DEFLATE', 'DEFLATE', 'INTEGER', '', 'variable compression deflate level', .false., .false., .false., .false., .false. )
private

Definition at line 57 of file utl-ncfidm.f90.

57  type(InputParamDefinitionType), parameter :: &
58  utlncf_deflate = inputparamdefinitiontype &
59  ( &
60  'UTL', & ! component
61  'NCF', & ! subcomponent
62  'OPTIONS', & ! block
63  'DEFLATE', & ! tag name
64  'DEFLATE', & ! fortran variable
65  'INTEGER', & ! type
66  '', & ! shape
67  'variable compression deflate level', & ! longname
68  .false., & ! required
69  .false., & ! multi-record
70  .false., & ! preserve case
71  .false., & ! layered
72  .false. & ! timeseries
73  )

◆ utlncf_lat

type(inputparamdefinitiontype), parameter utlncfinputmodule::utlncf_lat = InputParamDefinitionType ( 'UTL', 'NCF', 'GRIDDATA', 'LAT', 'LAT', 'DOUBLE1D', 'NCPL', 'cell center latitude', .false., .false., .false., .false., .false. )
private

Definition at line 255 of file utl-ncfidm.f90.

255  type(InputParamDefinitionType), parameter :: &
256  utlncf_lat = inputparamdefinitiontype &
257  ( &
258  'UTL', & ! component
259  'NCF', & ! subcomponent
260  'GRIDDATA', & ! block
261  'LAT', & ! tag name
262  'LAT', & ! fortran variable
263  'DOUBLE1D', & ! type
264  'NCPL', & ! shape
265  'cell center latitude', & ! longname
266  .false., & ! required
267  .false., & ! multi-record
268  .false., & ! preserve case
269  .false., & ! layered
270  .false. & ! timeseries
271  )

◆ utlncf_lon

type(inputparamdefinitiontype), parameter utlncfinputmodule::utlncf_lon = InputParamDefinitionType ( 'UTL', 'NCF', 'GRIDDATA', 'LON', 'LON', 'DOUBLE1D', 'NCPL', 'cell center longitude', .false., .false., .false., .false., .false. )
private

Definition at line 273 of file utl-ncfidm.f90.

273  type(InputParamDefinitionType), parameter :: &
274  utlncf_lon = inputparamdefinitiontype &
275  ( &
276  'UTL', & ! component
277  'NCF', & ! subcomponent
278  'GRIDDATA', & ! block
279  'LON', & ! tag name
280  'LON', & ! fortran variable
281  'DOUBLE1D', & ! type
282  'NCPL', & ! shape
283  'cell center longitude', & ! longname
284  .false., & ! required
285  .false., & ! multi-record
286  .false., & ! preserve case
287  .false., & ! layered
288  .false. & ! timeseries
289  )

◆ utlncf_ncpl

type(inputparamdefinitiontype), parameter utlncfinputmodule::utlncf_ncpl = InputParamDefinitionType ( 'UTL', 'NCF', 'DIMENSIONS', 'NCPL', 'NCPL', 'INTEGER', '', 'number of cells in layer', .false., .false., .false., .false., .false. )
private

Definition at line 237 of file utl-ncfidm.f90.

237  type(InputParamDefinitionType), parameter :: &
238  utlncf_ncpl = inputparamdefinitiontype &
239  ( &
240  'UTL', & ! component
241  'NCF', & ! subcomponent
242  'DIMENSIONS', & ! block
243  'NCPL', & ! tag name
244  'NCPL', & ! fortran variable
245  'INTEGER', & ! type
246  '', & ! shape
247  'number of cells in layer', & ! longname
248  .false., & ! required
249  .false., & ! multi-record
250  .false., & ! preserve case
251  .false., & ! layered
252  .false. & ! timeseries
253  )

◆ utlncf_ogc_wkt

type(inputparamdefinitiontype), parameter utlncfinputmodule::utlncf_ogc_wkt = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'OGC_WKT', 'OGC_WKT', 'STRING', 'LENBIGLINE', 'CRS well-known text (WKT) string', .false., .false., .false., .false., .false. )
private

Definition at line 39 of file utl-ncfidm.f90.

39  type(InputParamDefinitionType), parameter :: &
40  utlncf_ogc_wkt = inputparamdefinitiontype &
41  ( &
42  'UTL', & ! component
43  'NCF', & ! subcomponent
44  'OPTIONS', & ! block
45  'OGC_WKT', & ! tag name
46  'OGC_WKT', & ! fortran variable
47  'STRING', & ! type
48  'LENBIGLINE', & ! shape
49  'CRS well-known text (WKT) string', & ! longname
50  .false., & ! required
51  .false., & ! multi-record
52  .false., & ! preserve case
53  .false., & ! layered
54  .false. & ! timeseries
55  )

◆ utlncf_shuffle

type(inputparamdefinitiontype), parameter utlncfinputmodule::utlncf_shuffle = InputParamDefinitionType ( 'UTL', 'NCF', 'OPTIONS', 'SHUFFLE', 'SHUFFLE', 'KEYWORD', '', '', .false., .false., .false., .false., .false. )
private

Definition at line 75 of file utl-ncfidm.f90.

75  type(InputParamDefinitionType), parameter :: &
76  utlncf_shuffle = inputparamdefinitiontype &
77  ( &
78  'UTL', & ! component
79  'NCF', & ! subcomponent
80  'OPTIONS', & ! block
81  'SHUFFLE', & ! tag name
82  'SHUFFLE', & ! fortran variable
83  'KEYWORD', & ! type
84  '', & ! shape
85  '', & ! longname
86  .false., & ! required
87  .false., & ! multi-record
88  .false., & ! preserve case
89  .false., & ! layered
90  .false. & ! timeseries
91  )