diff --git a/examples/README.md b/examples/README.md index 5d73eb799f25e29ec452d03b0d92f1fe321148c7..0a954f37ab07da2a335c13024294f72de264e235 100644 --- a/examples/README.md +++ b/examples/README.md @@ -47,7 +47,7 @@ You learn how to __Model equations:__ Immiscible two-phase flow Darcy equations in porous media (`TwoP`)<br /> __Discretization method:__ Cell-centered finite volumes with two-point flux approximation (`CCTpfaModel`) - +0 </td> <td width="35%"><a href="2pinfiltration/README.md"> <figure><img src="2pinfiltration/img/test_2p_pointsource_adaptive.png" alt="2p result"/></figure> @@ -203,3 +203,13 @@ __Discretization method:__ Cell-centered finite volumes with two-point flux appr <figure><img src="embedded_network_1d3d/img/network.png" alt="blood vessel network"/></figure></td> </a></td> </tr></table> + +### [:open_file_folder: Example 10: A random concentration field diffusing](diffusion/README.md) +<table><tr><td> +In this example a 2D domain is initialized with a random concentration field that is then subject to diffusion while neglecting convection. + +</td> +<td width="35%"><a href="diffusion/README.md"> +<figure><img src="diffusion/img/diffusion.gif" alt="diffusion"/></figure></td> +</a></td> +</tr></table> diff --git a/examples/diffusion/.doc_config b/examples/diffusion/.doc_config new file mode 100644 index 0000000000000000000000000000000000000000..9fba5d44d2942283b157f013b5a535b78b1aad98 --- /dev/null +++ b/examples/diffusion/.doc_config @@ -0,0 +1,5 @@ +{ + "README.md" : [ + "doc/_intro.md" + ] +} diff --git a/examples/diffusion/README.md b/examples/diffusion/README.md new file mode 100644 index 0000000000000000000000000000000000000000..e31ae16231c2427039b44c62a3fa7a49aa4475bf --- /dev/null +++ b/examples/diffusion/README.md @@ -0,0 +1,26 @@ +<!-- Important: This file has been automatically generated by generate_example_docs.py. Do not edit this file directly! --> + +# Simple diffusion example + +In this example a random concentration field is subject to diffusion only + +__The main points illustrated in this example are__ +* TODO + +__Table of contents__. This description is structured as follows: + +[[_TOC_]] + +## Problem set-up + +TODO + +## Model description + +TODO + +### The simple diffusion model + +TODO + + diff --git a/examples/diffusion/doc/_intro.md b/examples/diffusion/doc/_intro.md new file mode 100644 index 0000000000000000000000000000000000000000..a9a249b81474d10f52c77e19b850440f16b2e2d4 --- /dev/null +++ b/examples/diffusion/doc/_intro.md @@ -0,0 +1,24 @@ +# Simple diffusion example + +In this example a random concentration field is subject to diffusion only + +__The main points illustrated in this example are__ +* TODO + +__Table of contents__. This description is structured as follows: + +[[_TOC_]] + +## Problem set-up + +TODO + +## Model description + +TODO + +### The simple diffusion model + +TODO + + diff --git a/examples/diffusion/img/diffusion.gif b/examples/diffusion/img/diffusion.gif new file mode 100644 index 0000000000000000000000000000000000000000..3dcc88d3426d4c2cf60b7ef3620d33d39f720dea Binary files /dev/null and b/examples/diffusion/img/diffusion.gif differ