CVode.poolshrink(1) deletes unused mechanism pools.

[nrnhines]

To delete unused mechanism memory pools (e.g. when you have cleared the model) use

cv = h.CVode()
cv.poolshrink(1) # deletes pools if number of items used is 0
cv.poolshrink() # prints current number of items used and number of items allocated for double arrays and Datum arrays.

Needs documentation.

[azure-pipelines]

✔️ d2256f2 -> Azure artifacts URL

[alexsavulescu]

Just thinking out loud, would it be possible to automatically call poolshrink and avoid leaving this in the user's hands?

[azure-pipelines]

✔️ c8d7eb6 -> Azure artifacts URL

[iomaganaris]

I did some tests and this seems to work as expected.
I am just thinking that this should be added to the documentation and maybe we could also add a test about this?

[nrnhines]

possible to automatically call poolshrink

I suppose that if a model is empty (no pool item in use for any pool) that all the memory could be reclaimed. But poolshrink
started out as a temporary measure to solve a specific issue and I think will be superseded by the std::vector reorganization.

[alexsavulescu]

will be superseded by the std::vector reorganization

I believe that will still imply calls to clear() and/or shrink_to_fit()

[alexsavulescu]

@iomaganaris maybe we can merge this and tackle docs/handling in another PR?

[iomaganaris]

Sure we can merge this without the docs at the moment. I just have one question looking at the code.

[codecov-commenter]

Codecov Report

Merging #2033 (5fbf643) into master (1346a84) will decrease coverage by 0.01%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##           master    #2033      +/-   ##
==========================================
- Coverage   48.64%   48.63%   -0.02%     
==========================================
  Files         519      519              
  Lines      116039   116068      +29     
==========================================
+ Hits        56447    56449       +2     
- Misses      59592    59619      +27     

Impacted Files	Coverage Δ
src/nrncvode/cvodeobj.cpp	85.66% <0.00%> (-0.69%)	⬇️
src/nrniv/cxprop.cpp	57.45% <0.00%> (-3.65%)	⬇️
src/sundials/cvodes/cvodes.c	32.74% <0.00%> (+0.07%)	⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[azure-pipelines]

✔️ 5fbf643 -> Azure artifacts URL