Tidy ups and remove n_built_in_materials

gprMax/materials.py

@@ -215,77 +215,6 @@ class DispersiveMaterial(Material):
         return er
     
 
-def process_materials(G):
-    """Processes complete list of materials - calculates update coefficients,
-        stores in arrays, and builds text list of materials/properties
-
-    Args:
-        G: FDTDGrid class describing a grid in a model.
-
-    Returns:
-        materialsdata: list of material IDs, names, and properties to
-                        print a table.
-    """
-
-    if config.get_model_config().materials['maxpoles'] == 0:
-        materialsdata = [['\nID', '\nName', '\nType', '\neps_r', 'sigma\n[S/m]',
-                          '\nmu_r', 'sigma*\n[Ohm/m]', 'Dielectric\nsmoothable']]
-    else:
-        materialsdata = [['\nID', '\nName', '\nType', '\neps_r', 'sigma\n[S/m]',
-                          'Delta\neps_r', 'tau\n[s]', 'omega\n[Hz]', 'delta\n[Hz]',
-                          'gamma\n[Hz]', '\nmu_r', 'sigma*\n[Ohm/m]', 'Dielectric\nsmoothable']]
-
-    for material in G.materials:
-        # Calculate update coefficients for specific material
-        material.calculate_update_coeffsE(G)
-        material.calculate_update_coeffsH(G)
-
-        # Add update coefficients to overall storage for all materials
-        G.updatecoeffsE[material.numID, :] = material.CA, material.CBx, material.CBy, material.CBz, material.srce
-        G.updatecoeffsH[material.numID, :] = material.DA, material.DBx, material.DBy, material.DBz, material.srcm
-
-        # Add update coefficients to overall storage for dispersive materials
-        if hasattr(material, 'poles'):
-            z = 0
-            for pole in range(config.get_model_config().materials['maxpoles']):
-                G.updatecoeffsdispersive[material.numID, z:z + 3] = (config.sim_config.em_consts['e0'] *
-                                                                     material.eqt2[pole], material.eqt[pole], material.zt[pole])
-                z += 3
-
-        # Construct information on material properties for printing table
-        materialtext = []
-        materialtext.append(str(material.numID))
-        materialtext.append(material.ID[:50] if len(material.ID) > 50 else material.ID)
-        materialtext.append(material.type)
-        materialtext.append(f'{material.er:g}')
-        materialtext.append(f'{material.se:g}')
-        if config.get_model_config().materials['maxpoles'] > 0:
-            if 'debye' in material.type:
-                materialtext.append('\n'.join('{:g}'.format(deltaer) for deltaer in material.deltaer))
-                materialtext.append('\n'.join('{:g}'.format(tau) for tau in material.tau))
-                materialtext.extend(['', '', ''])
-            elif 'lorentz' in material.type:
-                materialtext.append(', '.join('{:g}'.format(deltaer) for deltaer in material.deltaer))
-                materialtext.append('')
-                materialtext.append(', '.join('{:g}'.format(tau) for tau in material.tau))
-                materialtext.append(', '.join('{:g}'.format(alpha) for alpha in material.alpha))
-                materialtext.append('')
-            elif 'drude' in material.type:
-                materialtext.extend(['', ''])
-                materialtext.append(', '.join('{:g}'.format(tau) for tau in material.tau))
-                materialtext.append('')
-                materialtext.append(', '.join('{:g}'.format(alpha) for alpha in material.alpha))
-            else:
-                materialtext.extend(['', '', '', '', ''])
-
-        materialtext.append(f'{material.mr:g}')
-        materialtext.append(f'{material.sm:g}')
-        materialtext.append(material.averagable)
-        materialsdata.append(materialtext)
-
-    return materialsdata
-
-
 class PeplinskiSoil:
     """Soil objects that are characterised according to a mixing model
         by Peplinski (http://dx.doi.org/10.1109/36.387598).
@@ -356,7 +285,6 @@ class PeplinskiSoil:
         #mumaterials = mubins + (mubins[1] - mubins[0]) / 2
         mumaterials = 0.5 * (mubins[1:nbins+1] + mubins[0:nbins])
 
-
         # Create an iterator
         muiter = np.nditer(mumaterials, flags=['c_index'])
         while not muiter.finished:
@@ -399,18 +327,19 @@ class PeplinskiSoil:
             muiter.iternext()
       
 
-
 class RangeMaterial:
-    """Material defined with a given range of parameters to be used for 
+    """Material defined with a given range of parameters to be used for fractal 
-       factal spatial disttibutions 
+        spatial distributions.
     """
 
     def __init__(self, ID, er_range, sigma_range, mu_range, ro_range):
         """
         Args:
             ID: string for name of the material.
-            er_range: tuple of floats for relative permittivity range of the material.
+            er_range: tuple of floats for relative permittivity range of the 
-            sigma_range: tuple of floats for electric conductivity range of the material.
+                        material.
+            sigma_range: tuple of floats for electric conductivity range of the 
+                            material.
             mu_range: tuple of floats for magnetic permeability of material. 
             ro_range: tuple of floats for magnetic loss range of material. 
         """
@@ -425,7 +354,6 @@ class RangeMaterial:
         # and assume that all must be sequentially numbered. This allows for more general mixing models
         self.matID = [] 
        
-
     def calculate_properties(self, nbins, G):
         """Calculates the properties of the materials. 
 
@@ -436,6 +364,7 @@ class RangeMaterial:
 
         # Generate a set of relative permittivity bins based on the given range
         erbins = np.linspace(self.er[0], self.er[1], nbins+1)
+
         # Generate a range of relative permittivity values the mid-point of 
         # each bin to make materials from
         #ermaterials = erbins + np.abs((erbins[1] - erbins[0])) / 2
@@ -443,6 +372,7 @@ class RangeMaterial:
 
         # Generate a set of conductivity bins based on the given range
         sigmabins = np.linspace(self.sig[0], self.sig[1], nbins + 1)
+
         # Generate a range of conductivity values the mid-point of 
         # each bin to make materials from
         #sigmamaterials = sigmabins + (sigmabins[1] - sigmabins[0]) / 2
@@ -450,6 +380,7 @@ class RangeMaterial:
 
         # Generate a set of magnetic permeability bins based on the given range
         mubins = np.linspace(self.mu[0], self.mu[1], nbins + 1)
+
         # Generate a range of magnetic permeability values the mid-point of 
         # each bin to make materials from
         #mumaterials = mubins + np.abs((mubins[1] - mubins[0])) / 2
@@ -457,29 +388,26 @@ class RangeMaterial:
         
         # Generate a set of magnetic loss bins based on the given range
         robins = np.linspace(self.ro[0], self.ro[1], nbins + 1)
-        # Generate a range of magnetic loss values the mid-point of 
+
-        # each bin to make materials from
+        # Generate a range of magnetic loss values the mid-point of each bin to 
+        # make materials from
         #romaterials = robins + np.abs((robins[1] - robins[0])) / 2
         romaterials = 0.5 * (robins[1:nbins+1] + robins[0:nbins])
 
 
         # Iterate over the bins
-        for iter in np.arange(0,nbins):
+        for iter in np.arange(nbins):
-        
             # Relative permittivity 
             er = ermaterials[iter]
-
             # Effective conductivity
             se = sigmamaterials[iter] 
-
+            # Magnetic permeability
-            # magnetic permeability
             mr = mumaterials[iter]
-
+            # Magnetic loss
-            # magnetic loss
             sm = romaterials[iter]
 
             # Check to see if the material already exists before creating a new one
-            requiredID = '|{:.4f}+{:.4f}+{:.4f}+{:.4f}|'.format(float(er),float(se),float(mr),float(sm))
+            requiredID = f'|{float(er):.4f}+{float(se):.4f}+{float(mr):.4f}+{float(sm):.4f}|'
             material = next((x for x in G.materials if x.ID == requiredID), None)
             if iter == 0:
                 if material:
@@ -499,11 +427,10 @@ class RangeMaterial:
                 self.matID.append(m.numID)
 
 
-
 class ListMaterial:
-    """A list of predefined materials to be used for 
+    """A list of predefined materials to be used for fractal spatial 
-       factal spatial disttibutions. This command does not create new materials but collects them to be used in a 
+        distributions. This command does not create new materials but collects 
-       stochastic distribution by a fractal box.
+        them to be used in a stochastic distribution by a fractal box.
     """
 
     def __init__(self, ID, listofmaterials):
@@ -524,21 +451,18 @@ class ListMaterial:
         
 
     def calculate_properties(self, nbins, G):
-        """Calculates the properties of the materials. No Debye is used but name kept the same as used in other 
+        """Calculates the properties of the materials.
-           class that needs Debye
 
         Args:
             nbins: int for number of bins to use to create the different materials.
             G: FDTDGrid class describing a grid in a model.
         """
 
-       
         # Iterate over the bins
-        for iter in np.arange(0,nbins):
+        for iter in np.arange(nbins):
-        
-            # Check to see if the material already exists before creating a new one
             #requiredID = '|{:}_in_{:}|'.format((self.mat[iter]),(self.ID))
             requiredID = self.mat[iter]
+            # Check if the material already exists before creating a new one
             material = next((x for x in G.materials if x.ID == requiredID), None)
             self.matID.append(material.numID)
  
@@ -555,15 +479,11 @@ class ListMaterial:
             #    m.numID = len(G.materials)
             #    G.materials.append(m)
        
-            
             if not material:
                 logger.exception(self.__str__() + f' material(s) {material} do not exist')
                 raise ValueError
             
             
-
-
-
 def create_built_in_materials(G):
     """Creates pre-defined (built-in) materials.
 
@@ -571,8 +491,6 @@ def create_built_in_materials(G):
         G: FDTDGrid class describing a grid in a model.
     """
 
-    G.n_built_in_materials = len(G.materials)
-
     m = Material(0, 'pec')
     m.se = float('inf')
     m.type = 'builtin'
@@ -583,8 +501,6 @@ def create_built_in_materials(G):
     m.type = 'builtin'
     G.materials.append(m)
 
-    G.n_built_in_materials = len(G.materials)
-
 
 def calculate_water_properties(T=25, S=0):
     """Get extended Debye model properties for water.
@@ -627,8 +543,6 @@ def create_water(G, T=25, S=0):
 
     eri, er, tau, sig = calculate_water_properties(T, S)
     
-    G.n_built_in_materials = len(G.materials)
-
     m = DispersiveMaterial(len(G.materials), 'water')
     m.averagable = False
     m.type = 'builtin, debye'
@@ -641,8 +555,6 @@ def create_water(G, T=25, S=0):
     if config.get_model_config().materials['maxpoles'] == 0:
         config.get_model_config().materials['maxpoles'] = 1
 
-    G.n_built_in_materials = len(G.materials)
-
 
 def create_grass(G):
     """Creates single-pole Debye model for grass
@@ -657,8 +569,6 @@ def create_grass(G):
     tau = 1.0793e-11
     sig = 0
 
-    G.n_built_in_materials = len(G.materials)
-
     m = DispersiveMaterial(len(G.materials), 'grass')
     m.averagable = False
     m.type = 'builtin, debye'
@@ -671,4 +581,73 @@ def create_grass(G):
     if config.get_model_config().materials['maxpoles'] == 0:
         config.get_model_config().materials['maxpoles'] = 1
 
-    G.n_built_in_materials = len(G.materials)
+
+def process_materials(G):
+    """Processes complete list of materials - calculates update coefficients,
+        stores in arrays, and builds text list of materials/properties
+
+    Args:
+        G: FDTDGrid class describing a grid in a model.
+
+    Returns:
+        materialsdata: list of material IDs, names, and properties to
+                        print a table.
+    """
+
+    if config.get_model_config().materials['maxpoles'] == 0:
+        materialsdata = [['\nID', '\nName', '\nType', '\neps_r', 'sigma\n[S/m]',
+                          '\nmu_r', 'sigma*\n[Ohm/m]', 'Dielectric\nsmoothable']]
+    else:
+        materialsdata = [['\nID', '\nName', '\nType', '\neps_r', 'sigma\n[S/m]',
+                          'Delta\neps_r', 'tau\n[s]', 'omega\n[Hz]', 'delta\n[Hz]',
+                          'gamma\n[Hz]', '\nmu_r', 'sigma*\n[Ohm/m]', 'Dielectric\nsmoothable']]
+
+    for material in G.materials:
+        # Calculate update coefficients for specific material
+        material.calculate_update_coeffsE(G)
+        material.calculate_update_coeffsH(G)
+
+        # Add update coefficients to overall storage for all materials
+        G.updatecoeffsE[material.numID, :] = material.CA, material.CBx, material.CBy, material.CBz, material.srce
+        G.updatecoeffsH[material.numID, :] = material.DA, material.DBx, material.DBy, material.DBz, material.srcm
+
+        # Add update coefficients to overall storage for dispersive materials
+        if hasattr(material, 'poles'):
+            z = 0
+            for pole in range(config.get_model_config().materials['maxpoles']):
+                G.updatecoeffsdispersive[material.numID, z:z + 3] = (config.sim_config.em_consts['e0'] *
+                                                                     material.eqt2[pole], material.eqt[pole], material.zt[pole])
+                z += 3
+
+        # Construct information on material properties for printing table
+        materialtext = []
+        materialtext.append(str(material.numID))
+        materialtext.append(material.ID[:50] if len(material.ID) > 50 else material.ID)
+        materialtext.append(material.type)
+        materialtext.append(f'{material.er:g}')
+        materialtext.append(f'{material.se:g}')
+        if config.get_model_config().materials['maxpoles'] > 0:
+            if 'debye' in material.type:
+                materialtext.append('\n'.join('{:g}'.format(deltaer) for deltaer in material.deltaer))
+                materialtext.append('\n'.join('{:g}'.format(tau) for tau in material.tau))
+                materialtext.extend(['', '', ''])
+            elif 'lorentz' in material.type:
+                materialtext.append(', '.join('{:g}'.format(deltaer) for deltaer in material.deltaer))
+                materialtext.append('')
+                materialtext.append(', '.join('{:g}'.format(tau) for tau in material.tau))
+                materialtext.append(', '.join('{:g}'.format(alpha) for alpha in material.alpha))
+                materialtext.append('')
+            elif 'drude' in material.type:
+                materialtext.extend(['', ''])
+                materialtext.append(', '.join('{:g}'.format(tau) for tau in material.tau))
+                materialtext.append('')
+                materialtext.append(', '.join('{:g}'.format(alpha) for alpha in material.alpha))
+            else:
+                materialtext.extend(['', '', '', '', ''])
+
+        materialtext.append(f'{material.mr:g}')
+        materialtext.append(f'{material.sm:g}')
+        materialtext.append(material.averagable)
+        materialsdata.append(materialtext)
+
+    return materialsdata

gprMax/subgrids/user_objects.py

@@ -123,7 +123,7 @@ class SubGridBase(UserObjectMulti):
         self.subgrid = sg
 
         # Copy over built in materials
-        sg.materials = [copy(m) for m in grid.materials if m.numID in range(0, grid.n_built_in_materials + 1)]
+        sg.materials = [copy(m) for m in grid.materials if m.type == 'builtin']
 
         # Don't mix and match different subgrid types
         for sg_made in grid.subgrids: