SimiLie
Loading...
Searching...
No Matches
magnetodynamics.py
1#!/usr/bin/env python3
2# SPDX-FileCopyrightText: 2026 Baptiste Legouix
3# SPDX-License-Identifier: AGPL-3.0-or-later
4# AI-GENERATED
5
6"""Magnetic-only Hamiltonian sector and ideal/resistive MHD coupling.
7
8H(B)=B.B/(2 mu), H_field=delta H/delta B. Faraday evolves B from
9an Ohm-law electric field; no independent electric displacement is stored.
10"""
11
12import argparse
13import importlib.util
14import sys
15from pathlib import Path
16
17from sympy import Matrix, diff, symbols
18
19
21 @staticmethod
22 def __call__():
23 # Use the project's Hamiltonian generator rather than a fluid Hamiltonian.
24 from similie_generate_cpp_hamiltonian import HamiltonianDefinition
25
26 potential = symbols("potential")
27 induction = symbols("B0:3")
28 permeability = symbols("permeability", positive=True)
29 return HamiltonianDefinition(
30 namespace="similie::physics::magnetodynamics",
31 struct_name="MagnetodynamicsHamiltonian",
32 parameters=["permeability"],
33 hamiltonian=sum(b**2 / (2 * permeability) for b in induction),
34 variables=[potential, induction],
35 is_linear=True,
36 )
37
38
40 """Local expressions; exterior supplies every curl/divergence operation."""
41
42 def __init__(self):
43 self.induction = Matrix(symbols("B0:3"))
44 self.velocity = Matrix(symbols("u0:3"))
45 self.current = Matrix(symbols("J0:3"))
46 self.permeability = symbols("mu", positive=True)
47 self.hamiltonian = self.induction.dot(self.induction) / (2 * self.permeability)
48 self.magnetic_field = Matrix(
49 [diff(self.hamiltonian, b) for b in self.induction]
50 )
52 self.ohm_electric_field = -self.velocity.cross(self.induction)
53 self.lorentz_force = self.current.cross(self.induction)
55 self.magnetic_energy * Matrix.eye(3)
56 - self.induction * self.magnetic_field.T
57 )
59
60 @property
61 def poynting_flux(self):
62 return self.ohm_electric_field.cross(self.magnetic_field)
63
64 @property
66 return self.current.dot(self.ohm_electric_field)
67
68
70 def __init__(self):
71 super().__init__()
72 self.resistivity = symbols("eta", nonnegative=True)
73 self.ohm_electric_field += self.resistivity * self.current
75
76
77def generate(output):
78 generator_path = Path(__file__).resolve().parents[1] / "generate_cpp_hamiltonian.py"
79 spec = importlib.util.spec_from_file_location(
80 "similie_generate_cpp_hamiltonian", generator_path
81 )
82 module = importlib.util.module_from_spec(spec)
83 sys.modules[spec.name] = module
84 spec.loader.exec_module(module)
85 output = Path(output)
86 output.parent.mkdir(parents=True, exist_ok=True)
87 module.generate_cpp_hamiltonian(MagnetodynamicsHamiltonian, output)
88 # The generic generator predates the annotation rule; annotate this output.
89 text = output.read_text()
90 text = text.replace(
91 "struct MagnetodynamicsHamiltonian",
92 "/** Magnetic energy density; derivatives give H_field.\n"
93 " * Faraday's native exterior derivative and Ohm law supply evolution.\n"
94 " * \\important This operator and documentation is fully AI-generated.\n"
95 " */\nstruct MagnetodynamicsHamiltonian",
96 1,
97 )
98 output.write_text(text)
99
100
101def generate_model(output):
102 path = Path(__file__).resolve().parents[1] / "generate_cpp_field_model.py"
103 spec = importlib.util.spec_from_file_location("similie_field_model_generator", path)
104 module = importlib.util.module_from_spec(spec)
105 spec.loader.exec_module(module)
106 module.generate_field_model(
107 Magnetodynamics(), Path(__file__).with_suffix(".hpp.in"), output
108 )
109
110
111if __name__ == "__main__":
112 parser = argparse.ArgumentParser(description=__doc__)
113 parser.add_argument("--output", type=Path, required=True)
114 parser.add_argument("--model-output", type=Path)
115 arguments = parser.parse_args()
116 generate(arguments.output)
117 if arguments.model_output:
118 generate_model(arguments.model_output)