Moltres is a MOOSE-application code designed for simulation of molten salt reactors.

Use

Moltres documentation can be found [here] (http://arfc.github.io/software/moltres). Doxygen pages are here. Outlines of the kernels and boundary conditions used to construct the Moltres governing equations can be found on the Moltres wiki. Breakdown of a full-fledged Moltres input file can be found here. New Moltres users who have never used MOOSE before are encouraged to check-out the MOOSE workshop slides and video to help understand the underlying Moltres components.

Install

Moltres relies on the MOOSE framework. We suggest that users install the MOOSE environment using Conda Packages by following the instructions in the Install MOOSE Conda Packages section of https://mooseframework.inl.gov/getting_started/installation/conda.html. The Moltres repository contains MOOSE and Squirrel as Git submodules, therefore there is no need to clone MOOSE into a separate directory. Instead, users can install Moltres by running the following commands in a shell after changing into the directory which will hold the Moltres directory (perhaps ~/projects):

git clone https://github.com/arfc/moltres
cd moltres
git submodule init
git submodule update
make -j8

You may also compile a debug version of Moltres by replacing the last line with METHOD=dbg make -j8. Note that you should replace 8 with the number of processors available on your machine.

Testing

To ensure that Moltres is functioning properly, run ./run_tests -j8 from the root of the Moltres directory.

Development

If you ever want to contribute changes to the Moltres repository, make sure you run scripts/install-format-hook.sh before making any commits. This will ensure that any commits you make adhere to the MOOSE/Moltres C++ style. Pull requests should be submitted to the devel branch of the arfc/moltres repository. Each pull request is automatically tested for style and for whether it breaks any of the core Moltres physics capabilities.

A full list of contributing guidelines can be found here.

Contact

Please post to our discussion list at moltres-users@googlegroups.com.