idaholab / TMAP8

Tritium Migration Analysis Program, Version 8
https://mooseframework.inl.gov/TMAP8/
GNU Lesser General Public License v2.1
15 stars 18 forks source link

Add a fuel cycle model example and associated documentation. #82

Closed ke7kto closed 7 months ago

ke7kto commented 7 months ago

81 closes #81

Reason

Implemented a fuel-cycle model that would be a useful reference case to start from for other users

Design

Added an input file (as a test) and associated documentation. Tweaked other files to include links to the examples

Impact

Something we could do before is now clearly shown.

cticenhour commented 7 months ago

@ke7kto Forgive if you've heard this before, but you can batch commit any review suggestions you want to accept by going to the "Files changed" tab and see the "Add suggestion to batch" button beside each suggestion.

moosebuild commented 7 months ago

Job Documentation on 7db0d9d wanted to post the following:

View the site here

This comment will be updated on new commits.

ke7kto commented 7 months ago

There's a broader issue here too. This isn't really a validation case, but the documentation lumps examples and validation cases together. It might be a good idea to flush out the examples so that we have a true "examples" section, which I've mostly just made a stub for, but it might also be better to just work this into the Validation cases section of the docs. Seems like a design choice, though (not my prerogative).

ke7kto commented 7 months ago

@ke7kto Forgive if you've heard this before, but you can batch commit any review suggestions you want to accept by going to the "Files changed" tab and see the "Add suggestion to batch" button beside each suggestion.

Super helpful. I'm very new to commit reviews. Thanks!

loganharbour commented 7 months ago

@ke7kto I went ahead and added you as a collaborator so you'll get automated testing.

cticenhour commented 7 months ago

There's a broader issue here too. This isn't really a validation case, but the documentation lumps examples and validation cases together. It might be a good idea to flush out the examples so that we have a true "examples" section, which I've mostly just made a stub for, but it might also be better to just work this into the Validation cases section of the docs. Seems like a design choice, though (not my prerogative).

@ke7kto I think it's fine to have separate sections for explicit V&V for base capabilities and distinct examples for how far the current code can go beyond that. Let's start with this organization and we can tweak it as it grows. Thanks for adding the stub page.

I went ahead and added you as a collaborator so you'll get automated testing.

Thanks @loganharbour!

ke7kto commented 7 months ago
* A question about why you set the `\epsilon` values to 0 in all the equations, which from my understanding is different from the original article

Good catch. I saw the line at the end of the appendix, and somehow misread it to apply to all of the epsilon values. I adjusted the equations and tweaked my assumptions -- now we have a near-perfect match to Abdou's figure 3, at the cost of some realism.

cticenhour commented 7 months ago

The build/CI farm is down due to some power supply changes in the datacenter. Should be back up on Monday.

simopier commented 7 months ago

The build/CI farm is down due to some power supply changes in the datacenter. Should be back up on Monday.

It's alive!! 🧟‍♂️

simopier commented 7 months ago

@cticenhour, it's on you now, I'm on board with this in its current state.