Skip to content

DOC: The CG work fields stay in the collection - #253

Merged
pastewka merged 2 commits into
mainfrom
doc/work-fields-stay
Oct 31, 2026
Merged

pastewka merged 2 commits into
mainfrom
doc/work-fields-stay

Conversation

@pastewka

Copy link
Copy Markdown
Contributor

Why

#252 made the solvers keep their work fields in the collection between solves, but the conjugate_gradients / conjugate_gradients_pipelined docstrings and the fc row of the Python reference still said they are "removed again on return" / "created and removed again", with the old cg#<call>-<role> names.

What changes

  • Docstrings and docs/python.md say the work fields stay (named cg-work<depth>-<role>-...) and are reused by the next solve.
  • One sentence in the reference warns that FileIONetCDF.register_field_collection of such a collection without field_names writes the work fields too, since that is the one place where the persistence is visible to a user.

Docs only; no code change, so no CHANGELOG entry beyond the existing PERF one.

🤖 Generated with Claude Code

The docstrings and the Python reference still said the solver's work
fields are removed again on return, which has not been true since the
work fields were pooled. Say that they stay, how they are named, and that
register_field_collection without field_names would write them to a file.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@codecov

codecov Bot commented Oct 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

The Python IO tests write their NetCDF files into the source tree, and an
in-source CMake run had left a CMakeCache.txt; none of it belongs in the
repository.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@pastewka
pastewka merged commit 1d50746 into main Oct 31, 2026
42 checks passed
@pastewka
pastewka deleted the doc/work-fields-stay branch October 31, 2026 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant