Adding Labels to Ctests

tofstie commented 3 weeks ago

This PR adds labels to all current CTests and sets a standard for the labels to be included in CTests in the future. If you want to add any labels to a test, feel free to push to my branch.

How to add labels

To add labels use the custom ctest function, defined in ./tests/CMakeLists.txt, set_tests_labels. This function takes one input and as many arguments as needed. The one input is the test name and the arguments are the labels wanted. See below for an example use.

ADD_TEST(NAME NNLS_multi_core
COMMAND mpirun -n ${MPIMAX} $<TARGET_FILE:Tests.exe> multiCore)
set_tests_labels(NNLS_multi_core    LINEAR_SOLVER
                                    PARALLEL
                                    QUICK
                                    UNIT_TEST)

How to use labels

To use a label to run a specific set of tests use the -L flag with ctest. Multiple -L flags are counted as an AND statement. One may also use -LE to exclude certain tests from running. ctest -L UNIT_TEST -L QUICK will run all quick unit tests. These -L flags can also use regex.

ODE_SOLVER unit tests

Removed these tests at the request of Carolyn. They are outdated
Current Labels

Test labels should be added for the following categories (USE ALL CAPS) for all future tests.
Directory Name
- LINEAR_SOLVER, TGV_SCALING, ETC
Dimension
- 1D, 2D, 3D
Parallel vs Serial
- PARALLEL, SERIAL
PDE Type
- EULER, NAVIER_STOKES, etc
ODE Solver Type
- RUNGE-KUTTA, IMPLICIT, etc
DG Type
- STRONG, STRONG-SPLIT, WEAK
Quadrature Type
- COLLOCATED, UNCOLLOCATED
OTHER (if needed)
- MEMORY_INTENSIVE, MANUFACTURED_SOLUTION, EXPECTED_FAILURE, CONVERGENCE, CURVILINEAR, LIMITER, ADJOINT, GMSH, ARTIFICIAL_VISCOSITY, MESH_ADAPTATION, RELAXATION, RESTART, LES, CONVECTIVE JACOBIAN
Speed of Test
- QUICK (<~10s), MODERATE(<~180s), LONG(>~180s)
Type of Test
- UNIT_TEST, INTEGRATION_TEST