Add PML objects and fix import locations in API docs

- Correct import location for 'output' user objects
- Add documentation for PMLFormulation and PMLThickness userobjects
这个提交包含在:
Nathan Mannall
2025-06-17 12:23:51 +01:00
父节点 df8a6bd956
当前提交 7bbe924283
共有 2 个文件被更改,包括 13 次插入5 次删除

查看文件

@@ -194,11 +194,11 @@ Add Surface Water
Geometry View
-------------
.. autoclass:: gprMax.user_objects.cmds_multiuse.GeometryView
.. autoclass:: gprMax.user_objects.cmds_output.GeometryView
Geometry Objects Write
----------------------
.. autoclass:: gprMax.user_objects.cmds_multiuse.GeometryObjectsWrite
.. autoclass:: gprMax.user_objects.cmds_output.GeometryObjectsWrite
Source and output functions
===========================
@@ -249,7 +249,7 @@ Receiver Steps
Snapshot
--------
.. autoclass:: gprMax.user_objects.cmds_multiuse.Snapshot
.. autoclass:: gprMax.user_objects.cmds_output.Snapshot
Subgrid
-------
@@ -263,7 +263,15 @@ PML functions
The default behaviour for the absorbing boundary conditions (ABC) is first order Complex Frequency Shifted (CFS) Perfectly Matched Layers (PML), with thicknesses of 10 cells on each of the six sides of the model domain. The PML can be customised using the following commands:
PML properties
PML Formulation
---------------
.. autoclass:: gprMax.user_objects.cmds_singleuse.PMLFormulation
PML Thickness
-------------
.. autoclass:: gprMax.user_objects.cmds_singleuse.PMLThickness
PML Properties
--------------
.. autoclass:: gprMax.user_objects.cmds_singleuse.PMLProps

查看文件

@@ -274,7 +274,7 @@ class GeometryView(OutputUserObject):
p2: tuple required for upper right (x,y,z) coordinates of volume of
geometry view in metres.
dl: tuple required for spatial discretisation of geometry view in metres.
output_tuple: string required for per-cell 'n' (normal) or per-cell-edge
output_type: string required for per-cell 'n' (normal) or per-cell-edge
'f' (fine) geometry views.
filename: string required for filename where geometry view will be
stored in the same directory as input file.