Add geometry objects read to Python API docs

这个提交包含在:
Nathan Mannall
2025-07-17 15:53:49 +01:00
父节点 1a7dcf4339
当前提交 4946861951
共有 2 个文件被更改,包括 21 次插入1 次删除

查看文件

@@ -196,6 +196,10 @@ Geometry View
-------------
.. autoclass:: gprMax.user_objects.cmds_output.GeometryView
Geometry Objects Read
----------------------
.. autoclass:: gprMax.user_objects.cmds_geometry.geometry_objects_read.GeometryObjectsRead
Geometry Objects Write
----------------------
.. autoclass:: gprMax.user_objects.cmds_output.GeometryObjectsWrite

查看文件

@@ -1,5 +1,5 @@
# Copyright (C) 2015-2025: The University of Edinburgh, United Kingdom
# Authors: Craig Warren, Antonis Giannopoulos, John Hartley,
# Authors: Craig Warren, Antonis Giannopoulos, John Hartley,
# and Nathan Mannall
#
# This file is part of gprMax.
@@ -33,6 +33,22 @@ logger = logging.getLogger(__name__)
class GeometryObjectsRead(GeometryUserObject):
"""Allows you to insert pre-defined geometry into a model.
The geometry is specified using a 3D array of integer numbers stored
in a HDF5 file. The integer numbers must correspond to the order of
a list of ``#material`` commands specified in a text file.
Attributes:
p1: list of lower left (x,y,z) coordinates in the domain where
the lower left corner of the geometry array should be
placed.
geofile: string path to and filename of the HDF5 file that
contains an integer array which defines the geometry.
matfile: string path to and filename of the text file that
contains ``#material`` commands.
"""
@property
def hash(self):
return "#geometry_objects_read"