Updated PML info

gprMax/cmds_multiuse.py

@@ -51,7 +51,7 @@ class UserObjectMulti:
     def __init__(self, **kwargs):
         self.kwargs = kwargs
         self.order = None
-        self.hash = '#example'
+        self.hash = None
         self.autotranslate = True
         self.do_rotate = False
 
@@ -1580,7 +1580,8 @@ class GeometryObjectsWrite(UserObjectMulti):
 
 
 class PMLCFS(UserObjectMulti):
-    """Controls parameters that are used to build each order of PML. 
+    """Controls parameters that are used to build each order of PML. Default
+        values are set in pml.py
 
     Attributes:
         alphascalingprofile: string required for type of scaling to use for 
@@ -1606,7 +1607,6 @@ class PMLCFS(UserObjectMulti):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
         self.order = 16
-        self.hash = '#pml_cfs'
 
     def create(self, grid, uip):
         try:

gprMax/cmds_singleuse.py

@@ -262,11 +262,14 @@ class OMPThreads(UserObjectSingle):
 
 
 class PMLProps(UserObjectSingle):
-    """Specifies the formulation used, and controls the number of cells 
-        (thickness) of PML that are used on the six sides of the model domain.
+    """Specifies the formulation used and thickness (number of cells) of PML 
+        that are used on the six sides of the model domain. Current options are 
+        to use the Higher Order RIPML (HORIPML) - https://doi.org/10.1109/TAP.2011.2180344, 
+        or Multipole RIPML (MRIPML) - https://doi.org/10.1109/TAP.2018.2823864.
 
     Attributes:
-        formulation: string specifying formulation to be used for all PMLs.
+        formulation: string specifying formulation to be used for all PMLs 
+                        either 'HORIPML' or 'MRIPML'.
         thickness or x0, y0, z0, xmax, ymax, zmax: ints for thickness of PML 
                                                     on all 6 sides or individual 
                                                     sides of the model domain.

gprMax/hash_cmds_file.py

@@ -203,7 +203,7 @@ def check_cmd_names(processedlines, checkessential=True):
 
     # Commands that there should only be one instance of in a model
     singlecmds = dict.fromkeys(['#domain', '#dx_dy_dz', '#time_window', 
-                                '#title', '#cpu_threads', 
+                                '#title', '#omp_threads', 
                                 '#time_step_stability_factor', '#pml_cells', 
                                 '#excitation_file', '#src_steps', '#rx_steps', 
                                 '#output_dir'], None)

gprMax/hash_cmds_singleuse.py

@@ -51,7 +51,7 @@ def process_singlecmds(singlecmds):
         scene_objects.append(output_dir)
 
     # Number of threads for CPU-based (OpenMP) parallelised parts of code
-    cmd = '#cpu_threads'
+    cmd = '#omp_threads'
     if singlecmds[cmd] is not None:
         tmp = tuple(int(x) for x in singlecmds[cmd].split())
         if len(tmp) != 1: