Airbox outer-boundary closure¶
Last changes: Documentation changelog
Physical problem¶
The mesher marks non-periodic outer airbox faces as Gamma_out; study.demag(...) separately authors the physical model. A closed mesh surface is not proof of an open-boundary closure.
Governing equations¶
Symbols and SI units¶
Symbol |
Meaning |
SI unit |
|---|---|---|
\(\Gamma_{\mathrm{out}}\) |
non-periodic outer airbox surface |
\(\mathrm{m^2}\) |
\(\partial\Omega_a\) |
boundary of auxiliary airbox domain |
\(\mathrm{m^2}\) |
\(\Gamma_{\mathrm{periodic}}\) |
outer faces assigned periodic pairing |
\(\mathrm{m^2}\) |
Assumptions and validity¶
AirboxOptions.boundary_marker is a Gmsh tag with default 99; it does not expose a Robin
coefficient. OCC first selects outer min/max surfaces for periodic pairing, assigns paired-face
physical groups, and removes those paired tags from the faces later assigned to Gamma_out.
The invalid state is simultaneous ordinary-outer and periodic ownership of one face. A solved
system can still have truncation error.
Solver lane |
Status |
Limit |
|---|---|---|
FEM CPU |
source-backed |
No runtime closure result is claimed. |
FEM GPU |
capability-gated |
No GPU closure receipt is claimed. |
FDM CPU |
not applicable |
FEM shared-domain marker contract. |
FDM GPU |
not applicable |
FEM shared-domain marker contract. |
Python API¶
# %%
import fullmag as fm
nm = 1e-9
study = fm.study("airbox_boundary")
study.engine("fem")
study.device("cpu", precision="double")
study.mode("strict")
study.universe(mode="manual", size=(600 * nm, 400 * nm, 200 * nm))
# %%
study.universe.mesh(maximum_element_size=80 * nm, minimum_element_size=10 * nm)
body = study.geometry(fm.Box(size=(200 * nm, 100 * nm, 10 * nm), name="film"), name="film")
body.mesh(maximum_element_size=8 * nm, minimum_element_size=4 * nm, order=1)
body.Ms = 800e3
body.Aex = 13e-12
body.m = fm.texture.uniform(1.0, 0.0, 0.0)
# %%
study.demag(model="airbox", variant="robin")
study.build_domain_mesh()
study.stages.add_relax(stage_id="equilibrium", algorithm="llg_overdamped", max_steps=1000)
Python |
Type |
Default |
SI unit |
Validation |
Meaning |
Backend support |
ProblemIR |
|---|---|---|---|---|---|---|---|
|
|
|
\(1\) |
direct dataclass field; mesh-group allocation avoids collisions |
Gmsh tag for |
FEM authoring and mesh metadata are source-backed; runtime lane requires separate qualification; FDM not applicable |
|
|
|
|
\(1\) |
coerced with |
demag enablement |
Authoring/lowering contract only; runtime depends on the resolved realization and a separately qualified lane |
|
|
|
|
\(1\) |
|
canonical demag model |
Authoring vocabulary only; |
|
|
|
|
\(1\) |
With |
airbox closure variant |
Authoring/lowering contract only; runtime depends on the resolved realization and a separately qualified lane |
|
|
|
|
\(1\) |
Exact string membership; accepts |
legacy realization request |
Authoring/lowering contract only; runtime depends on the resolved realization and a separately qualified lane |
|
Demagnetization branch precedence and legacy vocabulary¶
The constructor separates authored intent from resolved realization in this exact order:
Authored state |
Validation and lowering |
Resolved consequence |
|---|---|---|
|
Rejected as mutually exclusive before either model or legacy realization is selected. |
No realization is produced. |
|
The model branch validates |
|
|
The legacy realization branch runs before standalone-variant validation. It checks exact membership in |
The exact legacy value is lowered through the alias table below. |
|
Rejected because no branch owns the variant. |
No realization is produced. |
Accepted legacy authored realization (exact string) |
Resolved realization |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Any other exact legacy realization is rejected; values such as " BEM " and "BEM" are not accepted. These tables establish Python validation and lowering, not runtime availability. In particular, Demag(model="bem") is accepted vocabulary but BEM is explicitly future/unimplemented in the current Python source; fmm acceptance likewise does not qualify a runtime lane.
ProblemIR¶
The marker is generated mesh data. study.demag(...) first constructs Demag, then coerces
enabled with bool and stores Demag._resolved_realization(). Canonical mappings are
airbox/auto -> poisson_robin, airbox/robin -> poisson_robin,
airbox/dirichlet -> poisson_dirichlet, and each non-airbox model with implicit auto maps to
its model name. Legacy aliases use exact-key lookup: poisson_airbox and airbox_robin map to
poisson_robin, and airbox_dirichlet maps to poisson_dirichlet; no whitespace or case
normalization is applied.
Round-trip and failure semantics¶
Requested intent is airbox mesh plus enabled, model, variant, or legacy realization.
Resolved execution contains disjoint outer/periodic marker data and a canonical demag
realization. Validation errors include model with realization, variant without model,
an airbox variant outside the supported set, any variant on a non-airbox model, invalid legacy
vocabulary, invalid mesh generation, or missing required shared-domain air. Unsupported
combinations include retaining one face simultaneously as ordinary outer and periodic, or
interpreting a marker as a physical equation.
In validator vocabulary, unsupported combinations are rejected rather than lowered to a fallback.
Discrete realization¶
The OCC path assigns periodic physical surfaces first, then adds remaining gamma_out faces using boundary_marker and name Gamma_out; interface faces are separate.
Implementation mapping¶
Responsibility |
Repository path |
Stable symbol |
|---|---|---|
marker default |
||
periodic marker allocation |
||
periodic exclusion |
||
demag authoring |
Validation¶
Inspect outer and interface facets, markers, and periodic-face exclusion; then run an outer-distance and mesh-refinement study. No runtime, coefficient, or parity proof is supplied.
Limitations¶
The marker default is not a global uniqueness proof and no public coefficient API is exposed.
Scientific bibliography¶
C. Abert, European Physical Journal B 92 (2019), doi:10.1140/epjb/e2019-90599-6.
Source-code index¶
Claim |
Repository path |
Stable symbol |
Evidence |
|---|---|---|---|
marker default |
source-backed |
||
periodic groups |
source-backed |
||
outer pairing |
source-backed |
||
canonical realization validation/lowering |
source-backed |
||
direct demag request |
Public |