Using MALAMUTE
Running an Input File and Viewing Results
After MALAMUTE is installed and tested, you should now be able to run input files using the malamute-opt executable located at ~/projects/malamute. Input files demonstrating the capabilities of MALAMUTE can be found in ~/projects/malamute/examples and ~/projects/malamute/tests. Any input file (say, one called example_input.i) can be run with the following basic syntax:
~/projects/malamute/malamute-opt -i example_input.i
Information about the simulation and its progress will then be displayed on the screen. If a log file of the iterative solution process is also desired, the console output can be sent to a text file:
~/projects/malamute/malamute-opt -i example_input.i --color off 2>&1 | tee log.txt
The --color off option is to de-clutter the log file from extraneous mark-up resulting from the displayed console text colors.
Many test input files also create an output file with the name format example_input_out.e that contains all the simulation results that have been selected for output. These results are best viewed using a visualization tool like Paraview.
MALAMUTE Examples and Tests
In general the examples directory is meant to be a showcase of "production" MALAMUTE capability. Users are encouraged to start there when learning MALAMUTE and setting up new simulations. The test/tests directory, on the other hand, holds all MALAMUTE regression, verification, and validation tests for both complete and in-progress capability. These files should not be modified, so that periodic tests of MALAMUTE function can be performed successfully.
As MALAMUTE is developed (by you hopefully!) and more capabilities are added, the tests directory will continue to grow. If you feel that you have added important new functionality, please create a test for it, such that any future changes will not break that capability.