def test_increasing_compactability() -> None:
"""Test large compaction coefficient leads to more compaction."""
dz_0 = np.full(100, 1.0)
phi_0 = np.full(100, 0.5)
phi_1 = compact(dz_0, phi_0, porosity_max=0.5, c=1e-6)
phi_2 = compact(dz_0, phi_0, porosity_max=0.5, c=1e-3)
assert np.all(phi_2[1:] < phi_1[1:])
def test_void_is_air() -> None:
"""Test empty void space."""
dz_0 = np.full(100, 1.0)
phi_0 = np.full(100, 0.5)
phi_1 = compact(dz_0, phi_0, porosity_max=0.5, rho_void=0.0)
phi_2 = compact(dz_0, phi_0, porosity_max=0.5, rho_void=1000.0)
assert np.all(phi_1[1:] < phi_2[1:])
def test_bad_return_dz() -> None:
dz = np.full((10, 100), 1.0)
phi = np.full((10, 100), 0.5)
dz_new = np.empty((10, 100), dtype=int)
with raises(TypeError):
compact(dz, phi, porosity_max=0.5, return_dz=dz_new)
dz_new = np.empty((1, 100), dtype=dz.dtype)
with raises(TypeError):
compact(dz, phi, porosity_max=0.5, return_dz=dz_new)
def test_increasing_load() -> None:
"""Test adding sediment increases compaction."""
dz_0 = np.full(100, 1.0)
phi_0 = np.full(100, 0.5)
phi_1 = compact(dz_0, phi_0, porosity_max=0.5)
dz_1 = dz_0 * (1 - phi_0) / (1 - phi_1)
dz_1[0] *= 2.0
phi_2 = compact(dz_1, phi_1, porosity_max=0.5)
assert np.all(phi_2[1:] < phi_1[1:])
def test_no_decompaction() -> None:
"""Test removing sediment does not cause decompaction."""
dz_0 = np.full(100, 1.0)
phi_0 = np.full(100, 0.5)
phi_1 = compact(dz_0, phi_0, porosity_max=0.5)
dz_1 = dz_0 * (1 - phi_0) / (1 - phi_1)
dz_1[0] /= 2.0
phi_2 = compact(dz_1, phi_1, porosity_max=0.5)
assert np.all(phi_2 == approx(phi_1))
def test_equilibrium_compaction() -> None:
"""Test steady-state compaction."""
dz_0 = np.full(100, 1.0)
phi_0 = np.full(100, 0.5)
phi_1 = compact(dz_0, phi_0, porosity_max=0.5)
dz_1 = dz_0 * (1 - phi_0) / (1 - phi_1)
phi_2 = compact(dz_1, phi_1, porosity_max=0.5)
assert np.all(phi_2 == approx(phi_1))
def test_zero_compaction() -> None:
"""Test compaction coefficient of zero."""
dz_0 = np.full(100, 1.0)
phi_0 = np.full(100, 0.5)
phi_1 = compact(dz_0, phi_0, porosity_max=0.5, c=0.0)
assert np.all(phi_1 == approx(phi_0))
def test_to_analytical() -> None:
c = 3.68e-8
rho_s = 2650.0
rho_w = 1000.0
phi_0 = 0.6
g = 9.81
dz = np.full(2000, 10.0)
phi = np.full(len(dz), phi_0)
phi_numerical = compact(
dz,
phi,
porosity_min=0.0,
porosity_max=phi_0,
c=c,
gravity=g,
rho_grain=rho_s,
rho_void=rho_w,
)
z = np.cumsum(dz * (1 - phi) / (1 - phi_numerical))
phi_analytical = np.exp(-c * g * (rho_s - rho_w) * z) / (
np.exp(-c * g * (rho_s - rho_w) * z) + (1.0 - phi_0) / phi_0
)
sup_norm = np.max(np.abs(phi_numerical - phi_analytical) / phi_analytical)
assert sup_norm < 0.01
def test_decreasing_porosity() -> None:
"""Test porosity decreases with depth."""
dz = np.full(100, 1.0)
phi = np.full(100, 0.5)
phi_new = compact(dz, phi, porosity_max=0.5)
assert phi_new[0] == approx(phi[0])
assert np.all(phi_new[1:] < phi[1:])
assert np.all(np.diff(phi_new) < 0.0)
def test_spatially_distributed() -> None:
"""Test with spatially distributed inputs."""
dz = np.full((100, 10), 1.0)
phi = np.full((100, 10), 0.5)
phi_new = compact(dz, phi, porosity_max=0.5)
assert phi_new[0] == approx(phi[0])
assert np.all(phi_new[1:] < phi[1:])
assert np.all(np.diff(phi_new, axis=0) < 0.0)
def test_all_void() -> None:
dz_0 = np.full(100, 1000.0)
phi_0 = np.full(100, 1.0)
dz_1 = np.empty_like(dz_0)
phi_1 = compact(dz_0, phi_0, return_dz=dz_1)
assert np.all(dz_1 == approx(0.0))
assert np.all(phi_1 == approx(1.0))
def test_grid_size(benchmark, size) -> None:
dz = np.full((size, 100), 1.0)
phi = np.full((size, 100), 0.5)
phi_new = compact(dz, phi, porosity_max=0.5)
phi_new = benchmark(compact, dz, phi, porosity_max=0.5)
assert phi_new[0] == approx(phi[0])
assert np.all(phi_new[1:] < phi[1:])
assert np.all(np.diff(phi_new, axis=0) < 0.0)
def test_matches_module(grid):
dz = np.full((100, 3), 1.0)
phi = np.full((100, 3), 0.5)
phi_expected = compaction.compact(dz, phi, porosity_max=0.5)
for layer in range(100):
grid.event_layers.add(1.0, porosity=0.5)
compact = Compact(grid, porosity_min=0.0, porosity_max=0.5)
compact.calculate()
assert_array_almost_equal(grid.event_layers["porosity"][-1::-1, :],
phi_expected)
def test_grid_size_with_dz(benchmark, size) -> None:
dz = np.full((size, 100), 1.0)
phi = np.full((size, 100), 0.5)
phi_new = compact(dz, phi, porosity_max=0.5)
dz_new = np.empty_like(dz)
phi_new = benchmark(compact, dz, phi, porosity_max=0.5, return_dz=dz_new)
assert phi_new[0] == approx(phi[0])
assert np.all(phi_new[1:] < phi[1:])
assert np.all(np.diff(phi_new, axis=0) < 0.0)
assert dz_new[0] == approx(dz[0])
assert np.all(dz_new[1:] < dz[1:])
assert np.all(np.diff(dz_new, axis=0) < 0.0)
def test_run(tmpdir) -> None:
dz_0 = np.full(100, 1.0)
phi_0 = np.full(100, 0.5)
phi_1 = compact(dz_0, phi_0, porosity_max=0.5)
with tmpdir.as_cwd():
df = pandas.DataFrame.from_dict({"dz": dz_0, "porosity": phi_0})
df.to_csv("porosity.csv", index=False, header=False)
run_compaction("porosity.csv", "porosity-out.csv", porosity_max=0.5)
data = pandas.read_csv(
"porosity-out.csv", names=("dz", "porosity"), dtype=float, comment="#"
)
assert np.all(data.porosity.values == approx(phi_1))
def test_constant_porosity(tmpdir, datadir):
data = pandas.read_csv(
datadir / "porosity.csv", names=("dz", "porosity"), dtype=float
)
phi_expected = compact(data["dz"], data["porosity"], porosity_max=0.6)
with tmpdir.as_cwd():
shutil.copy(datadir / "compaction.toml", ".")
shutil.copy(datadir / "porosity.csv", ".")
runner = CliRunner(mix_stderr=False)
result = runner.invoke(cli.run)
assert result.exit_code == 0
assert "Output written to porosity-out.csv" in result.stderr
phi_actual = pandas.read_csv(
"porosity-out.csv", names=("dz", "porosity"), dtype=float, comment="#"
)
assert_array_almost_equal(phi_actual["porosity"], phi_expected)
