Skip to content

Add additional attributes to cylindrical cache file#225

Merged
The9Cat merged 3 commits into
develfrom
moreCacheAttributes
Jul 7, 2026
Merged

Add additional attributes to cylindrical cache file#225
The9Cat merged 3 commits into
develfrom
moreCacheAttributes

Conversation

@The9Cat

@The9Cat The9Cat commented Jul 7, 2026

Copy link
Copy Markdown
Member

What and why

Add all parameters that uniquely identify the state on construction for future reproduction and provenance.

Added parameters include:

  • PCAVAR: enable variance computation
  • PCAVTK: emit VTK files for diagnostic. Not used in production.
  • PCAEOF: enable variance with weights for EOF mode. Not currently used for production.
  • numr: the grid size of the spherical model used for disk basis construction
  • hexp: exponent for Hall smoothing
  • hfac: sets the finite difference scale when using logarithmic spacing. This has been tuned somewhat so I don't recommending changing this but you can...
  • ppow: exponent for the power-law disk target model 'Power'
  • logarithmic: use logarithmic spacing for the spherical model grid used to construct the basis
  • enforce_limits: if true, prevent extrapolating off the basis grid
    file.createAttribute ("enforce_limits", HighFive::DataSpace::From(enforce_limits)).write(enforce_limits);
  • eof_numr: number of radial quadrature points for projecting the basis functions against the disk target
  • eof_nump: number of azimuthal quadrature points for the projection
  • eof_numt: number of colatitude quadrature points

Notes

These changes are non invasive and can not break older versions of EXP.

Tests

  • Compiles
  • Cache created and examined
  • Cache successfully reread by Basis
  • Check to make sure all necessary parameters are stored as attributes

@The9Cat The9Cat added the enhancement New feature or request label Jul 7, 2026
@The9Cat The9Cat requested a review from Copilot July 7, 2026 14:24

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR expands the HDF5 cylindrical cache metadata written by EmpCylSL to include additional construction/provenance parameters (PCA/EOF toggles, spherical-grid and smoothing parameters, and EOF quadrature sizes), and bumps the project/documentation version to 7.11.1.

Changes:

  • Persist additional EmpCylSL configuration/state as HDF5 attributes in WriteH5Cache().
  • Track and record EOF quadrature parameters (eof_numr/eof_nump/eof_numt) for provenance.
  • Bump EXP version strings in CMake and Doxygen config files.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
include/EmpCylSL.H Adds storage for EOF quadrature provenance parameters.
exputil/EmpCylSL.cc Saves EOF quadrature sizes and writes new provenance attributes into the HDF5 cache.
doc/exp.cfg.breathe Bumps generated documentation version to 7.11.1.
doc/exp.cfg Bumps generated documentation version to 7.11.1.
CMakeLists.txt Bumps project version to 7.11.1.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread include/EmpCylSL.H Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@CarrieFilion

Copy link
Copy Markdown
Contributor

Everything seems to work as intended!

@The9Cat The9Cat merged commit 73af2c3 into devel Jul 7, 2026
8 checks passed
@The9Cat The9Cat deleted the moreCacheAttributes branch July 7, 2026 20:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants