From 48c36dce0bacb81b1ff40b8b97f73ba2f8d9e361 Mon Sep 17 00:00:00 2001 From: Dave Grote Date: Fri, 21 Jul 2023 10:28:04 -0700 Subject: [PATCH] Add doc strings --- src/Base/AMReX.cpp | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/Base/AMReX.cpp b/src/Base/AMReX.cpp index a393ce6b..8f5b8595 100644 --- a/src/Base/AMReX.cpp +++ b/src/Base/AMReX.cpp @@ -101,8 +101,12 @@ void init_AMReX(py::module& m) }, py::return_value_policy::reference, "Initialize AMReX library"); - m.def("initialized", &Initialized); - m.def("size", &AMReX::size); + m.def("initialized", &Initialized, + "Returns true if there are any currently-active and initialized " + "AMReX instances (i.e. one for which amrex::Initialize has been called, " + "and amrex::Finalize has not). Otherwise false."); + m.def("size", &AMReX::size, + "The amr stack size, the number of amr instances pushed."); constexpr auto run_gc = []() { // explicitly run the garbage collector, so deleted objects