Guide: Core erweitern — Regeln für folgende Sessions
Ziel
Neue Physik soll den Core erweitern, nicht projektspezifische Parallelmodelle erzeugen.
Vor jeder Änderung
- \
PHYSICS_CORE.md\lesen. - \
docs/README.md\lesen. - \
ROADMAP.md\prüfen. - aktuellen Branch/PR/CI-Status prüfen.
- im \
API_INDEX.md\suchen, ob die benötigte Funktion bereits existiert.
Wo gehört neue Logik hin?
Core
In den Core gehören:
- Differentialgleichungen,
- Material-/Zustandsgesetze,
- generische Randbedingungen,
- generische Zeit-/State-Updates,
- generische Postprocessing-Formeln,
- Bilanzierung,
- Mesh-/Solver-Infrastruktur.
Anwendung
In die Anwendung gehören:
- konkrete Geometrie,
- konkrete Randnamen,
- Projektszenarien,
- Auswahl von Core-Modulen,
- kalibrierte Parameter,
- Zuordnung von Deposit zu konkreter Öffnung.
Neue Physik: Mindestumfang
Jedes neue PhysicsModule braucht:
- klar benannte Gleichung,
- definierte Felder und Einheiten,
- \
required_fields()\, - \
equation_fields()\, - benötigte Materialeigenschaften,
- Space-Validierung,
- Elementbeitrag,
- Serialisierung wenn möglich,
- fokussierte Unit-/Manufactured Tests.
Validierung
Mindestens:
- Stoff-/Materialgesetz separat testen.
- kleine analytische oder manufactured Lösung.
- Bilanz prüfen.
- gekoppelte Regression wenn relevant.
- QoI-Meshkonvergenz.
- Grenzen/Unsupported Regimes explizit dokumentieren.
Dokumentationspflicht
Wenn öffentliche API geändert wird:
- \
docs/API_INDEX.md\aktualisieren, - passende Guide-Seite aktualisieren,
- passende Reference-Seite aktualisieren,
- \
PHYSICS_CORE.md\bei Architektur-/Physikänderung aktualisieren, - HTML-Human-Doku aktualisieren.
Der CI-Dokumentationstest soll verhindern, dass neue öffentliche Exporte ohne Index auftauchen.
CI-Regel
Normale PRs:
- kurzer FEM-Core-Testblock,
- keine Saison-CFD,
- keine großen Mesh-Sweeps,
- keine Floorplan-Benchmarks.
Lange Rechnungen:
- lokal,
- dedizierter/self-hosted Runner,
- Ergebnis anschließend als JSON/HTML publizieren.
Qualitätssatz
Ein konvergierter Solver allein macht kein belastbares Engineering-Ergebnis. Entscheidend sind Gleichungsvalidierung, Bilanzschluss, Parameterherkunft und QoI-Meshkonvergenz.