Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove GridSet class from Public API #1698

Open
VeckoTheGecko opened this issue Sep 10, 2024 · 1 comment
Open

Remove GridSet class from Public API #1698

VeckoTheGecko opened this issue Sep 10, 2024 · 1 comment
Labels

Comments

@VeckoTheGecko
Copy link
Contributor

I don't think the GridSet object really needs to be called by users at all, as they are not manually defining gridsets. All the grid information is available to the users via the Field.grid attributes, and FieldSet.gridset attributes.

I also think that the GridSet itself can be majorly simplified (ie, add_grid() removed/majorly refactored, grids being an actual set, turning it into a dataclass) to the point that we could maybe even outright replace it with some utility functions/processors that pull grid information from the Fields. That's out of topic for this issue, just a hint to where I can see this going.

@erikvansebille any insight onto the history of the gridset class?

@erikvansebille
Copy link
Member

Yes, good point. The GridSet is perhaps a bit over-engineered. The idea was to mimic the ParticleSet architecture/structure, but the GridSet is, as you say, much simpler; essentially just a list (set?) of Grids.

So yes, there could certainly be some cleaning here!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Backlog
Development

No branches or pull requests

2 participants