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

provide solver keywords in a structured manner #16

Open
arvedes opened this issue Oct 24, 2022 · 0 comments
Open

provide solver keywords in a structured manner #16

arvedes opened this issue Oct 24, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@arvedes
Copy link
Member

arvedes commented Oct 24, 2022

Background: The keywords for solvers related to crystal growth simulations (HeatSovler, PhaseChangeSolver, StatMag, MgDyn2DHarmonic) were originally implemented in pyelmer, then moved to the submodule elmerkw. Currently, using these parameters is not the recommended workflow and importing elmerkw raises a DeprecationWarning. Instead, the user is encouraged to provide the keywords in a dictionary.

I think providing keywords is great advantage of pyelmer and gives a huge benefit to the users because they can rely on autocomplete functionality of their IDE instead of looking everything up in the manuals. It'd be great to bring back this functionality to the main elmer module but in a more structured manner helping the users to find the right keywords for their solvers. I am thinking of something like:

bc_bottom = elmer.Boundary(...)
bc_bottom .heatsovler.fixed_heatflux = 10
bc_bottom .magnetodynamics.electric_current_density = 100
(...)
@arvedes arvedes added the enhancement New feature or request label Oct 24, 2022
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

No branches or pull requests

1 participant