Added antenna model dimensions to docs.

docs/source/user_libs_antennas.rst

@@ -15,8 +15,8 @@ Information
 
 The module currently features models of antennas similar to commercial GPR antennas:
 
-* Geophysical Survey Systems, Inc. (GSSI) 1.5 GHz (Model 5100) antenna (http://www.geophysical.com)
-* MALA Geoscience 1.2 GHz antenna (http://www.malags.com/)
+* Geophysical Survey Systems, Inc. (GSSI) 1.5 GHz (Model 5100) antenna (http://www.geophysical.com). The dimensions of the GSSI 1.5GHz antenna model are: 170x108x45mm.
+* MALA Geoscience 1.2 GHz antenna (http://www.malags.com/). The dimensions of the MALA 1.2GHz antenna model are: 184x109x46mm.
 
 A description of how the models were created can be found at http://dx.doi.org/10.1190/1.3548506.
 
@@ -51,4 +51,4 @@ To include an antenna model similar to a GSSI 1.5 GHz antenna at a location 0.12
 .. figure:: images/antenna_like_MALA_1200.png
     :width: 600 px
 
-    FDTD geometry mesh showing an antenna model similar to a MALA 1.2GHz antenna (skid removed for illustrative purposes).
+    FDTD geometry mesh showing an antenna model similar to a MALA 1.2GHz antenna (skid removed for illustrative purposes).

docs/source/user_libs_landmines.rst

@@ -30,27 +30,35 @@ Package overview
 .. code-block:: none
 
     can_1x1x1.h5
+    can_2x2x2.h5
     can_materials.txt
     PMA_1x1x1.h5
+    PMA_2x2x2.h5
     PMA_materials.txt
     PMN_1x1x1.h5
+    PMN_2x2x2.h5
     PMN_materials.txt
     TS50_1x1x1.h5
+    TS50_2x2x2.h5
     TS50_materials.txt
 
 * ``can_1x1x1.h5`` is a HDF5 file containing a description of the geometry of the metal can (false target) with a cubic spatial resolution of 1mm
+* ``can_2x2x2.h5`` is a HDF5 file containing a description of the geometry of the metal can (false target) with a cubic spatial resolution of 2mm
 * ``can_materials.txt`` is a text file containing material properties associated with the metal can
 * ``PMA_1x1x1.h5`` is a HDF5 file containing a description of the geometry of the PMA landmine with a cubic spatial resolution of 1mm
+* ``PMA_2x2x2.h5`` is a HDF5 file containing a description of the geometry of the PMA landmine with a cubic spatial resolution of 2mm
 * ``PMA_materials.txt`` is a text file containing material properties associated with the PMA landmine
 * ``PMN_1x1x1.h5`` is a HDF5 file containing a description of the geometry of the PMN landmine with a cubic spatial resolution of 1mm
+* ``PMN_2x2x2.h5`` is a HDF5 file containing a description of the geometry of the PMN landmine with a cubic spatial resolution of 2mm
 * ``PMN_materials.txt`` is a text file containing material properties associated with the PMN landmine
 * ``TS50_1x1x1.h5`` is a HDF5 file containing a description of the geometry of the TS-50 landmine with a cubic spatial resolution of 1mm
+* ``TS50_2x2x2.h5`` is a HDF5 file containing a description of the geometry of the TS-50 landmine with a cubic spatial resolution of 2mm
 * ``TS50_materials.txt`` is a text file containing material properties associated with the TS-50 landmine
 
 How to use the models
 =====================
 
-To insert any of the landmine models or metal can into a simulation use the ``#geometry_objects_file`` command.
+To insert any of the landmine models or metal can into a simulation use the ``#geometry_objects_read`` command.
 
 Example
 -------
@@ -63,10 +71,10 @@ The input file for inserting the PMN landmine, with the lower left corner 10mm f
     #domain: 0.136 0.176 0.070
     #dx_dy_dz: 0.001 0.001 0.001
     #time_window: 5e-9
-    #geometry_objects_file: 0.010 0.010 0.010 ../user_libs/landmines/PMN_1x1x1.h5 ../user_libs/landmines/PMN_materials.txt
+    #geometry_objects_read: 0.010 0.010 0.010 ../user_libs/landmines/PMN_1x1x1.h5 ../user_libs/landmines/PMN_materials.txt
     #geometry_view: 0 0 0 0.136 0.176 0.070 0.001 0.001 0.001 landmine_PMN_fs n
 
-For further information on the ``#geometry_objects_file`` see the section on object contruction commands in the :ref:`Input commands section <commands>`.
+For further information on the ``#geometry_objects_read`` see the section on object contruction commands in the :ref:`Input commands section <commands>`.
 
 .. figure:: images/user_libs/PMA.png
     :width: 600 px

user_libs/antennas.py

@@ -13,7 +13,7 @@ from gprMax.input_cmd_funcs import *
 moduledirectory = os.path.dirname(os.path.abspath(__file__))
 
 def antenna_like_GSSI_1500(x, y, z, resolution=0.001, **kwargs):
-    """Inserts a description of an antenna similar to the GSSI 1.5GHz antenna. Can be used with 1mm (default) or 2mm spatial resolution. The external dimensions of the antenna are 170mm x 108mm x 45mm. One output point is defined between the arms of the receiever bowtie. The bowties are aligned with the y axis so the output is the y component of the electric field.
+    """Inserts a description of an antenna similar to the GSSI 1.5GHz antenna. Can be used with 1mm (default) or 2mm spatial resolution. The external dimensions of the antenna are 170x108x45mm. One output point is defined between the arms of the receiever bowtie. The bowties are aligned with the y axis so the output is the y component of the electric field.
         
     Args:
         x, y, z (float): Coordinates of a location in the model to insert the antenna. Coordinates are relative to the geometric centre of the antenna in the x-y plane and the bottom of the antenna skid in the z direction.
@@ -167,7 +167,7 @@ def antenna_like_GSSI_1500(x, y, z, resolution=0.001, **kwargs):
 
 
 def antenna_like_MALA_1200(x, y, z, resolution=0.001, **kwargs):
-    """Inserts a description of an antenna similar to the MALA 1.2GHz antenna. Can be used with 1mm (default) or 2mm spatial resolution. The external dimensions of the antenna are 184mm x 109mm x 46mm. One output point is defined between the arms of the receiever bowtie. The bowties are aligned with the y axis so the output is the y component of the electric field.
+    """Inserts a description of an antenna similar to the MALA 1.2GHz antenna. Can be used with 1mm (default) or 2mm spatial resolution. The external dimensions of the antenna are 184x109x46mm. One output point is defined between the arms of the receiever bowtie. The bowties are aligned with the y axis so the output is the y component of the electric field.
         
     Args:
         x, y, z (float): Coordinates of a location in the model to insert the antenna. Coordinates are relative to the geometric centre of the antenna in the x-y plane and the bottom of the antenna skid in the z direction.