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

Updating User Interface #73

Open
5 tasks
keniley1 opened this issue Nov 23, 2020 · 2 comments
Open
5 tasks

Updating User Interface #73

keniley1 opened this issue Nov 23, 2020 · 2 comments
Assignees

Comments

@keniley1
Copy link
Collaborator

keniley1 commented Nov 23, 2020

I think we're getting to the point where we can start making this code a little more like COMSOL -- we can create Actions that users can intuitively grasp without requiring them to search for all these different input parameters that seem so random. Right now I'm thinking of adding a few different Actions, essentially mirroring COMSOL's different "interfaces" in the plasma module:

  1. ElectronTransport
    • Input: transport coefficients file(s), initial conditions
    • Adds electron transport materials, mass, charge, etc...
    • Adds electron drift-diffusion kernels
  2. HeavySpeciesTransport
    • Input: name, mass, charge, IC, transport coefficient(s)
    • Adds relevant Materials, ICs, kernels, etc.
    • Eventually add more complex formulations, like computing transport coefficients from Chapman-Enskog theory automatically, use mixture-averaged diffusion coefficients, and include temperature dependence
  3. Interfaces
    • Input: type (dielectric or water), relevant species names, Henry coefficients (for water)
    • Dielectric -- either explicitly add surface charge material and interface kernels, or assume a small dielectric layer and apply EconomouDielectricBC
    • Water - add species solvation interface kernels and boundary conditions

Obviously this is all tentative and up for discussion. This is just my initial thoughts on the kind of user interface we could include. While doing this we should also add thorough documentation of everything in Zapdos and use MooseDocs to make the website as comprehensive as possible.

  • Interfaces
  • ElectronTransport
  • HeavySpeciesTransport
  • Website documentation
  • Parameter consistency ("electrons" vs "em", "ions" vs "charged_species" vs "ip")
@cticenhour
Copy link
Member

Thanks @keniley1! I am going to edit the main comment to add one more todo list item for parameter consistency that you brought up. We should really come to a consensus about how we want those to be presented to the user. I lean toward a simple "electron" and "ion/ions" myself. For actions that might take in multiple positively charged species, then simply "ions".

@cticenhour
Copy link
Member

Regarding the website, I plan to bring up automated website generation to the Dev-ops lead on the MOOSE Team. Like MOOSE, I'd like to eventually move to automatic website refresh on every merge to master. I think I can co-op the current CIVET recipe for that in MOOSE to use here, but I'd have to check.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants