gprMax User Guide
Introduction
- Getting Started
- Migrating from gprMax 3 to 4
- At a glance
- 1. Install v4 without replacing v3
- 2. Update launchers and model-building scripts
- 3. Convert exported geometry, not ordinary material commands
- 4. Upgrade result readers, plots and port processing
- 5. Revalidate numerical reference results
- 6. Move repeated experiments deliberately
- Before adopting v4 for a project
- Software Features
- Python API
- Two-dimensional TM and TE modes
- Symmetry boundaries
- Excitation options
- Reusable studies
- Near-to-far-field transformations
- Subgridding
- Dispersive materials
- Realistic soils, heterogeneous objects and rough surfaces
- Library of antenna models
- Anisotropic materials
- Dielectric smoothing
- Perfectly Matched Layer (PML) absorbing boundary conditions
- Open source, robust, file formats
- Guidance on GPR and general electromagnetic modelling
- FAQs
Usage
- Model Building
- Advanced Model Building (Python API)
- Sources and ports
- Reusable studies
- Material databases
- Surface impedance and impedance volumes
- Eigenmode ports and S-parameter analysis
- Surface impedance: theory and validation
- Conventions and continuous boundary model
- Exact trapezoidal ADE
- Discrete geometry and contacts
- Sparse locally implicit FDTD algorithm
- Exact surface-ADE reduction for FDFD
- Eigenmode solution and FDTD injection
- Exact voxel-face PMC
- PML and virtual-guide coupling
- Second-order HORIPML profile guard
- Validation and benchmarking
- Reproducibility metadata
- Implementation map
- Internal realization diagnostics
- Extension guide
- References
- Eigenmode ports: theory and numerical methods
- Model Output
Toolboxes
- GPR Antenna Models
- GPR Antenna Patterns
- Optimisation toolbox
- AustinMan/AustinWoman
- DebyeFit
- Landmine Models
- Materials
- Tagged medical and mesh geometry import
- STLtoVoxel
- STEP-to-voxel conversion
- gprMaxLogo toolbox
- Impulse-response waveform synthesis
- Stepped-Frequency Continuous-Wave GPR
- Frequency-Modulated Continuous-Wave GPR
- Marimo toolbox
- Plotting
- Utilities
Performance
Accuracy
- Analytical comparisons
- TE10 transmission across cutoff
- Full incident-matrix modal de-embedding
- Hertzian dipole in free space
- Plane-wave reflection from dispersive half spaces
- Planar-layered near-to-far-field transform
- Rational lumped networks in a parallel-plate guide
- Hertzian-dipole pattern, directivity, and near field
- Sphere radar cross section
- Dispersive spheres and interface averaging
- Tagged-cell SAR in a lossy half space
- Tagged-cell SAR in a lossy dielectric sphere
- Two-dimensional SAR in lossy dielectric cylinders
- Power-normalisation consistency
- Running the validation suite
- Related half-wave dipole example
- Numerical comparisons
Developers
Appendices