Test Suite Reference

Sources. tests/test_ContactStructuralMechanicsApplication.py, contact_structural_mechanics_test_factory.py, SmallTests.py, NightlyTests.py, ValidationTests.py, the stand-alone test_*.py files and tests/cpp_tests/; CMakeLists.txt for the gtest registration. Counts were taken from the sources at the time of writing.

Figure: the nested Python suites, their categories, and the C++ gtest files.

Running the tests

# Python tests (from applications/ContactStructuralMechanicsApplication/tests/)
python3 test_ContactStructuralMechanicsApplication.py            # small level (default)
python3 test_ContactStructuralMechanicsApplication.py -l nightly
python3 test_ContactStructuralMechanicsApplication.py -l validation
python3 test_ContactStructuralMechanicsApplication.py -l all

# through the global Kratos runner (what the CI does)
python3 kratos/python_scripts/testing/run_python_tests.py -v 2 -l nightly -c python3

# C++ gtests (application configured with -DKRATOS_BUILD_TESTING=ON)
python3 kratos/python_scripts/testing/run_cpp_tests.py

Requirements: the compiled StructuralMechanicsApplication and ContactStructuralMechanicsApplication; about 15 tests are gated on the ConstitutiveLawsApplication (has_CL_application, detected at run time) and the adaptive-remeshing tests need the MeshingApplication. Test data is installed with the Python scripts when INSTALL_TESTING_FILES=ON. The application is part of the Linux CI application list (.github/workflows/ci_apps_linux.json).

Organisation

Suites

AssembleTestSuites() fills the standard Kratos suites, nested so that a level always contains the previous one:

Five validation tests are registered but commented out: TALMHertzSphereTestContact and TComponentsALMHertzSphereTestContact (# FIXME: requires axisymmetric to work (memory error)), TALMIroningTestContact, TALMIroningDieTestContact and TMultiLayerContactTest. TComponentsALMHyperSimplePatchTestWithEliminationContact is skipped on Windows (random failure noted in the source).

The test factory

Every simulation test is a class of SmallTests.py (32 classes), NightlyTests.py (55) or ValidationTests.py (25) deriving from ContactStructuralMechanicsTestFactory and declaring only a file_name, for example

class ALMHertzSimpleTestContact(TestFactory):
    file_name = "ALM_frictionless_contact_test_2D/hertz_simple_test"

The factory reads <file_name>_parameters.json, builds a StructuralMechanicsAnalysis in the test folder (controlledExecutionScope) and runs it (test_execution). The parameter files contain from_json_check_result_process entries that compare DISPLACEMENT (and the augmented pressure, non-historical) with the reference <file_name>_results.json / <file_name>_results_LM.json; to regenerate a reference, run the case with the _json_output_process block renamed to json_output_process.

frictionless_by_components = True in a class (the ComponentsALM* tests) makes the factory switch the case to the vector-multiplier formulation: mortar_type becomes ALMContactFrictionlessComponents, the process contact_type FrictionlessComponents, and the checked variable LAGRANGE_MULTIPLIER_CONTACT_PRESSURE is replaced by VECTOR_LAGRANGE_MULTIPLIER. Every frictionless ALM case is therefore run twice, exercising both condition families and the MixedULMLinearSolver.

Some cases (hyper_simple_patch_test) are built from two .mdpa files with the SerialModelPartCombinatorModeler (model_import_settings.input_type: use_input_model_part), which is why their .mdpa names end in 1 and 2.

Data folders

Each case has <name>.mdpa, <name>_parameters.json, <name>_materials.json and the reference <name>_results.json (plus _results_LM.json when the pressure is checked).

Categories

The mapping between the thesis benchmarks and these classes is given in Benchmarks.

C++ tests (gtest)

91 cases in KratosContactStructuralMechanicsFastSuite, registered by kratos_add_gtests in the CMakeLists.txt and run with run_cpp_tests.py.

contact_structural_mechanics_fast_suite.h/.cpp defines the suite fixture that registers the application.

Writing a new test

1. Create <case>.mdpa, <case>_materials.json and <case>_parameters.json in the data folder of the formulation, using an existing case as template (keep the json_check_process and _json_output_process blocks).
2. Generate the reference: rename _json_output_process to json_output_process, run once, rename back.
3. Add a class to SmallTests.py / NightlyTests.py / ValidationTests.py with the file_name (and frictionless_by_components = True for a components twin).
4. Register it in test_ContactStructuralMechanicsApplication.py in the right suite (smallSuite.addTest(T<Class>('test_execution'))), gated with if has_CL_application: if the materials need the ConstitutiveLawsApplication.
5. For C++ tests add a KRATOS_TEST_CASE_IN_SUITE(<Name>, KratosContactStructuralMechanicsFastSuite) in the matching cpp_tests/ file; the CMake glob picks it up.