Add default values for AeroState::dist_sample arguments: sample_prop, create_time, allow_doubling & allow_halving (#205)

Co-authored-by: Sylwester Arabas <[email protected]>

Author: jcurtis2

src/pypartmc.cpp

@@ -168,7 +168,9 @@ PYBIND11_MODULE(_PyPartMC, m) {
         .def("rand_particle", AeroState::get_random_particle,
             "returns a random particle from the population")
         .def("dist_sample", AeroState::dist_sample,
-            "sample particles for AeroState from an AeroDist")
+            "sample particles for AeroState from an AeroDist",
+            py::arg("AeroDist"), py::arg("sample_prop") = 1.0, py::arg("create_time") = 0.0,
+            py::arg("allow_doubling") = true, py::arg("allow_halving") = true)
     ;
 
     py::class_<GasData, std::shared_ptr<GasData>>(m, "GasData",

tests/test_aero_state.py

@@ -232,12 +232,23 @@ def test_get_particle_out_of_range(
         assert False
 
     @staticmethod
-    def test_dist_sample():
+    @pytest.mark.parametrize(
+        "args",
+        (
+            (1.0, 0.0, True, True),
+            pytest.param((), id="default args"),
+        ),
+    )
+    def test_dist_sample(args):
+        # arrange
         n_part = 44
         aero_data = ppmc.AeroData(AERO_DATA_CTOR_ARG_MINIMAL)
         aero_dist = ppmc.AeroDist(aero_data, AERO_DIST_CTOR_ARG_MINIMAL)
         sut = ppmc.AeroState(n_part, aero_data)
-        n_added = sut.dist_sample(aero_dist, 1.0, 0.0, True, True)
 
+        # act
+        n_added = sut.dist_sample(aero_dist, *args)
+
+        # assert
         assert n_added > n_part * 0.5
         assert n_added < n_part * 2