Push Requirements

In this page we list a minimal set of tests that each commit has to qualify in order to be merged. First, the code has to compile. In order to compile the code, run the following command in RICH_ROOT

make

Next, the tests have to pass. In order to run the tests, navigate to RICH_ROOT/tests and run

make

This only checks the serial tests. There are a few tests that have been parallelized, and they can be used to test the parallelization

PROCESS_NUM=2; TEST_PATH=newtonian/two_dimensional/gresho_vortex_2o; MODE=parallel; make MODE=$MODE $MODE/$TEST_PATH/test_passed.res

PROCESS_NUM=2; TEST_PATH=newtonian/two_dimensional/sedov_taylor_messy_grid; MODE=parallel; make MODE=$MODE $MODE/$TEST_PATH/test_passed.res

PROCESS_NUM=2; TEST_PATH=newtonian/two_dimensional/oblique_shock; MODE=parallel; make MODE=$MODE $MODE/$TEST_PATH/test_passed.res

PROCESS_NUM=2; TEST_PATH=newtonian/two_dimensional/noh2dNonConserve; MODE=parallel; make MODE=$MODE $MODE/$TEST_PATH/test_passed.res

PROCESS_NUM=2; TEST_PATH=newtonian/two_dimensional/acoustic; MODE=parallel; make MODE=$MODE $MODE/$TEST_PATH/test_passed.res

Next, we let clang lint review the code. To do that, return to RICH_ROOT and run

scons compiler=clang++

This may give warnings about padding, but they are not crucial, and can be safely ignored. After that comes the cppcheck lint

cppcheck ./source --enable=style --std=c++03

Finally, all the code has to be documented

doxygen Doxyfile