Add device tests for ex14 and ex14p

[pazner]

Resolves #4308

PR	Author	Editor	Reviewers	Assignment	Approval	Merge
#4311	@pazner	@tzanio	@v-dobrev + @tzanio	5/16/24	5/19/24	5/26/24

PR Checklist

• Code builds.
• Code passes make style.
• Update CHANGELOG:
  • Is this a new feature users need to be aware of? New or updated example or miniapp?
  • Does it make sense to create a new section in the CHANGELOG to group with other related features?
• Update INSTALL:
  • Had a new optional library been added? If so, what range of versions of this library are required? (Make sure the external library is compatible with our BSD license, e.g. it is not licensed under GPL!)
  • Have the version ranges for any required or optional libraries changed?
  • Does make or cmake have a new target?
  • Did the requirements or the installation process change? (rare)
• Update continuous integration server configurations if necessary (e.g. with new version requirements for each of MFEM's dependencies)
  • .github
  • .appveyor.yml
• Update .gitignore:
  • Check if make distclean; git status shows any files that were generated from the source by the project (not an IDE) but we don't want to track in the repository.
  • Add new patterns (just for the new files above) and re-run the above test.
• New examples:
  • All sample runs at the top of the example source file work.
  • Update examples/makefile:
    • Add the example code to the appropriate SEQ_EXAMPLES and PAR_EXAMPLES variables.
    • Add any files generated by it to the clean target.
    • Add the example binary and any files generated by it to the top-level .gitignore file.
  • Update examples/CMakeLists.txt:
    • Add the example code to the ALL_EXE_SRCS variable.
    • Make sure THIS_TEST_OPTIONS is set correctly for the new example.
  • List the new example in doc/CodeDocumentation.dox.
  • If new examples directory (e.g.examples/pumi), list it in doc/CodeDocumentation.conf.in
  • Companion pull request for documentation in mfem/web repo:
    • Update or add example-specific documentation, see e.g. the src/examples.md.
    • Add the description, labels and screenshots in src/examples.md and src/img.
    • In examples.md, list the example under the appropriate categories, add new categories if necessary.
    • Add a short description of the example in the "Extensive Examples" section of features.md.
• New miniapps:
  • All sample runs at the top of the miniapp source file work.
  • Update top-level makefile and makefile in corresponding miniapp directory.
  • Add the miniapp binary and any files generated by it to the top-level .gitignore file.
  • Update CMake build system:
    • Update the CMakeLists.txt file in the miniapps directory, if the new miniapp is in a new directory.
    • Add/update the CMakeLists.txt file in the new miniapp directory.
    • Consider adding a new test for the new miniapp.
  • List the new miniapp in doc/CodeDocumentation.dox
  • If new miniapps directory (e.g.miniapps/nurbs), add it to MINIAPP_SUBDIRS in the makefile.
  • If new miniapps directory (e.g.miniapps/nurbs), list it in doc/CodeDocumentation.conf.in
  • Companion pull request for documentation in mfem/web repo:
    • Update or add miniapp-specific documentation, see e.g. the src/meshing.md and src/electromagnetics.md files.
    • Add the description, labels and screenshots in src/examples.md and src/img.
    • The miniapps go at the end of the page, and are usually listed only under a specific "Application (PDE)" category.
    • Add a short description of the miniapp in the "Extensive Examples" section of features.md.
• New capability:
  • All new public, protected, and private classes, methods, data members, and functions have full Doxygen-style documentation in source comments. Documentation should include descriptions of member data, function arguments and return values, template parameters, and prerequisites for calling new functions.
  • Pointer arguments and return values must specify whether ownership is being transferred or lent with the call.
  • Any new functions should include descriptions of their intended use e.g. for internal use only, user-facing, etc., along with references to example code whenever possible/appropriate.
  • Consider adding new sample runs in existing examples to highlight the new capability.
  • Consider saving cool simulation pictures with the new capability in the Confluence gallery (LLNL only) or submitting them, via pull request, to the gallery section of the mfem/web repo.
  • If this is a major new feature, consider mentioning it in the short summary inside README (rare).
  • List major new classes in doc/CodeDocumentation.dox (rare).
• Update this checklist, if the new pull request affects it.
• Run make unittest to make sure all unit tests pass.
• Run the tests in tests/scripts.
• (LLNL only) After merging:
  • Update internal tests to include the new features.

[v-dobrev]

I think in this form the tests that will be run are:

./ex14 -no-vis -d cuda
mpirun -np 4 ./ex14p -no-vis -d cuda

Instead of this, we probably want something more in line with the device sample runs in the source files -- e.g. enable PA and make sure we are not running big problems with long runtimes.

[pazner]

Is there an example of something similar, e.g. for ex1?

[v-dobrev]

Is there an example of something similar, e.g. for ex1?

In the makefile, the sample runs for the specific device examples, ex14 and ex14p, can be specialized by defining the targets ex14-test-seq-{cuda,hip} and ex14p-test-par-{cuda,hip} to add more options to the default rules for all device examples:

mfem/examples/makefile

Lines 119 to 126 in 7c296d0

	%-test-par-cuda: %
	@$(call mfem-test,$<, $(RUN_MPI), Parallel CUDA example,-d cuda)
	%-test-seq-cuda: %
	@$(call mfem-test,$<,, Serial CUDA example,-d cuda)
	%-test-par-hip: %
	@$(call mfem-test,$<, $(RUN_MPI), Parallel HIP example,-d hip)
	%-test-seq-hip: %
	@$(call mfem-test,$<,, Serial HIP example,-d hip)

So far, we've only had specializations for non-device tests, e.g. here:

mfem/examples/makefile

Lines 137 to 140 in 7c296d0

	ex10-test-seq: ex10
	@$(call mfem-test,$<,, Serial example,-tf 5)
	ex10p-test-par: ex10p
	@$(call mfem-test,$<, $(RUN_MPI), Parallel example,-tf 5)

[v-dobrev]

For CMake, for non-device tests we define specialized sets of arguments like this:

mfem/examples/CMakeLists.txt

Lines 124 to 132 in 7c296d0

	if (${TEST_NAME} MATCHES "ex10p*")
	list(APPEND THIS_TEST_OPTIONS "-tf" "5")
	elseif(${TEST_NAME} MATCHES "ex15p*")
	list(APPEND THIS_TEST_OPTIONS "-e" "1")
	elseif(${TEST_NAME} MATCHES "ex27p*")
	list(APPEND THIS_TEST_OPTIONS "-dg")
	elseif(${TEST_NAME} MATCHES "ex37p*")
	list(APPEND THIS_TEST_OPTIONS "-mi" "3")
	endif()

We can use the same approach in the loop for setting up all device tests here:

mfem/examples/CMakeLists.txt

Lines 160 to 161 in 7c296d0

	foreach(TEST_NAME ${DEVICE_EXAMPLES})
	set(THIS_TEST_OPTIONS "-no-vis" "-d" "${MFEM_TEST_DEVICE}")

[pazner]

Something like this for the makefile build?

diff --git a/examples/makefile b/examples/makefile
index d84f04ecc..af055004c 100644
--- a/examples/makefile
+++ b/examples/makefile
@@ -138,6 +138,14 @@ ex10-test-seq: ex10
 	@$(call mfem-test,$<,, Serial example,-tf 5)
 ex10p-test-par: ex10p
 	@$(call mfem-test,$<, $(RUN_MPI), Parallel example,-tf 5)
+ex14-test-seq-cuda: ex14
+	@$(call mfem-test,$<,, Serial CUDA example,-r 2 -pa -d cuda)
+ex14p-test-par-cuda: ex14p
+	@$(call mfem-test,$<, $(RUN_MPI), Parallel CUDA example,-rs 2 -rp 0 -pa -d cuda)
+ex14-test-seq-hip: ex14
+	@$(call mfem-test,$<,, Serial HIP example,-r 2 -pa -d hip)
+ex14p-test-par-hip: ex14p
+	@$(call mfem-test,$<, $(RUN_MPI), Parallel HIP example,-rs 2 -rp 0 -pa -d hip)
 ex15-test-seq: ex15
 	@$(call mfem-test,$<,, Serial example,-e 1)
 ex15p-test-par: ex15p

[v-dobrev]

Something like this for the makefile build?

These look good to me -- same as one of the device sample runs in the source files but without the -o 3.

[pazner]

OK, I added something like that in 14b1c27.

[tzanio]

This PR is now under review (see the table in the PR description). To help with the review process, please do not force push to the branch.

[tzanio]

Merged in next for testing...