arfc / moltres

Repository for Moltres, a code for simulating Molten Salt Reactors
GNU Lesser General Public License v2.1
66 stars 41 forks source link

Add diffusion theory and associated kernels to Theory page on Moltres website #270

Closed nglaser3 closed 4 months ago

nglaser3 commented 4 months ago

Summary of changes

Add brief introduction to multi-group diffusion in Moltres, add table of terms in multi group diffusion equation and their associated kernels, add table of terms in delayed neutron precursor equation and their associated kernels.

Types of changes

Required for Merging

Associated Issues and PRs

Associated Developers

Checklist for Reviewers

Reviewers should use this link to get to the Review Checklist before they begin their review.

smpark7 commented 4 months ago

Hey @nglaser3, great work here! Before I provide specific review comments, could you break up your paragraphs into multiple lines with a max limit of 100 characters per line? This will help with indicating which parts of the text my review comments are referring to.

You can leave an empty line between the paragraphs to maintain separation in the rendered html file.

nglaser3 commented 4 months ago

@smpark7, Thank you! I have broken the paragraphs into sentences, and checked to make sure the formatting was still correct. Please let me know if there are any other pre-check changes you would like me to make!

smpark7 commented 4 months ago

@katyhuff @munkm Do you have any comments to add?

katyhuff commented 4 months ago

100 characters per line is still pretty long. Usually we go with 80. @smpark7 is there a reason for 100?

smpark7 commented 4 months ago

It's because Moose has a 100-character limit for the source code so I've been applying it consistently for all files except python files