FEM Core API Index
Stand: femcore 0.13-dev. Dieser Index ist Layer 1 der Doku: jedes öffentliche Symbol aus femcore bekommt genau einen Kurzsatz. Für Verwendung, Gleichungen, Beispiele und Grenzen siehe die verlinkten Funktionsbereiche in [README.md](README.md).
Model, Mesh & DOFs
Model— Container für Geometrie, Felder, Materialien, Domänen, Physik, Randbedingungen und Solver-Konfiguration.Domain— Ordnet einer Elementdomäne eine ID, einen Namen und ein Material zu.SolverSettings— Konfiguriert linearen Solver, Assembly-Backend, Toleranzen und Iterationslimit.Field— Beschreibt ein skalares oder vektorielles P1/P2-FEM-Feld.FunctionSpace— Verwaltet lokale/globale Freiheitsgrade eines Feldes auf einem Mesh.MeshTopology— Erzeugt und verwaltet Kanten-Topologie für P2-Freiheitsgrade.MixedDofManager— Verwaltet mehrere gekoppelte Funktionsräume und deren globale DOF-Offsets.Material— Sammlung benannter Materialeigenschaften für eine Domäne.ConstantProperty— Konstante Materialeigenschaft mit einheitlicher Evaluate-/Serialisierungs-Schnittstelle.Mesh— Knoten-, Element-, Domänen- und Randdaten eines TRI3- oder TET4-Netzes.BoundaryEntity— Ein einzelnes Randsegment bzw. eine Randfläche eines Meshes.rectangular_tri_mesh— Erzeugt ein gleichmäßig unterteiltes 2D-Rechtecknetz aus TRI3-Elementen.box_tet_mesh— Erzeugt ein strukturiertes 3D-Quadernetz aus TET4-Elementen.rectangular_tri_mesh_coordinates— Erzeugt ein 2D-TRI3-Netz aus expliziten x-/y-Koordinatenlinien.boundary_layer_coordinates— Erzeugt gestreckte 1D-Koordinaten zur Randverfeinerung.boundary_layer_rectangular_tri_mesh— Erzeugt ein 2D-Rechtecknetz mit steuerbarer Randverfeinerung.
Physics & analyses
PhysicsModule— Abstrakte Basisschnittstelle aller physikalischen Elementbeiträge.HeatConduction— Löst stationäre isotrope Wärmeleitung mit optionaler volumetrischer Wärmequelle.StokesFlow— Löst stationäre inkompressible Stokes-Strömung mit Taylor-Hood P2/P1.NavierStokesFlow— Löst stationäre inkompressible Navier-Stokes-Strömung per Picard/Oseen-Linearisierung.HeatAdvectionDiffusion— Löst Wärmeadvektion und -diffusion bei konstanter Dichte, optional mit SUPG.BoussinesqBodyForce— Fügt eine Boussinesq-Auftriebskraft aus dem Temperaturfeld in die Impulsgleichung ein.LowMachMoistAirFlow— Variable-Dichte-Low-Mach-Navier-Stokes für feuchte Luft mit div(rho*u)=0.VariableDensityHeatAdvectionDiffusion— Wärmeadvektion/-diffusion mit derselben lokalen Feuchtluftdichte wie die Low-Mach-Strömung.HumidityRatioTransport— Löst den konservativen Transport des Feuchteverhältnisses w mit Advektion und Diffusion.LinearStationaryAnalysis— Löst ein lineares stationäres FEM-Modell und erzeugt Result/Bilanzen.PicardNavierStokesAnalysis— Iteriert stationäre Navier-Stokes-Gleichungen per Picard-Verfahren.SegregatedNaturalConvectionAnalysis— Koppelt Navier-Stokes, Wärme und optional Boussinesq-Auftrieb segregiert.NaturalConvectionContinuation— Führt mehrere Natural-Convection-Modelle mit Zustandsweitergabe als Continuation aus.SegregatedLowMachThermalAnalysis— Gekoppelter segregierter Solver für Low-Mach-Strömung, Temperatur und optional Feuchte.
Boundary conditions
DirichletBC— Setzt einen Feldwert stark auf einer benannten Randfläche.NeumannBC— Setzt einen konstanten natürlichen Fluss/Heat-Input auf einer Randfläche.RobinBC— Koppelt einen Feldwert linear an einen Reservoir-/Umgebungswert.PointValueBC— Fixiert einen einzelnen skalaren Freiheitsgrad, z. B. als Druckreferenz.PressureTractionBC— Setzt einen externen Druck als schwache Traction auf einer offenen Grenze.PorousOpeningBC— Modelliert reversiblen quadratischen Druckverlust durch Lochblech/Gitter mit freiem Flächenanteil.ThermalReservoirBC— Setzt Reservoirtemperatur nur auf Einströmung einer reversiblen Öffnung.AdvectiveReservoirBC— Setzt einen generischen Skalarwert nur auf Einströmung einer reversiblen Öffnung.SurfacePhaseChangeBC— Koppelt Oberflächen-Phasenwechsel gleichzeitig an Feuchte- und Energiebilanz.
Thermodynamics & pressure
DRY_AIR_GAS_CONSTANT— Spezifische Gaskonstante trockener Luft.WATER_VAPOUR_GAS_CONSTANT— Spezifische Gaskonstante von Wasserdampf.HUMIDITY_RATIO_EPSILON— Molverhältnis-Konstante 0,621945 für psychrometrische Umrechnungen.STANDARD_PRESSURE— Standard-Thermodynamikdruck 101325 Pa.MoistAirState— Zusammengefasster psychrometrischer Zustand aus T, p, RH, Dampfdruck, w und Dichte.MoistAirDensityModel— Wiederverwendbares Low-Mach-Zustandsgesetz rho(T,w,p) mit Continuation-Faktoren.humidity_ratio_from_vapor_pressure— Rechnet Wasserdampf-Partialdruck in Feuchteverhältnis kg/kg trockene Luft um.moist_air_density— Berechnet Feuchtluftdichte aus Temperatur, relativer Feuchte und Druck.moist_air_density_derivatives_from_humidity_ratio— Liefert rho sowie exakte Ableitungen d(rho)/dT und d(rho)/dw bei konstantem Druck.moist_air_density_field— Vektorisierte Feuchtluftdichte aus Temperatur-, w- und Druckfeldern.moist_air_density_from_humidity_ratio— Berechnet Feuchtluftdichte direkt aus Temperatur und Feuchteverhältnis.moist_air_density_from_vapor_pressure— Berechnet Feuchtluftdichte direkt aus Wasserdampf-Partialdruck.moist_air_state— Erzeugt einen vollständigen MoistAirState aus T, RH und p.reduced_hydrostatic_pressure— Berechnet reduzierten hydrostatischen Druck relativ zu einer Referenzdichtesäule.vapor_pressure_from_humidity_ratio— Rechnet Feuchteverhältnis in Wasserdampf-Partialdruck um.LinearPressureProfile— Serialisierbares lineares Druckfeld p(x)=p_ref+grad(p)·(x-x_ref).reduced_hydrostatic_pressure_gradient— Berechnet den Gradienten des reduzierten hydrostatischen Drucks aus Dichten und g.reduced_hydrostatic_pressure_profile— Erzeugt direkt ein lineares reduziertes hydrostatisches Druckprofil.ThermofluidScaling— Container für Re-, Pr-, Gr-, Ra-Zahlen und Boussinesq-Dichtevariation.thermofluid_scaling— Berechnet dimensionslose Kennzahlen für einen Thermofluid-Fall.
Thermal layers & surfaces
ThermalLayer— Eine homogene 1D-Wärmeleit-Schicht mit Dicke und Wärmeleitfähigkeit.ThermalLayerStack— Fasst mehrere 1D-Widerstände zu Gesamtwiderstand/Leitwert und optionaler Robin-BC zusammen.SurfaceThermalReport— Flächengewichtete Temperatur- und Wärmestromkennwerte einer benannten Oberfläche.surface_temperature_values— Liefert Koordinaten und P1-Temperaturen aller Knoten einer benannten Oberfläche.surface_thermal_report— Ermittelt Fläche, Tmin/Tmean/Tmax und expliziten Robin-Wärmestrom einer Oberfläche.EnergyBalance— Strukturierte stationäre Energiebilanz einer Wärmeleitungsrechnung.
Phase change, deposits & openings
LATENT_HEAT_VAPORIZATION— Screening-Wert der Verdampfungs-/Kondensationsenthalpie von Wasser.LATENT_HEAT_SUBLIMATION— Screening-Wert der Sublimations-/Resublimationsenthalpie von Eis.SurfacePhaseChangeLaw— Allgemeines Stoffübergangsgesetz Wasserdampf↔Oberfläche mit Sättigung und Latentwärme.SurfacePhaseChangeReport— Integrierte Massen-/Latentwärmerate und Flussstatistik einer Phasenwechseloberfläche.SurfaceDepositState— Zustand einer Ablagerung als Masse pro Fläche plus Dichte und daraus resultierende Dicke.surface_phase_change_entity_fluxes— Berechnet mittlere Phasenwechsel-Massenflüsse je Randelement.advance_surface_deposit_from_phase_change— Fortschreibt einen Deposit-State explizit aus gelöstem Phasenwechsel-Massenfluss.surface_phase_change_report— Integriert Phasenwechsel-Massen- und Latentwärmeraten über eine Oberfläche.CircularPerforationGeometry— Homogenisiertes Lochblechmodell mit radial wachsender Ablagerung an Kreisöffnungen.SlotOpeningGeometry— Homogenisiertes Schlitzmodell mit beidseitig wachsender Ablagerung.OpeningBlockageState— Bericht über effektive freie Fläche, Blockadegrad und vollständigen Verschluss.opening_blockage_state— Mappt Deposit-Dicke auf effektive Öffnungsfläche und Verschlussstatus.homogenized_effective_open_area_ratio— Flächengewichtet lokale Deposit-Zustände auf einen homogenisierten freien Flächenanteil.generic_sharp_edged_orifice_zeta— Generische Umrechnung eines Ausflussbeiwerts Cd in zeta=1/Cd².QuasiSteadyDepositStepResult— Ergebnis eines quasi-stationären Solve→Deposit→Rebuild-Zeitschritts.advance_phase_change_deposits— Fortschreibt alle SurfacePhaseChangeBC-Deposits eines konvergierten Resultats.quasi_steady_deposit_step— Orchestriert generisch Solve→Deposit-Update→anwendungsspezifischen Modell-Rebuild.
Postprocessing, convergence & reports
Result— Standardergebnis einer Analyse mit Feldern, Solverreport, Metriken und Metadaten.SolverReport— Kompakter Bericht zu Solvertyp, Freiheitsgraden, Nichtnull-Einträgen und Residuen.OpeningFlowReport— Integrierter Volumen-/Massenstrombericht einer benannten Öffnung.opening_flow_report— Integriert Volumen- und Massenströme inklusive Rückströmungsanteil über eine Öffnung.low_mach_mass_metrics— Berechnet lokale Diagnosen für div(rho*u) und div(u).ScalarBoundaryFluxReport— Integrierter Träger- und Skalarflussbericht einer offenen Grenze.StationaryScalarBalanceReport— Globale stationäre Bilanz eines konservativ transportierten Skalars.scalar_boundary_advective_flux_report— Integriert den Upwind-Advektionsfluss eines konservativen Skalars über eine Grenze.stationary_scalar_balance_report— Bilanziert Öffnungsfluss, Phasensenke, Volumenquelle und Dirichlet-Zufuhr global.MeshConvergenceStudy— Führt eine generische Mesh-Konvergenzstudie für eine frei definierte QoI aus.MeshConvergenceReport— Ergebniscontainer einer Mesh-Konvergenzstudie.ConvergenceLevel— Ein einzelnes Auflösungsniveau einer Mesh-Konvergenzstudie.MultiphysicsReport— Aggregiert Feldbereiche, Öffnungsströme, Oberflächen-QoIs, Phasenwechsel und Skalarbilanzen.multiphysics_report— Erzeugt einen generischen Engineering-Bericht aus Modell und konvergiertem Resultat.render_multiphysics_html— Rendert einen MultiphysicsReport als selbstständiges statisches HTML.write_multiphysics_report— Schreibt Report als JSON und statisches HTML in ein Zielverzeichnis.ModelValidationError— Fehlertyp für ungültige oder inkonsistente FEM-Modelle.
Cold-store application layer
ColdStoreGapConfig— Parametrisiert den 3D-Kühlhaus-Luftspalt und seine Randbedingungen.ColdStoreGapGeometry— Geometrie-/Flächenkenngrößen des Kühlhaus-Luftspalts.cold_store_gap_geometry— Berechnet abgeleitete Kühlhaus-Geometrie- und Öffnungsgrößen aus einer Konfiguration.build_cold_store_gap_model— Baut das 3D-Kühlhausmodell ausschließlich aus generischen Core-Modulen zusammen.AmbientScenario— Ein Außenluft-Szenario aus Name, Temperatur, relativer Feuchte und Beschreibung.DEFAULT_AMBIENT_SCENARIOS— Vordefinierte generische Außenklima-Screeningfälle für die Kühlhausanwendung.PerforatedPlateAssumption— Kühlhaus-Annahme für Lochblechgeometrie, Cd und daraus abgeleitete Verlustkoeffizienten.SlotOpeningAssumption— Kühlhaus-Annahme für Schlitzhöhe, Cd und vereisungsabhängige Restöffnung.FROST_DENSITY_BASELINE— Baseline-Schüttdichte für porösen Reif im Screening.FROST_DENSITY_SENSITIVITY— Vordefinierte Reifdichten für Sensitivitätsrechnungen.ICE_SUBLIMATION_HEAT— Alias der im Kühlhaus-Screening verwendeten Sublimationsenthalpie.assumed_cold_store_inputs— Erzeugt Material und ColdStoreGapConfig aus einem Außenluftszenario und expliziten Annahmen.baseline_panel_u_value— Berechnet den Baseline-Leitwert eines homogenen Paneelkerns.cold_store_config_with_opening_deposits— Überträgt generische Deposit-Zustände auf Kühlhaus-Schlitz/Lochblech-Öffnungen.boussinesq_reduced_hydrostatic_pressure— Legacy-Boussinesq-Formel für reduzierten hydrostatischen Druck als Vergleichspfad.dry_air_properties— Erzeugt temperaturabhängige Screening-Materialwerte für trockene Luft.frost_mass_rate_upper_bound— Berechnet eine obere Reifmassenstromgrenze aus trockener Luftmasse und Feuchtepotential.frost_potential_per_kg_dry_air— Berechnet maximal ausfrierbares Wasser je kg trockene Luft.frost_thickness_from_mass— Rechnet Reifmasse, Fläche und Reifdichte in mittlere Schichtdicke um.humidity_ratio— Berechnet Feuchteverhältnis w aus T, RH, p und Wasser-/Eis-Sättigung.saturation_vapor_pressure— Berechnet Sättigungsdampfdruck über Wasser oder Eis.sharp_edged_orifice_zeta— Kühlhaus-Import der generischen Cd→zeta-Umrechnung.wind_velocity_pressure— Berechnet dynamischen Windgeschwindigkeitsdruck q=0,5*rho*v².
Structural mechanics, parametric shells & block mechanics
LinearElasticity3D— Kleine-Verzerrungs-3D-Elastizität für isotrope TET4-Solids.LinearStructuralAnalysis— Lineare statische Strukturanalyse auf dem gemeinsamen FEM-Core.ShellGeometry— Parametrischer Geometrievertrag für Schalen-Solid-Proxys und Öffnungen.StructureStudy— Automatisierter Variantenvergleich getrennter Strukturkennwerte.Block— 3D-Starrkörper-Baustein für die statische diskrete Modellwelt.ContactInterface— No-tension-/Coulomb-Kontakt zwischen Blöcken bzw. Auflagern.RigidBlockEquilibriumAnalysis— Statische Druck-/Reibungs-Gleichgewichtsprüfung.RigidBlockLimitAnalysis— Statische Lower-Bound-Lastfaktoranalyse für ein festes Kontakt-Netz.RigidBlock2D— Planarer orientierter Starrkörper-Rechteckblock.RigidBlock2DLoad— Planare Kraft mit lokalem Angriffspunkt.RigidBlock2DModel— Planarer Blockverband mit Gravitation, Reibung und Lasten.RigidBlock2DContact— Laufzeitkontakt mit Punkt, Normale und Kontaktimpulsen.RigidBlock2DSnapshot— Simulationssnapshot mit Kontakt-Neu-/Verlustereignissen.RigidBlock2DSimulationResult— Zeitverlauf und Bewegungs-/Kontaktmetriken.RigidBlockDynamics2D— Qualitative geometrisch nichtlineare 2D-Starrkörper-/Re-Contact-Sandbox.block_vertices— Globale Eckpunkte eines orientierten 2D-Blocks.rigid_block_2d_examples— Fünf UI-Beispiele: Fallen, Gleiten, Kippen, Stapel und Bogen.rigid_block_2d_example— Einzelnes benanntes 2D-Blockbeispiel.
Wartungsregel
Wenn femcore/__init__.py ein neues öffentliches Symbol exportiert, muss es in diesem Index ergänzt und mindestens einer Detailseite unter docs/guides/ oder docs/reference/ zugeordnet werden. Der kurze CI-Test test_documentation_contract.py überwacht diese Vollständigkeit.