search

LLNL / echemfem

Finite Element Method for Electrochemical Transport (EchemFEM)
MIT License
20 stars 5 forks source link

Improve examples #11

Closed TomTranter closed 4 months ago

TomTranter commented 5 months ago

You need to improve the examples. Ideally there would be a getting started example (or more) where the process of creating a new simple model, running it and viewing the results is explained. I would like to see an index for each example with a short description of what it does - and more commenting in the examples themselves. It would be nice to see these as jupyter notebooks that could form part of your docs In general docs are very light

tlroy commented 5 months ago

We will work on improving the examples. I will try to focus the general discussion on how to improve them here. Here is the current plan:

Issue #13 also mentioned the structuring of examples and suggested the use of input files. I will also consider this.

tlroy commented 4 months ago

Added an index of examples in the documentation

tlroy commented 4 months ago

@TomTranter @sudarshanv01 @alizma . I added a detailed demo here. I chose a problem that includes many of the available features (advection, diffusion, migration, bulk reactions, charge-transfer reactions), but is simple enough while being relevant to our CO2 electrolyzer interest. Please let me know what you think.

TomTranter commented 4 months ago

Thanks @tlroy. Demo is good. Nice to have some proper explanations and visuals instead of just scripts. I realize this project is new and quite small and you have your own specific research topics but the name of the package suggests it's quite general to electrochemistry but the scripts are very focused on a specific sub topic. Can you comment on the other applications or make another example for fuel cells or batteries

tlroy commented 4 months ago

Thank @TomTranter. I agree that the focus on CO2 electrolysis examples distracts for the generality claim. I made this flow battery example specifically for this reason. A fuel cell is definitely possible to do with the existing code. For batteries, it would have to be simpler than DFN since echemfem does not have a particle-scale model or concentrated solution theory (I am working on a separate, battery-focused code for this). I will see if we can find the time to add another non-CO2 example.

TomTranter commented 4 months ago

If this is on your roadmap that's good enough for me