Solver¶
The solver layer holds the numerical core. Available backends:
| Backend | Soil model | Method | Status |
|---|---|---|---|
image |
HomogeneousSoil |
image-charge sum (point sources + line self-action) | implemented |
image_2layer |
TwoLayerSoil |
Tagg/Sunde image-charge series | implemented |
image_nlayer |
HomogeneousSoil, TwoLayerSoil, MultiLayerSoil |
image-charge dispatcher (delegates to image for n=1, to image_2layer for n=2; raises for n ≥ 3) |
implemented |
cim |
any layered | Complex Image Method (matrix-pencil fit of \(\Gamma_1(\lambda)\)) | implemented |
mom |
HomogeneousSoil or TwoLayerSoil |
Galerkin Method-of-Moments on segment level (independent resolution scheme over the same Green's-function kernels) | implemented |
mom_sommerfeld |
any layered | Galerkin MoM with direct Sommerfeld quadrature (reference engine) | implemented |
bem |
any layered | Boundary-element collocation with the CIM kernel | implemented |
fem |
any layered | Axisymmetric volume PDE with equivalent-hemisphere reduction | implemented |
Mathematical / physical model¶
For a point current source \(I\) at \(z_s\) in the upper layer of a horizontally stratified half-space (insulating soil surface at \(z = 0\)), every backend evaluates the same quasi-static Sommerfeld representation of the potential:
with the upward-looking reflection \(\Gamma_1(\lambda)\) built
recursively from the bottom up
(groundfield.solver._layered.reflection_gamma). The engines differ
only in how they evaluate this integral:
- closed-form real images (
image,image_2layer,image_nlayer); - closed-form complex images (
cim); - direct numerical quadrature (
mom_sommerfeld); - volume PDE (
fem).
ADR-0002 (docs/adr/0002-engine-family.md) records the selection
heuristic between the engines.
Auto-dispatch¶
Engine.solve automatically forwards backend="image":
- to
image_2layerifworld.soilis aTwoLayerSoil; - to
image_nlayerifworld.soilis aMultiLayerSoil.
Notebooks therefore keep working unchanged when the soil model is swapped.
Example¶
import groundfield as gf
# Build a small world (single ring electrode in two-layer soil).
soil = gf.TwoLayerSoil(rho_1=100.0, rho_2=500.0, h_1=2.0)
world = gf.create_world(soil=soil)
gf.create_electrode(
world, "ring", name="g1",
center=(0.0, 0.0, 0.8), radius=5.0, wire_radius=0.005,
)
gf.create_source(world, attached_to="g1", magnitude=1.0)
# Create an engine and solve. Auto-dispatch hands `image` over to
# `image_2layer` because the soil is two-layer.
engine = gf.create_engine(
backend="image",
frequencies=[50.0, 150.0, 250.0],
segment_length=0.05,
)
result = world.solve(engine)
# Cluster impedance of the ring electrode.
print(result.cluster_impedance("g1"))
The same World can be solved with any of the eight backends —
compare_engines(world, engines={"image": ..., "mom": ...}) reports
their cluster-impedance agreement (cross-validation rules below).
Frequency-list order¶
Engine.frequencies is order-preserving. The list is iterated
verbatim and the same order propagates to
FieldResult.frequencies and to every per-frequency column in the
post-processing helpers (postprocess.sweep, the CSV writers,
fit_to_sympy, etc.). A non-monotonic list — e.g. [5000, 50] —
is accepted but raises a UserWarning so the convention is
visible. Use the explicit opt-in if the order is intentional:
Engine.with_frequencies returns a fresh Engine instance; the
receiver is not mutated.
Cross-engine validation¶
groundfield.compare_engines(world, engines={...}) runs the same
world through several engines and reports the cluster-impedance
agreement. The same rule is enforced by
tests/test_cross_engines_extended.py:
- For homogeneous worlds every engine must agree to within 5 %
(10 % for
fem). - For 2-layer worlds the closed-form / image / MoM engines must agree with each other to within 5 %.
- A monotone \(\rho_2\) sweep at fixed \(\rho_1\) must produce a monotonically increasing cluster impedance for every engine.
solver ¶
Numerical field solver.
This subpackage forms the computational core of groundfield. The
key quantity is the complex potential phi(r, f) in the soil and on
the conductor surfaces, evaluated per frequency in the phasor domain.
The default solution method for homogeneous soil is the closed-form
image-charge sum; for layered soil the Tagg/Sunde image series. A
Method-of-Moments backend with the layered Green's function and a
finite-element backend (scikit-fem) are reserved.
Contents
Engine
Top-level configuration of the numerical kernel: backend choice,
frequency list, mesh resolution, tolerances. solve(world) runs
the simulation.
Backend
Literal type listing the available backends
("image", "image_2layer", "mom", "fem").
FieldResult, PointSource
Result objects.
solve_image, solve_image_2layer
Backend entry points (usually called via Engine.solve).
Guiding principle
The PDE / field model is a reference, not the end product. Every
solution must expose the quantities required by groundinsight
(input impedance, transfer impedances, rho-f curve) for the
reduction step.
Engine ¶
Bases: BaseModel
Configuration of the numerical kernel.
Attributes:
| Name | Type | Description |
|---|---|---|
backend |
Backend
|
Numerical method. One of |
frequencies |
list[float]
|
Frequency list in Hz. Default |
segment_length |
float
|
Maximum segment length used to discretise the geometry, in m. |
tolerance |
float
|
Relative convergence threshold for iterative solvers. |
max_iterations |
int
|
Maximum iterations for iterative solvers. |
earth_inductive_model |
EarthInductiveModel
|
How the earth contributes to the inductive coupling between
distributed-conductor segments (only effective when at least
one conductor sets
|
solve ¶
Run the simulation with the configured backend.
Dispatches the assembled world to the backend selected by
:attr:backend. When backend == "image" the backend is
auto-forwarded to "image_2layer" for a
:class:~groundfield.soil.models.TwoLayerSoil and to
"image_nlayer" for a
:class:~groundfield.soil.models.MultiLayerSoil, so notebooks
written for the homogeneous case keep working when the soil
model is replaced.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
world
|
World
|
The assembled world (soil, electrodes, conductors and at least one source) the backend should solve. |
required |
Returns:
| Type | Description |
|---|---|
FieldResult
|
Container with per-frequency potentials, currents, cluster impedances and post-processing metadata. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If |
Source code in src/groundfield/solver/engine.py
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 | |
with_frequencies ¶
Return a copy of this engine with a new frequencies list.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
*frequencies
|
float
|
One or more frequencies in Hz. Variadic to make the
common case readable: |
()
|
preserve_order
|
bool
|
If |
False
|
Returns:
| Type | Description |
|---|---|
Engine
|
A new :class: |
Examples:
>>> eng = Engine(backend="image").with_frequencies(50, 5000,
... preserve_order=True)
>>> eng.frequencies
[50.0, 5000.0]
Source code in src/groundfield/solver/engine.py
FieldResult ¶
Bases: BaseModel
Result of a field computation.
cluster_impedance ¶
Grounding impedance of the galvanic cluster containing an electrode.
Definition: \(Z_{\text{cluster}}(f) =
\varphi_{\text{cluster}}/\sum_{e \in c} I_e\). For a
stand-alone electrode this is identical to
:meth:grounding_impedance. For connected electrodes it
corresponds to the parallel combination of the individual
grounding admittances.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
electrode_name
|
str
|
Name of any electrode in the target cluster. The cluster
members are looked up in :attr: |
required |
Returns:
| Type | Description |
|---|---|
list[complex]
|
Complex cluster impedance per frequency in ohms, one entry
per entry in :attr: |
Raises:
| Type | Description |
|---|---|
KeyError
|
If the resolved cluster is empty. |
Source code in src/groundfield/solver/result.py
grounding_impedance ¶
Input impedance \(Z(f) = U/I\) of an electrode.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
electrode_name
|
str
|
Name of the electrode whose input impedance is requested.
Must be present in both :attr: |
required |
Returns:
| Type | Description |
|---|---|
list[complex]
|
Complex impedance per frequency in ohms, one entry per
entry in :attr: |
Raises:
| Type | Description |
|---|---|
KeyError
|
If |
Notes
For galvanically connected electrodes (cluster with more than
one member) this quantity is the cluster potential divided by
the electrode's share of the total current. The physically
meaningful quantity is the cluster impedance (see
:meth:cluster_impedance).
Source code in src/groundfield/solver/result.py
potential ¶
potential(
points: np.ndarray,
frequency_index: int = 0,
min_distance: float = 0.001,
) -> np.ndarray
Evaluate the potential at field points (image-charge sum).
Picks the appropriate Green's-function kernel automatically:
- homogeneous (:class:
HomogeneousSoilor noself.soilset butsoil_resistivityavailable): classic image-charge sum \(1/r + 1/r_{\text{img}}\). - 2-layer (:class:
TwoLayerSoil, or :class:MultiLayerSoilwith exactly two layers): Tagg/Sunde series with adaptive truncation (tolerance \(10^{-6}\), at most 100 terms). - 1-layer (:class:
MultiLayerSoilwith a single layer): degenerate case, dispatched to the homogeneous kernel.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
points
|
ndarray
|
Field points, array of shape |
required |
frequency_index
|
int
|
Index into :attr: |
0
|
min_distance
|
float
|
Numerical cutoff for 1/r singularities, in metres. |
0.001
|
Returns:
| Name | Type | Description |
|---|---|---|
phi |
(ndarray, shape(M))
|
Complex potential in V. |
Raises:
| Type | Description |
|---|---|
NotImplementedError
|
If |
Notes
Prior to 0.2.0 a :class:MultiLayerSoil with n ≥ 3 silently
fell through to the homogeneous kernel, returning incorrect
potentials, profiles, touch / step voltages and VTK exports.
The error is now raised explicitly so the regime is visible
rather than silent.
Source code in src/groundfield/solver/result.py
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 | |
summary ¶
Compact one-line description of the result.
Returns:
| Type | Description |
|---|---|
str
|
Human-readable summary listing the backend name, the number of frequencies, the number of electrodes for which potentials were stored and the number of discretised point sources. Intended for logging and notebook output; the format is informational and not stable across versions. |
Source code in src/groundfield/solver/result.py
PointSource ¶
Bases: BaseModel
A discretised point current source (segment midpoint).
Filled by the backend; not instantiated directly by the user.
solve_image ¶
Image-charge solver for homogeneous soil.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
world
|
'World'
|
World whose |
required |
engine
|
'Engine'
|
Engine configuration; relevant fields are |
required |
Source code in src/groundfield/solver/image.py
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 | |
solve_image_2layer ¶
solve_image_2layer(
world: "World",
engine: "Engine",
*,
max_terms: int = 100,
tol: float = 1e-06
) -> FieldResult
Image-charge solver for 2-layer soil (Tagg / Sunde).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
world
|
'World'
|
World whose |
required |
engine
|
'Engine'
|
Engine configuration. |
required |
max_terms
|
int
|
Maximum number of series terms. |
100
|
tol
|
float
|
Series truncation: stop as soon as \(|K|^n < \text{tol}\). |
1e-06
|
Returns:
| Type | Description |
|---|---|
FieldResult
|
Result object. :attr: |
Source code in src/groundfield/solver/image_2layer.py
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 | |
solve_mom ¶
solve_mom(
world: "World",
engine: "Engine",
*,
two_layer_max_terms: int | None = None,
two_layer_tol: float | None = None
) -> FieldResult
Galerkin Method-of-Moments backend.
Supports :class:HomogeneousSoil and :class:TwoLayerSoil. The
Green's-function kernel is taken from the matching image backend;
only the resolution scheme (per-segment Galerkin instead of
per-electrode average potential) differs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
world
|
'World'
|
World to evaluate. |
required |
engine
|
'Engine'
|
Engine configuration; |
required |
two_layer_max_terms
|
int | None
|
Truncation parameters for the Tagg/Sunde series, only used
when |
None
|
two_layer_tol
|
int | None
|
Truncation parameters for the Tagg/Sunde series, only used
when |
None
|
Returns:
| Type | Description |
|---|---|
FieldResult
|
Result object compatible with :class: |
Source code in src/groundfield/solver/mom.py
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 | |
solve_mutual_field ¶
solve_mutual_field(
world: "World",
engine: "Engine",
anchors: list[str],
field_points: np.ndarray,
*,
frequency_index: int = 0,
matrix_min_distance: float = 0.001,
matrix_max_terms: int = 100,
matrix_tol: float = 1e-06
) -> np.ndarray
Galvanic Green-function matrix: potential at arbitrary field points per node.
Returns R of shape (M, nG) with R[i, j] = potential at
field_points[i] (x, y, depth) under unit current (1 A) injected
into anchors[j] while all other clusters stay floating. This is the
off-diagonal field evaluation of :func:solve_mutual_matrix, generalised
to an arbitrary number of field points (decoupled from nG) and
without the self/diagonal term — the building block for the
frequency-dependent surface-potential distribution by superposition::
phi(field_points, f) = R @ I_leak(f)
with I_leak(f) = Y_G @ u(f) from the reduced network
(Y_L(f) + Y_G) u = i. Uses the same one-shot assembly as
:func:solve_mutual_matrix (reaction matrix and per-excitation leakage
columns built once); only the field-point evaluation is generalised. The
expensive 3D part is therefore frequency-independent and computed once, so
a frequency sweep over I_leak(f) is cheap.
world must already carry all nG grounding clusters (every
anchor in anchors must be a real electrode in world) and the soil
model. Any current source is ignored — the excitations are applied
internally, one cluster at a time, exactly as the historic per-excitation
loop did.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
world
|
'World'
|
Assembled world holding all |
required |
engine
|
'Engine'
|
Engine configuration. |
required |
anchors
|
list[str]
|
Length- |
required |
field_points
|
ndarray
|
|
required |
frequency_index
|
int
|
Index into |
0
|
matrix_min_distance
|
float
|
Truncation / clamp parameters of the field evaluation. The defaults
|
0.001
|
matrix_max_terms
|
float
|
Truncation / clamp parameters of the field evaluation. The defaults
|
0.001
|
matrix_tol
|
float
|
Truncation / clamp parameters of the field evaluation. The defaults
|
0.001
|
Returns:
| Name | Type | Description |
|---|---|---|
R |
(ndarray, shape(M, nG), complex)
|
Galvanic Green-function matrix; |
Raises:
| Type | Description |
|---|---|
ValueError
|
If |
KeyError
|
If an entry of |
NotImplementedError
|
If the soil is a |
TypeError
|
If the soil model type is not supported. |
See Also
solve_mutual_matrix : Full nG × nG mutual grounding-impedance matrix.
Source code in src/groundfield/solver/mutual.py
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 | |
solve_mutual_matrix ¶
solve_mutual_matrix(
world: "World",
engine: "Engine",
anchors: list[str],
probe_points: np.ndarray,
*,
frequency_index: int = 0,
symmetrize: bool = True,
matrix_min_distance: float = 0.001,
matrix_max_terms: int = 100,
matrix_tol: float = 1e-06
) -> np.ndarray
Full mutual grounding-impedance matrix Z_G in one assembly.
Reproduces the historic per-excitation construction (one
Engine.solve per gnode; diagonal from
:meth:FieldResult.cluster_impedance, off-diagonal from
:meth:FieldResult.potential at the probe points) bit-for-bit,
but assembles the segment reaction matrix and the probe-point field
kernel only once.
world must already carry all nG grounding clusters
(every anchor in anchors must be a real electrode in
world). It must not carry any current source — the
excitations are applied internally, one cluster at a time, exactly
as the historic loop did. Finite-impedance / distributed conductors
between distinct clusters are out of scope for the catalogue use
case (each gnode is an isolated galvanic cluster) and are handled
via the standard :func:_solve_cluster_currents machinery only in
so far as they remain confined to a single excited cluster.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
world
|
'World'
|
Assembled world holding all |
required |
engine
|
'Engine'
|
Engine configuration. |
required |
anchors
|
list[str]
|
Length- |
required |
probe_points
|
ndarray
|
|
required |
frequency_index
|
int
|
Index into |
0
|
symmetrize
|
bool
|
If |
True
|
matrix_min_distance
|
float
|
Truncation / clamp parameters of the off-diagonal field
evaluation. The defaults |
0.001
|
matrix_max_terms
|
float
|
Truncation / clamp parameters of the off-diagonal field
evaluation. The defaults |
0.001
|
matrix_tol
|
float
|
Truncation / clamp parameters of the off-diagonal field
evaluation. The defaults |
0.001
|
Returns:
| Name | Type | Description |
|---|---|---|
Z |
(ndarray, shape(nG, nG), complex)
|
The mutual grounding-impedance matrix. |
Source code in src/groundfield/solver/mutual.py
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 | |