feat(get/set data record): Updated get_data/set_data functionality and new get_record/set_record methods

autotest/regression/test_mf6.py

@@ -1745,6 +1745,164 @@ def test005_create_tests_advgw_tidal(tmpdir, example_data_path):
             found_obs = True
     assert found_flows and found_obs
 
+    # test get_record, set_record for list data
+    wel = model.get_package("wel")
+    spd_record = wel.stress_period_data.get_record()
+    well_sp_3 = spd_record[3]
+    assert well_sp_3["filename"] == "AdvGW_tidal.wel_stress_period_data_4.txt"
+    assert well_sp_3["binary"] is False
+    assert well_sp_3["data"][0][0] == (2, 4, 7)
+    assert well_sp_3["data"][0][1] == "well_1_rate"
+    # modify
+    del well_sp_3["filename"]
+    well_sp_3["data"][0][0] = (2, 4, 6)
+    well_sp_2 = spd_record[2]
+    del well_sp_2["filename"]
+    well_sp_2["data"][0][0] = (1, 1, 1)
+    # save
+    spd_record[2] = well_sp_2
+    spd_record[3] = well_sp_3
+    wel.stress_period_data.set_record(spd_record)
+    # verify changes
+    spd_record = wel.stress_period_data.get_record()
+    well_sp_3 = spd_record[3]
+    assert "filename" not in well_sp_3
+    assert well_sp_3["data"][0][0] == (2, 4, 6)
+    assert well_sp_3["data"][0][1] == "well_1_rate"
+    well_sp_2 = spd_record[2]
+    assert "filename" not in well_sp_2
+    assert well_sp_2["data"][0][0] == (1, 1, 1)
+    spd = wel.stress_period_data.get_data()
+    assert spd[3][0][0] == (2, 4, 6)
+    # change well_sp_2 back to external
+    well_sp_2["filename"] = "wel_spd_data_3.txt"
+    spd_record[2] = well_sp_2
+    wel.stress_period_data.set_record(spd_record)
+    # change well_sp_2 data
+    spd[2][0][0] = (1, 2, 2)
+    wel.stress_period_data.set_data(spd)
+    # verify changes
+    spd_record = wel.stress_period_data.get_record()
+    well_sp_2 = spd_record[2]
+    assert well_sp_2["filename"] == "wel_spd_data_3.txt"
+    assert well_sp_2["data"][0][0] == (1, 2, 2)
+
+    # test get_data/set_data vs get_record/set_record
+    dis = model.get_package("dis")
+    botm = dis.botm.get_record()
+    assert len(botm) == 3
+    layer_2 = botm[1]
+    layer_3 = botm[2]
+    # verify layer 2
+    assert layer_2["filename"] == "AdvGW_tidal.dis_botm_layer2.txt"
+    assert layer_2["binary"] is False
+    assert layer_2["factor"] == 1.0
+    assert layer_2["iprn"] is None
+    assert layer_2["data"][0][0] == -10.0
+    # change and set layer 2
+    layer_2["filename"] = "botm_layer2.txt"
+    layer_2["binary"] = True
+    layer_2["iprn"] = 3
+    layer_2["factor"] = 2.0
+    layer_2["data"] = layer_2["data"] * 0.5
+    botm[1] = layer_2
+    # change and set layer 3
+    del layer_3["filename"]
+    layer_3["factor"] = 0.5
+    layer_3["data"] = layer_3["data"] * 2.0
+    botm[2] = layer_3
+    dis.botm.set_record(botm)
+
+    # get botm in two different ways, verifying changes made
+    botm_record = dis.botm.get_record()
+    layer_1 = botm_record[0]
+    assert layer_1["filename"] == "AdvGW_tidal.dis_botm_layer1.txt"
+    assert layer_1["binary"] is False
+    assert layer_1["iprn"] is None
+    assert layer_1["data"][0][0] == 5.0
+    layer_2 = botm_record[1]
+    assert layer_2["filename"] == "botm_layer2.txt"
+    assert layer_2["binary"] is True
+    assert layer_2["factor"] == 2.0
+    assert layer_2["iprn"] == 3
+    assert layer_2["data"][0][0] == -5.0
+    layer_3 = botm_record[2]
+    assert "filename" not in layer_3
+    assert layer_3["factor"] == 0.5
+    assert layer_3["data"][0][0] == -200.0
+    botm_data = dis.botm.get_data(apply_mult=True)
+    assert botm_data[0][0][0] == 5.0
+    assert botm_data[1][0][0] == -10.0
+    assert botm_data[2][0][0] == -100.0
+    botm_data = dis.botm.get_data()
+    assert botm_data[0][0][0] == 5.0
+    assert botm_data[1][0][0] == -5.0
+    assert botm_data[2][0][0] == -200.0
+    # modify and set botm data with set_data
+    botm_data[0][0][0] = 6.0
+    botm_data[1][0][0] = -8.0
+    botm_data[2][0][0] = -205.0
+    dis.botm.set_data(botm_data)
+    # verify that data changed and metadata did not change
+    botm_record = dis.botm.get_record()
+    layer_1 = botm_record[0]
+    assert layer_1["filename"] == "AdvGW_tidal.dis_botm_layer1.txt"
+    assert layer_1["binary"] is False
+    assert layer_1["iprn"] is None
+    assert layer_1["data"][0][0] == 6.0
+    assert layer_1["data"][0][1] == 5.0
+    layer_2 = botm_record[1]
+    assert layer_2["filename"] == "botm_layer2.txt"
+    assert layer_2["binary"] is True
+    assert layer_2["factor"] == 2.0
+    assert layer_2["iprn"] == 3
+    assert layer_2["data"][0][0] == -8.0
+    assert layer_2["data"][0][1] == -5.0
+    layer_3 = botm_record[2]
+    assert "filename" not in layer_3
+    assert layer_3["factor"] == 0.5
+    assert layer_3["data"][0][0] == -205.0
+    assert layer_3["data"][0][1] == -200.0
+    botm_data = dis.botm.get_data()
+    assert botm_data[0][0][0] == 6.0
+    assert botm_data[1][0][0] == -8.0
+    assert botm_data[2][0][0] == -205.0
+
+    spd_record = rch3_package.stress_period_data.get_record()
+    assert 0 in spd_record
+    assert isinstance(spd_record[0], dict)
+    assert "filename" in spd_record[0]
+    assert (
+        spd_record[0]["filename"]
+        == "AdvGW_tidal_3.rch_stress_period_data_1.txt"
+    )
+    assert "binary" in spd_record[0]
+    assert spd_record[0]["binary"] is False
+    assert "data" in spd_record[0]
+    assert spd_record[0]["data"][0][0] == (0, 0, 9)
+    spd_record[0]["data"][0][0] = (0, 0, 8)
+    rch3_package.stress_period_data.set_record(spd_record)
+
+    spd_data = rch3_package.stress_period_data.get_data()
+    assert spd_data[0][0][0] == (0, 0, 8)
+    spd_data[0][0][0] = (0, 0, 7)
+    rch3_package.stress_period_data.set_data(spd_data)
+
+    spd_record = rch3_package.stress_period_data.get_record()
+    assert isinstance(spd_record[0], dict)
+    assert "filename" in spd_record[0]
+    assert (
+        spd_record[0]["filename"]
+        == "AdvGW_tidal_3.rch_stress_period_data_1.txt"
+    )
+    assert "binary" in spd_record[0]
+    assert spd_record[0]["binary"] is False
+    assert "data" in spd_record[0]
+    assert spd_record[0]["data"][0][0] == (0, 0, 7)
+
+    sim.write_simulation()
+    sim.run_simulation()
+
     # clean up
     sim.delete_output_files()