diff --git a/README.md b/README.md index 1e3e0a7..67fe049 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,53 @@ pytest tests ## Documentation Available at https://acea15.github.io/FENIAX/ -## Examples +## Simulation Examples -The folder examples contains various instances with models, input files and postprocessing of the results. See each README.org for for more info. +The most relevant examples in the code base are shown here, these and more can be found in the folder `/examples` +They are also part of a large test suite that is integrated into the development using CI/CD. +!!! tip + Navigate to the code of the various examples, including the simulation input settings and postprocessing of the simulation --exactly as it was used for the articles backing the software. + + +### Nonlinear structural static results +!!! success + Validated with MSC Nastran nonlinear solution (sol 400) + +[Notebook](./docs/documentation/examples/SailPlane/sailplane_nb.md) + +### Wing free dynamics +!!! success + Validated with MSC Nastran nonlinear solution (sol 400) + +[Notebook](./docs/documentation/examples/wingSP/wingSP_nb.md) + + +![Wing free dynamics](./docs/media/wingSP_optimized.gif) + + +### Free flying structure + +[Bio](https://mechanics.stanford.edu/simo) + +[Notebook](./docs/documentation/examples/wingSP/wingSP_nb.md) + +#### 2D dynamics +![Free flying structure 2D](./docs/media/SimoFFB2D_optimized.gif) +#### 3D dynamics +![Free flying structure 3D](./docs/media/SimoFFB3D_optimized.gif) + +### Industrial Aircraft model +!!! success + Linear response validated with MSC Nastran linear aeroelastic solution (sol 146) + +#### Gust clamped model + +[Notebook](./docs/documentation/examples/XRF1/xrf1_nb.md) + + +![XRF1-gustclamped](./docs/media/xrf1_gust_optimized.gif) + + +#### Gust trimmed flight +![XRF1-Trim+gust](./docs/media/xrf1_trimgust_optimized.gif) diff --git a/docs/media/SimoFFB2D_optimized.gif b/docs/media/SimoFFB2D_optimized.gif new file mode 100644 index 0000000..414d65b Binary files /dev/null and b/docs/media/SimoFFB2D_optimized.gif differ diff --git a/docs/media/SimoFFB3D_optimized.gif b/docs/media/SimoFFB3D_optimized.gif new file mode 100644 index 0000000..0892565 Binary files /dev/null and b/docs/media/SimoFFB3D_optimized.gif differ diff --git a/docs/media/wingSP_optimized.gif b/docs/media/wingSP_optimized.gif new file mode 100644 index 0000000..4fee6d8 Binary files /dev/null and b/docs/media/wingSP_optimized.gif differ diff --git a/docs/media/xrf1_gust.gif b/docs/media/xrf1_gust.gif new file mode 100644 index 0000000..3c8afe5 Binary files /dev/null and b/docs/media/xrf1_gust.gif differ diff --git a/docs/media/xrf1_gust_optimized.gif b/docs/media/xrf1_gust_optimized.gif new file mode 100644 index 0000000..14d7472 Binary files /dev/null and b/docs/media/xrf1_gust_optimized.gif differ diff --git a/docs/media/xrf1_trimgust.gif b/docs/media/xrf1_trimgust.gif new file mode 100644 index 0000000..29cefa9 Binary files /dev/null and b/docs/media/xrf1_trimgust.gif differ diff --git a/docs/media/xrf1_trimgust_optimized.gif b/docs/media/xrf1_trimgust_optimized.gif new file mode 100644 index 0000000..2c1360d Binary files /dev/null and b/docs/media/xrf1_trimgust_optimized.gif differ