diff --git a/docs/source/examples_analytical.rst b/docs/source/examples_analytical.rst new file mode 100644 index 00000000..7322cedf --- /dev/null +++ b/docs/source/examples_analytical.rst @@ -0,0 +1,47 @@ +********************** +Analytical comparisons +********************** + +This section presents comparisons between analytical and modelled solutions. + +Hertzian dipole in free space +============================= + +:download:`hertzian_dipole_fs.in <../../tests/analytical/hertzian_dipole_fs.in>` + +This example is of a Hertzian dipole, i.e. an additive source (electric current density), in free space. + +.. literalinclude:: ../../tests/analytical/hertzian_dipole_fs.in + :language: none + :linenos: + +The module calculates the analytical solution. + +.. automodule:: tests.analytical.analytical_solutions + +Results +------- + +:numref:`hertzian_dipole_fs_results` shows the shows the time history of the electric and magnetic field components of the modelled and analytical solutions. :numref:`hertzian_dipole_fs_results_diffs` shows the percentage differences between the modelled and analytical solutions. + +.. _hertzian_dipole_fs_results: + +.. figure:: ../../tests/analytical/hertzian_dipole_fs_vs_analytical.pdf + :width: 600 px + + Time history of the electric and magnetic field components of the modelled and analytical solutions. + +.. _hertzian_dipole_fs_results_diffs: + +.. figure:: ../../tests/analytical/hertzian_dipole_fs_vs_analytical_diffs.pdf + :width: 600 px + + Percentage differences between the modelled and analytical solutions. + + + + + + + + diff --git a/docs/source/index.rst b/docs/source/index.rst index 1e9b85b2..d8f70a91 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -37,6 +37,7 @@ gprMax User Guide :maxdepth: 2 :caption: Examples + examples_analytical examples_simple_2D examples_antennas examples_advanced