Add cardiac mechanics example to svMultiPhysics documentation

[dseyler]

Problem

User guide should include a detailed description of how to run a cardiovascular structural mechanics simulation.

Solution

The improved documentation will include all necessary files to run a simulation of cardiac mechanics in an idealized left ventricle and documentation describing parameter choices in the input file.

Until svMultiPhysics is updated to include virtual cap surfaces, this example will use a provided active stress and active pressure. This results in an odd-looking pressure-volume loop as the included stress and pressure temporal data are not perfectly in sync. After the virtual surface feature is implemented, the example should instead couple the cardiac flow rate to a 0D LPN to give more realistic results.

Additional context

No response

Code of Conduct

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

[dseyler]

@ktbolt Changes to the user guide can be found in the example directory here:

As stated in the issue, this example uses prescribed pressure and active stress. In the future it should be updated to couple the endocardial surface (and associated virtual cap surface) to an LPN.

[ktbolt]

@dseyler The content in noninear_solid_mechanics/Example seems like it should be placed in https://github.com/SimVascular/svMultiPhysics/examples

We don't want solver files located in the documentation repository.

[dseyler]

@ktbolt That makes sense. Should the readme.md still be in the user guide? If so, how should we direct readers to the solver files?

[ktbolt]

@dseyler We should create a svMultiPhysics/examples directory containing sub-directories for each User Guide section. You can put the README.md and simulation files there. The User Guide section can link to those files.

There still needs to be a User Guide section for Cardiac Mechanics that will provide all of the necessary background and svMultiPhysics details that will allow a new user to understand how to set up and run these types of simulations.