flopy.mf6.data.mfdatastorage module

class DataStorage(sim_data, model_or_sim, data_dimensions, get_file_entry, data_storage_type=DataStorageType.internal_array, data_structure_type=DataStructureType.ndarray, layer_shape=(1,), layered=False, stress_period=0, data_path=())

Bases: object

Stores and retrieves data.

Parameters:

• sim_data (simulation data class) – reference to the simulation data class

• data_dimensions (data dimensions class) – a data dimensions class for the data being stored

• get_file_entry (method reference) – method that returns the file entry for the stored data

• data_storage_type (enum) – how the data will be stored (internally, as a constant, as an external file)

• data_structure_type (enum) – what internal type is the data stored in (ndarray, recarray, scalar)

• layer_shape (int) – number of data layers

• layered (bool) – is the data layered

• layer_storage (MultiList<LayerStorage>) – one or more dimensional list of LayerStorage

data_storage_type

list of data storage types, one for each layer

Type:

list

data_const_value

list of data constants, one for each layer

Type:

list

external_file_path

list of external file paths, one for each layer

Type:

list

multiplier

list of multipliers, one for each layer

Type:

list

print_format

list of print formats, one for each layer

Type:

list

data_structure_type

what internal type is the data stored in (ndarray, recarray, scalar)

layered

is the data layered

Type:

bool

pre_data_comments

any comments before the start of the data

Type:

string

comments

any comments mixed in with the data, dictionary keys are data lines

Type:

dict

post_data_comments

any comments after the end of the data

Type:

string

override_data_type : (index, data_type)

overrides the data type used in a recarray at index “index” with data type “data_type”

get_external_file_path(layer)

gets the path to an external file for layer “layer”

get_const_val(layer)

gets the constant value of a given layer. data storage type for layer must be “internal_constant”.

has_data(layer) : bool

returns true if data exists for the specified layer, false otherwise

get_data(layer) : ndarray/recarray/string

returns the data for the specified layer

update_item(data, key_index)

updates the data in a recarray at index “key_index” with data “data”. data is a list containing all data for a single record in the recarray. . data structure type must be recarray

append_data(data)

appends data “data” to the end of a recarray. data structure type must be recarray

set_data(data, layer=None, multiplier=[1.0]

sets the data being stored to “data” for layer “layer”, replacing all data for that layer. a multiplier can be specified.

get_active_layer_indices() : list

returns the indices of all layers expected to contain data

store_internal(data, layer=None, const=False, multiplier=[1.0])

store data “data” at layer “layer” internally

store_external(file_path, layer=None, multiplier=[1.0], print_format=None,

data=None, do_not_verify=False) store data “data” at layer “layer” externally in file “file_path”

external_to_external(new_external_file, multiplier=None, layer=None)

copies existing external data to the new file location and points to the new file

external_to_internal(layer_num=None, store_internal=False) :

ndarray/recarray

loads existing external data for layer “layer_num” and returns it. if store_internal is True it also storages the data internally, changing the storage type for “layer_num” layer to internal.

internal_to_external(new_external_file, multiplier=None, layer=None,

print_format=None)

stores existing internal data for layer “layer” to external file “new_external_file”

read_data_from_file(layer, fd=None, multiplier=None) : (ndarray, int)

reads in data from a given file “fd” as data from layer “layer”. returns data as an ndarray along with the size of the data

to_string(val, type, is_cellid=False, possible_cellid=False)

converts data “val” of type “type” to a string. is_cellid is True if the data type is known to be a cellid and is treated as such. when possible_cellid is True the data is checked to see if it matches the shape/dimensions of a cellid before using it as one.

resolve_data_size(index) : int

resolves the size of a given data element in a recarray based on the names in the existing rec_array. assumes repeating data element names follow the format <data_element_name>_X. returns the number of times the data element repeats.

flatten()

converts layered data to a non-layered data

make_layered()

converts non-layered data to layered data

Notes

Examples

add_data_line_comment(comment, line_num)

add_layer(dimension=2)

append_data(data)

build_type_list(data_set=None, data=None, resolve_data_shape=True, key=None, nseg=None, cellid_expanded=False, min_size=False, overwrite_existing_type_list=True)

external_to_external(new_external_file, multiplier=None, layer=None, binary=None)

external_to_internal(layer, store_internal=False, apply_mult=True)

flatten()

get_active_layer_indices()

get_const_val(layer=None)

get_data(layer=None, apply_mult=True, block_exists=False)

get_data_dimensions(layer)

get_data_size(layer)

get_data_str(formal)

get_default_mult()

get_external(layer=None)

get_external_file_path(layer)

get_record(layer=None)

has_data(layer=None)

init_layers(dimensions)

internal_to_external(new_external_file, multiplier=None, layer=None, print_format=None, binary=False)

make_layered()

make_tuple_cellids(data)

override_data_type(index, data_type)

point_to_existing_external_file(arr_line, layer)

process_internal_line(arr_line)

process_open_close_line(arr_line, layer, store=True)

resolve_cellidlist(data)

resolve_data_size(index)

resolve_shape_list(data_item, repeat_count, current_key, data_line, cellid_size=None)

resolve_typelist(data)

set_data(data, layer=None, multiplier=None, key=None, autofill=False, check_data=False, preserve_record=False)

set_ext_file_attributes(layer, file_path, print_format, binary)

set_tas(tas_name, tas_label, current_key, check_name=True)

store_external(file_path, layer=None, multiplier=None, print_format=None, data=None, do_not_verify=False, binary=False, preserve_record=False)

store_internal(data, layer=None, const=False, multiplier=None, key=None, autofill=False, print_format=None, check_data=False, preserve_record=False)

tuple_cellids(data)

class DataStorageType(value)

Bases: Enum

Enumeration of different ways that data can be stored

external_file = 3

internal_array = 1

internal_constant = 2

class DataStructureType(value)

Bases: Enum

Enumeration of different data structures used to store data

ndarray = 1

recarray = 2

scalar = 3

class LayerStorage(data_storage, lay_indexes, data_storage_type=DataStorageType.internal_array, data_type=None)

Bases: object

Stores a single layer of data.

Parameters:

• data_storage (DataStorage) – Parent data storage object that layer is contained in

• lay_num (int) – Layer number of layered being stored

• data_storage_type (DataStorageType) – Method used to store the data

internal_data

data being stored, if full data is being stored internally in memory

Type:

ndarray or recarray

data_const_value

constant value of data being stored, if data is a constant

Type:

int/float

data_storage_type

method used to store the data

Type:

DataStorageType

fname

file name of external file containing the data

Type:

str

factor

factor to multiply the data by

Type:

int/float

iprn

print code

Type:

int

binary

whether the data is stored in a binary file

Type:

bool

get_const_val(layer)

gets the constant value of a given layer. data storage type for layer must be “internal_constant”.

get_data(layer) : ndarray/recarray/string

returns the data for the specified layer

set_data(data, layer=None, multiplier=[1.0]

sets the data being stored to “data” for layer “layer”, replacing all data for that layer. a multiplier can be specified.

Notes

Examples

get_data()

get_data_const_val()

property name

set_data(data)

set_internal_array()

set_internal_constant()