flopy.mf6.coordinates.modeldimensions module¶
modeldimensions module. Contains the model dimension information
- class DataDimensions(package_dim, structure)[source]¶
Bases:
object
Resolves dimension information for model data using information contained in the model files
- Parameters
package_dim (PackageDimensions) – PackageDimension object for the package that the data is contained in
structure (MFDataStructure) – MFDataStructure object of data whose dimensions need to be resolved (optional)
- get_model_grid : ()
returns a model grid based on the current simulation data
- def get_data_shape(data_item : MFDataItemStructure, data_set_struct :
- MFDataStructure, data_item_numint):
returns the shape of modflow data structure. returns shape of entire data structure if no data item is specified, otherwise returns shape of individual data time. user data and the dictionary path to the data can be passed in “data” to help resolve the data shape
- model_subspace_size : (subspace_string : str)
returns the size of the model subspace specified in subspace_string
Notes
Examples
- class ModelDimensions(model_name, simulation_data)[source]¶
Bases:
object
Contains model dimension information and helper methods
- Parameters
model_name (str) – name of the model
simulation_data (MFSimulationData) – contains all simulation related data
structure (MFDataStructure) – MFDataStructure object of data whose dimensions need to be resolved (optional)
- simulation_time¶
object containing simulation time information
- Type
- get_model_grid : ()
returns a model grid based on the current simulation data
- def get_data_shape(structure : MFDataStructure, data_item :
MFDataItemStructure, data_set_struct : MFDataStructure, data : list, path : tuple, deconstruct_axis : bool):
returns the shape of modflow data structure. returns shape of entire data structure if no data item is specified, otherwise returns shape of individual data time. user data and the dictionary path to the data can be passed in “data” to help resolve the data shape. if deconstruct_axis is True any spatial axis will be automatically deconstructed into its component parts (model grid will be deconstructed into layer/row/col)
- data_reshape : ()
reshapes jagged model data
- model_subspace_size : (subspace_string : str)
returns the size of the model subspace specified in subspace_string
Notes
Examples
- class PackageDimensions(model_dim, structure, package_path)[source]¶
Bases:
object
Resolves dimension information for common parts of a package
- Parameters
model_dim (ModelDimensions) – ModelDimensions object for the model that the package is contained in
structure (MFPackageStructure) – MFPackageStructure object of package
package_path (tuple) – Tuple representing the path to this package
- get_aux_variables : (model_num=0)
returns the package’s aux variables
- boundnames : (model_num=0)
returns true of the boundnames option is in the package
- get_tasnames : (model_num=0)
returns a dictionary of all the tas names used in a tas file
- get_tsnames : (model_num=0)
returns a dictionary of all the ts names used in a ts file
Notes
Examples