Restructure to add analytical comparisons.

这个提交包含在:
Craig Warren
2016-01-28 09:35:12 +00:00
父节点 741b914609
当前提交 6151bdae86
共有 3 个文件被更改,包括 10 次插入5 次删除

查看文件

@@ -15,14 +15,14 @@ This example is of a Hertzian dipole, i.e. an additive source (electric current
:language: none
:linenos:
The following module calculates the analytical solution.
The function ``hertzian_dipole_fs`` in the ``analytical solutions`` module in the ``tests`` sub-package was written to compute the analytical solution.
.. automodule:: tests.analytical_solutions
.. autofunction:: tests.analytical_solutions.hertzian_dipole_fs
Results
-------
:numref:`hertzian_dipole_fs_results` shows the time history of the electric and magnetic field components of the modelled and analytical solutions. Since they are so similar, :numref:`hertzian_dipole_fs_results_diffs` shows the percentage differences.
:numref:`hertzian_dipole_fs_results` shows the time history of the electric and magnetic field components of the modelled and analytical solutions. The responses overlap one another due to their similarity. Therefore, :numref:`hertzian_dipole_fs_results_diffs` shows the percentage differences between the solutions.
.. _hertzian_dipole_fs_results:

查看文件

@@ -37,7 +37,6 @@ gprMax User Guide
:maxdepth: 2
:caption: Examples
examples_analytical
examples_simple_2D
examples_antennas
examples_advanced
@@ -48,5 +47,11 @@ gprMax User Guide
faqs
screencasts
.. toctree::
:maxdepth: 2
:caption: Appendices
analytical_comparisons
references

查看文件

@@ -73,6 +73,6 @@ b) Compile the Cython extension modules using: :code:`python setup.py build_ext
.. note::
If you want to remove/clean Cython generated files, e.g. before rebuilding the Cython extensions, you can use :code:`python setup.py cleanall`.
If you want to remove/clean Cython generated files, e.g. before rebuilding the Cython extensions, you can use :code:`python setup.py cleanall`.
**You are now ready to proceed to running gprMax.**