Skip to content

Commit d42ca6c

Browse files
Update README.md
1 parent 6883044 commit d42ca6c

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

+13-7
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ pip install glimy
118118
- **mu**: Mu of each point of the grid. Shape of the array is (Nx, Ny,...) in isotropic media; (3,Nx,Ny,Nz) in anisotopic media.
119119
### view_structure(field="e",\*args,colorbar=True)
120120
You can view the grid structure
121-
- **field** : It takes "e" for permittivity array, "mu" for permeability array, "sigma" for conductivity array and "Z" for impedance of the grid.
121+
- **field** : It takes "e" for permittivity array, "mu" for permeability array, "sigma" for conductivity array, "sigma_m" for magnetic conductivity array and "Z" for impedance of the grid.
122122
- **\*args** : Only used in 3D. It used specify axis of view. Plane and and index number can be inserted. For example "z", 10 corresponds z=10 plane in the 3D array. "x","y","z" can be inserted. Also "yz", "xz", "xy" are synonym respectively.
123123
- **colorbar**: If is is set to **True**, colorbar is displayed.
124124
### view_field(field="E",*args,colorbar=True)
@@ -159,57 +159,62 @@ pip install glimy
159159
Adds a new **geo.Singular** object or tuple/list/set of them. If MassiveCluster is volatile, anything can't be added.
160160
- **arg** : **geo.Singular** object or tuple/list/set of them.
161161

162-
## geo.PointCloud(points,layer=0,e=1,mu=1,sigma=0,time=None)
162+
## geo.PointCloud(points,layer=0,e=1,mu=1,sigma=0,sigma_m=0,time=None)
163163
Creates a point cloud object in 2D or 3D. It infills inside the points. It is compatible with convex hull. Draw miscallenious objects(i.e. hexagon,star, hearth) with it.
164164
- **points** : Points that defines convex full. It is a list, tuple or array of 2D or 3D points. Coordinates indicates # of cell in the grid. Like [(1,2), (2,3), (3,4)]. I needs at least 3 points in 2D, 4 points in 3D.
165165
- **layer** : Priority of the object. It is an integer. The less **layer** value, the more prior the object. It is useful where you want to design object are overlapping like open access cavity dielectric waveguides.
166166
- **e** : Relative permittivity of the object. It may take float ot int for isotropic materials, 3×3 array/list/tuple for anisotropic materials. It is not restricted to be less than 1 intentionally, for researching Cherenkov Radiation, metamaterials etc.
167167
- **mu** : Relative permeability of the object. It may take float ot int for isotropic materials, 3×3 array/list/tuple for anisotropic materials. It is not restricted to be less than 1 intentionally.
168168
- **sigma** : Conductivity of the object. It may take float or int.
169+
- **sigma_m** : Magnetic conductivity of the object. It may take float or int.
169170
- **time** : It determines in which time the object is seen and dissappear. If the object is eternal, <code>time=None</code>; otherwise <code>time=(start, stop)</code>, it is a list/tuple of start and stop durations
170171

171172

172-
## geo.Rectangle(A, B, layer, e=1, mu=1, sigma=0, time=None)
173+
## geo.Rectangle(A, B, layer, e=1, mu=1, sigma=0,sigma_m=0, time=None)
173174
Creates a rectangle in 2D.
174175
- **A**: One of non-connected vertex of the Rectangle. It may take an integer. All units are # of grid cells.
175176
- **B**: One of non-connected vertex of the Rectangle. It may take an integer. All units are # of grid cells.
176177
- **layer** : Priority of the object. It is an integer and maximum can take 1000. The less **layer** value, the more prior the object. It is useful where you want to design object are overlapping like open access cavity dielectric waveguides.
177178
- **e** : Relative permittivity of the object. It may take float ot int for isotropic materials, 3×3 array/list/tuple for anisotropic materials. It is not restricted to be less than 1 intentionally, for researching Cherenkov Radiation, metamaterials etc.
178179
- **mu** : Relative permeability of the object. It may take float ot int for isotropic materials, 3×3 array/list/tuple for anisotropic materials. It is not restricted to be less than 1 intentionally.
179180
- **sigma** : Conductivity of the object. It may take float or int.
181+
- **sigma_m** : Magnetic conductivity of the object. It may take float or int.
180182
- **time** : It determines in which time the object is seen and dissappear. If the object is eternal, <code>time=None</code>; otherwise <code>time=(start, stop)</code>, it is a list/tuple of start and stop durations
181183

182-
## geo.Circle(A,r,layer,e=1,mu=1,sigma=0, time=None)
184+
## geo.Circle(A,r,layer,e=1,mu=1,sigma=0,sigma_m=0, time=None)
183185
Creates a circle in 2D.
184186
- **A** : Coordinates of center of the Circle. It may take a tuple or list. All units are # of grid cells.
185187
- **r** : Radius of the circle. It may take an integer. All units are # of grid cells.
186188
- **layer** : Priority of the object. It is an integer and maximum can take 1000. The less **layer** value, the more prior the object. It is useful where you want to design object are overlapping like open access cavity dielectric waveguides.
187189
- **e** : Relative permittivity of the object. It may take float ot int for isotropic materials, 3×3 array/list/tuple for anisotropic materials. It is not restricted to be less than 1 intentionally, for researching Cherenkov Radiation, metamaterials etc.
188190
- **mu** : Relative permeability of the object. It may take float ot int for isotropic materials, 3×3 array/list/tuple for anisotropic materials. It is not restricted to be less than 1 intentionally.
189191
- **sigma** : Conductivity of the object. It may take float or int.
192+
- **sigma_m** : Magnetic conductivity of the object. It may take float or int.
190193
- **time** : It determines in which time the object is seen and dissappear. If the object is eternal, <code>time=None</code>; otherwise <code>time=(start, stop)</code>, it is a list/tuple of start and stop durations
191194

192-
## geo.RectPrism(A, B, layer, e=1, mu=1,sigma=0, time=None)
195+
## geo.RectPrism(A, B, layer, e=1, mu=1,sigma=0,sigma_m=0, time=None)
193196
Creates a rectangular prism in 3D.
194197
- **A**: One of non-connected vertex of the RectPrism. It may take an integer. All units are # of grid cells.
195198
- **B**: One of non-connected vertex of the RectPrism. It may take an integer. All units are # of grid cells.
196199
- **layer** : Priority of the object. It is an integer and maximum can take 1000. The less **layer** value, the more prior the object. It is useful where you want to design object are overlapping like open access cavity dielectric waveguides.
197200
- **e** : Relative permittivity of the object. It may take float ot int for isotropic materials, 3×3 array/list/tuple for anisotropic materials. It is not restricted to be less than 1 intentionally, for researching Cherenkov Radiation, metamaterials etc.
198201
- **mu** : Relative permeability of the object. It may take float ot int for isotropic materials, 3×3 array/list/tuple for anisotropic materials. It is not restricted to be less than 1 intentionally.
199202
- **sigma** : Conductivity of the object. It may take float or int.
203+
- **sigma_m** : Magnetic conductivity of the object. It may take float or int.
200204
- **time** : It determines in which time the object is seen and dissappear. If the object is eternal, <code>time=None</code>; otherwise <code>time=(start, stop)</code>, it is a list/tuple of start and stop durations
201205

202-
## geo.Sphere(C,r,layer=0,e=1,mu=1,sigma=0, time=None)
206+
## geo.Sphere(C,r,layer=0,e=1,mu=1,sigma=0,sigma_m=0, time=None)
203207
Creates a sphere in 3D.
204208
- **C** : Coordinates of center of the Sphere. It may take a tuple or list. All units are # of grid cells.
205209
- **r** : Radius of the sphere. It may take an integer. All units are # of grid cells.
206210
- **layer** : Priority of the object. It is an integer and maximum can take 1000. The less **layer** value, the more prior the object. It is useful where you want to design object are overlapping like open access cavity dielectric waveguides.
207211
- **e** : Relative permittivity of the object. It may take float ot int for isotropic materials, 3×3 array/list/tuple for anisotropic materials. It is not restricted to be less than 1 intentionally, for researching Cherenkov Radiation, metamaterials etc.
208212
- **mu** : Relative permeability of the object. It may take float ot int for isotropic materials, 3×3 array/list/tuple for anisotropic materials. It is not restricted to be less than 1 intentionally.
209213
- **sigma** : Conductivity of the object. It may take float or int.
214+
- **sigma_m** : Magnetic conductivity of the object. It may take float or int.
210215
- **time** : It determines in which time the object is seen and dissappear. If the object is eternal, <code>time=None</code>; otherwise <code>time=(start, stop)</code>, it is a list/tuple of start and stop durations
211216

212-
## geo.Cylinder(C,r,h,layer=0,e=1,mu=1,sigma=0, time=None)
217+
## geo.Cylinder(C,r,h,layer=0,e=1,mu=1,sigma=0,sigma_m=0, time=None)
213218
Creates a cylinder in 3D. Its planes are **parallel to xy-plane**
214219
- **C** : Coordinates of center of the Cylinder. It may take a tuple or list. All units are # of grid cells. Height signifies elongation though z axis.
215220
- **r** : Radius of the Cylinder. It may take an integer. All units are # of grid cells.
@@ -218,4 +223,5 @@ pip install glimy
218223
- **e** : Relative permittivity of the object. It may take float ot int for isotropic materials, 3×3 array/list/tuple for anisotropic materials. It is not restricted to be less than 1 intentionally, for researching Cherenkov Radiation, metamaterials etc.
219224
- **mu** : Relative permeability of the object. It may take float ot int for isotropic materials, 3×3 array/list/tuple for anisotropic materials. It is not restricted to be less than 1 intentionally.
220225
- **sigma** : Conductivity of the object. It may take float or int.
226+
- **sigma_m** : Magnetic conductivity of the object. It may take float or int.
221227
- **time** : It determines in which time the object is seen and dissappear. If the object is eternal, <code>time=None</code>; otherwise <code>time=(start, stop)</code>, it is a list/tuple of start and stop durations.

0 commit comments

Comments
 (0)