Skip to content

LineCableModels 0.1.0 - #69

Merged
amaurigmartins merged 31 commits into
mainfrom
release/v0.1.0-engine
Nov 3, 2026
Merged

amaurigmartins merged 31 commits into
mainfrom
release/v0.1.0-engine

Conversation

@amaurigmartins

Copy link
Copy Markdown
Member

Summary

LineCableModels 0.1.0, the first registered version. It adds the formula layer of the engine and, on it,
the formulas of the earth return, the earth properties and the dielectrics.

  • Each formula is a callable of its family, selected per slot of CoaxialFormulation or FEM by its
    identifier, its options or the formula object.
  • Earth-return impedances and potential coefficients by the unified formulation :martins2026.
  • Classical earth-return formulas of Carson, Pollaczek, Wise, Gary, Wedepohl and Wilcox, Saad,
    Papadopoulos, Xue, Lucca and Ametani, selected per domain of a cable pair.
  • The macro @formulation, with the tags @air, @earth and @mixed, writes a formulation as a block.
  • Layered earth models, with nine soil laws for the frequency dependence of each layer and two models of
    an equivalent homogeneous earth.
  • The lossy dielectric law and the closed forms of Wedepohl and Wilcox for the internal impedance.
  • The finite-element backend runs GetDP from getdp_jll, loaded with using Gmsh, getdp_jll.

Checks

  • Pkg.test(): 4 575 tests without the FEM cases and 6 056 with them, on x86_64 Linux.
  • The documentation builds with checkdocs = :public, and its environment resolves from no Manifest.
  • Vale reports 0 errors and cspell 0 issues on the maintained files and the rendered pages.

Note

Project.toml takes getdp_jll from github.com/amaurigmartins/getdp_jll.jl through [sources] until
General registers the JLL. The registration of 0.1.0 follows it.

Let the Val guard take a literal tag after a formula type as the callee
of a method. Count such a method as physics of the formula in the
registry guard, which now refuses a formula identified by the router
symbol.

Keep the case of a one-letter piece in the chunker, so that two symbols
that differ by case are two terms. The fields Z and Y of the line
parameters are then their own symbols.

Extend the planted and clean probes of the three guards, and state on the
rules page that the router selects no formula.
Hold the complex path in SpectralIntegral. Its constructor chooses the
path and writes the breakpoints. The integrate method maps the coordinate
and applies the Jacobian, and the kernels of the unified formula take the
spectral coordinate. This removes ray! and the points keyword.

Add Λ, the direct and image mean of the earth-return family, public in
Engine and at the root, with its methods on the family formula. The
unified formula applies its source-column scaling to the value of Λ. That
reorders floating-point products. Zg, Pg, Z and Y move by at most 9.6e-16
of the largest diagonal entry. Zin and Pin stay bitwise.

Move the term points to the Gmsh extension, its one user now.
Write each expression of the cable formulas and the laws as a method of
its own formula type, with the symbols of its docstring. The recipes and
the Gmsh model call the formula.
The functions impedance, resistivity and properties leave Engine and the
root, and admittivity stays as the recipe by class on the formulation.

Return an earth layer from the earth law, so that a model of the
equivalent earth reads the layers that the law describes. The
finite-element model stores those layers per frequency.
Rename the unified formula to martins2026 and split its physics from its
bookkeeping. Each integrand is a tagged method of the formula in the
spectral coordinate, and to_buffer! moves the terms of the paper into the
block of the formula, keyed by the symbols of its docstring. This removes
prepare!, and from_buffer returns the block.

Add the recipe of the earth step on the formulation. It fills Zg and Pg
pair by pair from the variants of the formula, and no formula writes a
matrix. The shunt step takes the buffers.

Add the ideal formula, the images of an earth without losses, as a formula
of one quantity beside martins2026.
Hold the earth slots as records of a formula per domain of a pair. The
recipes of the earth step take an arm per domain. One selection fills the
three domains, and a selection per domain leaves the others to the
default.

Lift every slot through one select tagged by the slot. The default of a
slot is one method, and the symbol default resolves to it at construction.
Compute the distinct formulas once and store them in the formulation.

Add the slot equivalent_earth with the bottommost model. The law describes
each layer, and the model reduces the described layers to one.
Rewrite the rules, architecture, guide and theory pages for the layer. The
physics of a formula is its callable, and the formulation assembles the
matrices. One select routes every slot, and each earth slot records a
formula per domain of a pair. Add the symbols and the identifier rule to
the conventions, and the paper to the bibliography.

Move the call forms of the callables to the Formulas block of each family.
Julia keys the docstring of a callable by its argument types alone. Its
signature does not render, and two formulas of one family share one text.
The mean was real on its logarithmic limits and complex elsewhere. Its
type followed the value of an argument. Return a complex number on every
branch, and the same from the variants of the ideal formula.

Tie the interface kernels to the averaged correction of the paper in the
docstring of the family.
An earth model takes any number of finite layers above its semi-infinite
last layer. The law describes the earth layers, the air passes, and the
model reduces the described layers to the one earth the formulas read.
FEM gains the slot equivalent_earth, and the Gmsh model reads that earth.

Refuse a nonzero longitudinal wavenumber for an earth formula that does
not read it, because a result records its formulation.
The capped real stretch ends the air PML at 100 half-widths and truncates
the field that a buried source transmits into air. The voltage of a
conductor in air integrates that field. So the cap applies only when every
conductor lies below the interface.

Regenerate the FEM rows of the overhead and mixed references at e41bba13.
The insulation and semicon admittance families gain :lossy. Its real part
holds the conduction of rho and the polarization loss of tan_delta, and its
imaginary part the displacement current of :lossless. No slot selects it by
default, and every reference keeps its values.
The internal impedance family gains :wedepohl1973: a thin tube by equations
(4) to (6) of the paper, a solid conductor by its equation (3). A computation
warns on a tube beyond the bound of the paper. No slot selects the new formula
by default, and every reference keeps its values.
Soil layers gain the laws of the literature, with the parameters of each
source as options. A computation warns when its scan leaves the stated range
of its law. The default law is still :constant, and every reference keeps its
values.
The public constants take the symbols of the equations, which pair with
mu_r and eps_r in the code. Their values and every result are unchanged.
A layered earth reduces to one layer by the equivalent conductivity of
Martins-Britto or the equivalent propagation constant of Xue. A layer takes
any finite relative permittivity, since the second is negative where the
stack is inductive. A finite-element computation now validates the problem
against its formulas, as a coaxial one does.
The impedance of overhead conductors by the complex depth of Gary, and of
buried conductors by Wedepohl and Wilcox and by Saad. A formula now declares
the pairs it treats, and a computation refuses one placed where it treats
none. Gary and Saad refuse a magnetic earth, and Wedepohl warns outside its
bound. The default formulas and the references are unchanged.
The mutual impedance of an overhead and a buried conductor by Lucca and by
Ametani. Each takes the mixed place of the slot, and both refuse a magnetic
earth. The default formulas and the references are unchanged.
A block of keyword lines writes a formulation, and tags select per domain.
The macros lower to the constructor and do not add a capability. The default
formulas and the references are unchanged.
The correction integral of Carson for overhead conductors, on the path of
the spectral integral. It refuses a magnetic earth, and a test holds it to the
series of the paper. The default formulas and the references are unchanged.
The Green functions of Pollaczek for buried and mixed pairs, on the spectral
path. The formula gives the impedance alone and refuses a magnetic earth. The
default formulas and the references are unchanged.
The buried earth return of Papadopoulos, with impedance and potential
coefficients on the spectral path. The direct and image term takes the closed
form of the paper. The default formulas and the references are unchanged.
The overhead impedance of Wise 1934 and the overhead potential coefficients
of Wise 1948. Both run on the spectral path, and each formula refuses a
magnetic earth. The default formulas and the references are unchanged.
The buried impedance and potential coefficients of Xue, on the spectral path.
The prescribed longitudinal constant replaces the modal one, and the voltage
refers to infinite depth. The default formulas and the references are unchanged.
The input gives the layer of each cable, and the pairs that a formula treats
are conditions on layer values. The base buffers give the complex conductivity
and the permeability of each medium. The results are bitwise unchanged.
They take the words of the blueprint, and a layer in the input is one of the
earth. The noun layers moves to the lexicon of Earth, its one user. The results
are bitwise unchanged.
The formula-level initialize_buffers takes no problem, and the shunt recipe
potential! takes no buffers, since no formula reads them. The results are
bitwise unchanged.
The home page and the README list the classical earth-return formulas.
They also list the earth models and the lossy dielectric law. The theory
and guide pages give the domain of each earth-return formula and a
layered earth. Project.toml and CITATION.cff take the version 0.2.0.
The documentation environment takes the package from the repository at
version 0.2.0. Its compat entry for the package reads 0.2.
The extension runs GetDP from getdp_jll, taken from an interim
repository until General has it. The register loses GetdpBinary, and
the lexicon loses the nouns getdp and binary. The formulation tests of
main take the layer of this branch, and CI runs on pushes of the branch.
The package admits DocStringExtensions 0.10 and JET 0.13, and the
documentation admits CSV 1. The FEM transposition test holds the identity
to the round-off of the solve on every platform.
The wires of two_bare_wires on a layered earth get a frozen file at 1 kHz.
It gives analytical and FEM rows under the equivalent earth xue2021, and a
test checks both. The tests check a result after compute as a
LineParameters record, and the README and the home page say what both
backends return.
The package and its citation file read 0.1.0, and the documentation
environment admits it. CI runs on pushes of release/v0.1.0-engine.
@codecov

codecov Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 99.73166% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 99.32%. Comparing base (dec1ddf) to head (4dc0a35).

Files with missing lines Patch % Lines
src/engine/earthreturn/martins2026.jl 98.36% 3 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #69      +/-   ##
==========================================
+ Coverage   98.93%   99.32%   +0.39%     
==========================================
  Files          45       72      +27     
  Lines        2714     3548     +834     
==========================================
+ Hits         2685     3524     +839     
+ Misses         29       24       -5     
Flag Coverage Δ
fem-macos-15-intel 99.32% <99.73%> (+0.35%) ⬆️
fem-macos-latest 99.32% <99.73%> (+0.35%) ⬆️
fem-ubuntu-latest 99.32% <99.73%> (+0.35%) ⬆️
fem-windows-latest 99.32% <99.73%> (+0.35%) ⬆️
macos-15-intel 82.93% <99.73%> (+7.64%) ⬆️
macos-latest 82.93% <99.73%> (+7.64%) ⬆️
ubuntu-latest 82.93% <99.73%> (+7.64%) ⬆️
windows-latest 82.93% <99.73%> (+7.64%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...t/LineCableModelsGmshExt/LineCableModelsGmshExt.jl 100.00% <100.00%> (ø)
ext/LineCableModelsGmshExt/getdp.jl 97.90% <100.00%> (+0.40%) ⬆️
ext/LineCableModelsGmshExt/model.jl 100.00% <100.00%> (ø)
ext/LineCableModelsMeasurementsExt.jl 100.00% <ø> (ø)
src/earth/Earth.jl 100.00% <100.00%> (ø)
src/engine/Engine.jl 100.00% <100.00%> (ø)
src/engine/assembly.jl 100.00% <100.00%> (ø)
src/engine/compute.jl 100.00% <100.00%> (+2.73%) ⬆️
src/engine/earthproperties/EarthProperties.jl 100.00% <100.00%> (ø)
src/engine/earthproperties/alipio2014.jl 100.00% <100.00%> (ø)
... and 44 more
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@amaurigmartins
amaurigmartins merged commit 17b5051 into main Nov 3, 2026
23 checks passed
@github-project-automation github-project-automation Bot moved this from TODO to Done in LineCableModels.jl Nov 3, 2026
@amaurigmartins
amaurigmartins deleted the release/v0.1.0-engine branch November 3, 2026 08:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant