Create example cases folder

[aabrown100-git]

Problem

New users of the code may have difficulty setting up their simulations, especially choosing practical values for various parameters. tests/cases has many useful cases, but these are primarily for continuous integration testing. Importantly, solver tolerances and other simulation aspects are chosen for testing, and are generally not appropriate for normal simulations in the research context.

Solution

An examples/ folder containing real-life svMultiPhysics simulations that have been set up by lab members or other users for research purposes would help guide new users to set up their own simulations. These cases can also include a detailed README explaining how the simulation is set up, especially how timestep size, tolerances, etc. are chosen.

To begin with, @alisonmarsden suggested adding @divyaadil23's aorta case (both CFD and FSI). I can add a cardiac mechanics case and a cardiac FSI case. Perhaps @javijv4 or @elenasmartinez can add an EP case. We can also take cases from the VMR. Ideally, these should be simulations that are relatively refined and optimized.

Additional context

This examples/ folder should be linked from svMultiPhysics documentation

The user guide in the documentation already contains much helpful information about setting up real-life simulations. @ktbolt I recall we collected simulation cases for this user guide, but I don't think they were all incorporated. Do you have thoughts about how the user guide and examples/ folder should relate?

Code of Conduct

• I agree to follow this project's Code of Conduct and Contributing Guidelines

[mrp089]

We could still include these examples in a less-frequent integration test, e.g., once a week/month and only compare the last time step, to ensure that the simulations can still be executed with the current svMultiPhysics (e.g., in case parameters or the input file format change).

[ktbolt]

@mrp089 My thoughts exactly !

It would also be good to keep track of memory usage and execution time.

Also it might also be useful to have some standard verification examples: backward-facing step, flow around a cylinder, etc. @dcodoni was looking into this I think.

Also also maybe even something from the cardiovascular cfd challenge.

[aabrown100-git]

@ktbolt @alisonmarsden Do you have thoughts about how these should relate to the examples in the User Guide in svMultiPhysics documentation? The User Guide seems to still be under development.

[ktbolt]

@aabrown100-git There is still no useful User Guide content. I have thought to add some not-too-detailed content there to at least have something that will be useful to new users but even that will take a lot of time and effort; still undecided about this.

The simulations used in the User Guide will be in the examples directory.

[alisonmarsden]

I think we should create examples (ideally with associated simple user guides) from Divya’s two aorta models: CFD and FSI. these are the same models being used in the svMultiPhysics solver paper, and Sujal should have the files. At the very least some simple description of the settings and making the input files available would be highly useful to people. It may prevent people from using the “tests” as examples which is currently causing a lot of problems with folks using inappropriate tolerances.

[ktbolt]

@alisonmarsden OK, I will have at it.