Skip to documentation content
On this page
  1. Reference contract
  2. Authoritative source

Magnetics

Defines optimization applicability and derivative ownership for Magnetics.

Reference contract

FieldValueDescription
kindMagnetics
namespacemg
statusdevelopment
visiblefalse
optimizationContract{"baseStudies":["stationary"],"certificationFixture":"tests/python_backend/test_differentiable_physics_contract.py::test_builtin_physics_optimization_contract_gate","contributionBindings":[{"certificationFixture":"tests/python_backend/test_differentiable_physics_contract.py::test_builtin_physics_optimization_contract_gate","contribution":"domain-feature:Current Density","runtimeOwner":"Magnetics.element_residual"},{"certificationFixture":"tests/python_backend/test_differentiable_physics_contract.py::test_builtin_physics_optimization_contract_gate","contribution":"domain-feature:Permanent Magnet","runtimeOwner":"Magnetics.element_residual"},{"certificationFixture":"tests/python_backend/test_differentiable_physics_contract.py::test_builtin_physics_optimization_contract_gate","contribution":"boundary-feature:Magnetic Vector Potential","runtimeOwner":"Magnetics.element_residual"},{"certificationFixture":"tests/python_backend/test_differentiable_physics_contract.py::test_builtin_physics_optimization_contract_gate","contribution":"boundary-feature:Magnetic Flux","runtimeOwner":"Magnetics.element_residual"},{"certificationFixture":"tests/python_backend/test_differentiable_physics_contract.py::test_builtin_physics_optimization_contract_gate","contribution":"weak-contribution:mg.vector_potential","runtimeOwner":"Magnetics.element_residual"}],"functionalReductions":["integral","average","minimum","maximum","rms","norm","smooth-maximum","smooth-minimum","value"],"geometricModes":{"coordinate":{"applicability":"required","reason":""},"materialTopology":{"applicability":"required","reason":""}},"historyFields":[],"objectiveRules":[{"entityDimensions":["global","domain","boundary","point"],"modes":["stationary"],"operators":["integral","average","minimum","maximum","rms","norm","smooth-maximum","smooth-minimum"],"supportsSelection":true,"symbols":["mg.Az"],"valueKind":"field"},{"entityDimensions":["global"],"modes":["stationary"],"operators":["value"],"supportsSelection":false,"symbols":["mg.energy"],"valueKind":"scalar-global"},{"entityDimensions":["global"],"modes":["stationary"],"operators":["value"],"supportsSelection":false,"symbols":["mg.compliance"],"valueKind":"scalar-global"}],"objectiveSymbols":["mg.Az","mg.energy","mg.compliance"],"requiredDerivativeChannels":["parameter","input","coordinate","material"],"role":"spatial-analysis","runtimeProvider":"Magnetics.element_residual","schemaVersion":"1.0.0","stateFields":["Az"]}
governingEquations[{"description":"","differentiability":"exact-ad","editor":null,"entityDimension":"domain","latex":"-\\nabla\\cdot\\left(\\nu\\nabla A_z\\right)=J_z","mathml":"<math display=\"block\"><mrow><mo>-</mo><mi>div</mi><mo>(</mo><mi>nu</mi><mi>grad</mi><mo>(</mo><msub><mi>A</mi><mi>z</mi></msub><mo>)</mo><mo>)</mo><mo>=</mo><msub><mi>J</mi><mi>z</mi></msub></mrow></math>","name":"Magnetic vector-potential equation","readOnly":true,"section":"governing-equation"},{"description":"","differentiability":"exact-ad","editor":null,"entityDimension":"domain","latex":"\\mathbf B=\\nabla\\times\\mathbf A","mathml":"<math display=\"block\"><mrow><mi>B</mi><mo>=</mo><mi>curl</mi><mo>(</mo><mi>A</mi><mo>)</mo></mrow></math>","name":"Magnetic flux density","readOnly":true,"section":"definition"}]

The runtime provider, evidence fixture, derivative channels, geometric modes, objective symbols, reductions, contribution bindings, and governing equations are generated from the physics catalog.

Authoritative source

Catalog
telion_backend.v2.catalog.PhysicsCatalog
Identity
PhysicsDeclaration/mg/optimizationContract
Path
src/telion_backend/v2/physics/specs.py
Symbol
DifferentiablePhysicsContract