Skip to content

Closures — reference table

Auto-generated by scripts/generate_closures_reference.py from the live closure registry (aeolus1d.closures.registry). Do not edit by hand — regenerate after adding or renaming a closure kind. A unit test (test_closures_reference_doc_in_sync) enforces this.

This page is the at-a-glance counterpart to the prose Closures page. For each closure family, every registered kind is listed alongside the schema fields the kind consumes (drives the inspector form factory's per-kind reveal), the integer dispatch code (used by the @njit kernels), and the spec class + file where the kind is registered.

Adding a new kind: see the aeolus1d-schema-extend checklist and the registration site in the file column.


Initial conditions

  • Family: init
  • Spec class: UniformInit / RiemannInit / RegionalInit / ModeInit
  • Registration: src/aeolus1d/io/parsers.py
kind code required fields
uniform 0 p, T, rho, u
riemann 1 left, right, x0
regional 2 regions
mode 3 mode_index, amplitude, p_ref, T_ref, bc_left, bc_right, n_elements, p_order

Area profile

  • Family: area_profile
  • Spec class: ParabolicProfile / TanhStepProfile / TabulatedProfile
  • Registration: src/aeolus1d/io/parsers.py
kind code required fields
parabolic 0 x_throat, A_inlet, A_throat, A_outlet
tanh_step 1 x_step, A_left, A_right, smooth_cells
tabulated 2 xs, areas

Friction

  • Family: friction
  • Spec class: FrictionSpec
  • Registration: src/aeolus1d/closures/friction.py
kind code required fields
none 0 —
darcy_const 1 f, D_h
colebrook 2 eps_over_D, D_h, nu
minor_loss 3 K_loss, L_loss, bend_r_over_d, bend_angle_deg
python 4 path, D_h

Wall heat transfer

  • Family: heat
  • Spec class: HeatSpec
  • Registration: src/aeolus1d/closures/heat.py
kind code required fields
none 0 —
constant_twall 1 h, T_wall, D_h
egr_cooler 2 T_coolant, UA, C_coolant
charge_air_cooler 3 T_coolant, UA, C_coolant
flow_nu 4 T_wall, D_h, k_gas, mu_gas, Pr, correlation, laminar_nu

Porous (Darcy-Forchheimer)

  • Family: porous
  • Spec class: PorousSpec
  • Registration: src/aeolus1d/closures/porous.py
kind code required fields
none 0 —
darcy_forchheimer 1 alpha, beta, mu_ref, viscosity_model, sutherland_T_ref, sutherland_S
darcy_forchheimer_kc 2 K, C_F, mu_ref, viscosity_model, sutherland_T_ref, sutherland_S
python 3 path

Catalyst

  • Family: catalyst
  • Spec class: CatalystSpec
  • Registration: src/aeolus1d/closures/catalyst.py
kind code required fields
none 0 —
two_phase_heat 1 rho_s_cs, a_v, h, T_solid_init, thermal_mass_multiplier, pore_diffusion_multiplier
two_phase_heat_var_nu 2 cpsi, ofa, substrate, k_gas, nu, mu_gas, Pr, nu_correlation, heat_correlation_hint, mass_correlation_hint, h_multiplier, Sh_multiplier, thermal_mass_multiplier, pore_diffusion_multiplier, T_solid_init
mechanism 3 mechanism_path, surface_init, T_solid_init

Particulate filter (DPF)

  • Family: filter
  • Spec class: FilterSpec
  • Registration: src/aeolus1d/closures/filter.py
kind code required fields
none 0 —
diesel_particulate_filter 1 trap, cake, regen

Equation of state

  • Family: eos
  • Spec class: EOSSpec
  • Registration: src/aeolus1d/closures/eos.py
kind code required fields
ideal 0 R_gas, cv, cv_poly, cv_T_min, cv_T_max
redlich_kwong 1 R_gas, cv, Tc, Pc, cv_poly, cv_T_min, cv_T_max
peng_robinson 2 R_gas, cv, Tc, Pc, omega, cv_poly, cv_T_min, cv_T_max
tabulated 3 fluid, T_min, T_max, n_T, rho_min, rho_max, n_rho

Species & reactions

(no kinds registered)

Junction kinds

  • Family: junction
  • Spec class: JunctionSpec
  • Registration: src/aeolus1d/components/junction.py
kind code required fields
plenum 0 volume, init, ports, wall_h_conv, wall_A, wall_T, wall_h_conv_speed_ref, wall_h_conv_speed_slope, wall_T_load_ref, wall_T_load_slope
corberan 1 ports
ehr 2 volume, init, ports
passthrough 3 ports
biased_plenum 4 ports, flow_ui, adblue_ui, correlation, profile, mdot, Y_primary, distributor_extras

Boundary conditions

  • Family: bc
  • Spec class: BCSpec
  • Registration: src/aeolus1d/bc/__init__.py
kind code required fields
wall 0 —
transmissive 1 —
stagnation_inlet 2 p0, T0, p_back
pressure_outlet 3 p_back
nonreflecting 4 rho_inf, u_inf, p_inf
transient_stagnation_inlet 5 p0_t, p0_v, T0_t, T0_v, Y_t, Y_v, Y_extras_specs
transient_pressure_outlet 6 p_back_t, p_back_v
valve_inlet 7 p0, T0, lift_t, lift_y, lift_max
valve_orifice 8 p0, T0, lift_t, lift_y, lift_max, A_max, A_pipe, Cd, Cd_reverse, n_holes, borda_carnot, cd_reynolds, mu_gas, cd_tapping
mass_flow_inlet 9 mdot, T0
velocity_inlet 10 u_inlet, T0, p0
transient_mass_flow_inlet 11 mdot_t, mdot_v, T0_t, T0_v, Y_t, Y_v, Y_extras_specs, csv_path, csv_t_col, csv_T0_col, csv_mdot_col, csv_delimiter, csv_skiprows
transient_velocity_inlet 12 u_inlet_t, u_inlet_v, T0_t, T0_v, p0_t, p0_v, Y_t, Y_v, Y_extras_specs, csv_path, csv_t_col, csv_T0_col, csv_delimiter, csv_skiprows
egr_valve 13 p0, T0, A_max, A_pipe, Cd, Y_supply, Y_extras_supply
throttle 14 p0, T0, A_max, A_pipe, Cd, Y_supply, Y_extras_supply

Python-callable junction BCs

  • Family: py_junction_bc
  • Spec class: PortSpec.py_junction_bc
  • Registration: src/aeolus1d/closures/learned_junction_bc.py
kind code required fields
none 0 —
resistive_demo 1 —
learned_npz 2 py_junction_bc_npz

Other registered families

(not in the curated index — add an entry to _FAMILY_INDEX for proper headers / spec class / file pointer)

family reaction

  • Family: reaction
  • Spec class: —
  • Registration: —
kind code required fields
none 0 —
arrhenius_scr_demo 1 A, Ea, dH_rxn, M_reactant
arrhenius_scr_multi_demo 2 A, Ea, dH_rxn, M_reactant, M_NO
nh3_ads_des 3 A_ads, Ea_ads, A_des, Ea_des, alpha_des, W_cat, theta_init, dH_ads, M_reactant
nh3_scr_kinetics 4 A_ads, Ea_ads, A_des, Ea_des, alpha_des, A_ox, Ea_ox, A_scr, Ea_scr, A_fast_scr, Ea_fast_scr, dH_fast_scr, A_ox_no_scr, Ea_ox_no_scr, dH_ox_no_scr, W_cat, theta_init, dH_ads, dH_ox, dH_scr, M_reactant, M_NO
nh3_slip_catalyst 9 A_ads, Ea_ads, A_des, Ea_des, alpha_des, A_ox, Ea_ox, A_scr, Ea_scr, A_fast_scr, Ea_fast_scr, dH_fast_scr, A_ox_no_scr, Ea_ox_no_scr, dH_ox_no_scr, W_cat, theta_init, dH_ads, dH_ox, dH_scr, M_reactant, M_NO
hc_oxidation 5 A_hc_ox, Ea_hc_ox, LHV_hc
doc_oxidation 6 A_hc_ox, Ea_hc_ox, LHV_hc, A_co_ox, Ea_co_ox, LHV_co
doc_oxidation_S 11 A_hc_ox, Ea_hc_ox, LHV_hc, A_co_ox, Ea_co_ox, LHV_co, theta_S_init, alpha_S
doc_oxidation_voltz 13 A_hc_ox, Ea_hc_ox, LHV_hc, A_co_ox, Ea_co_ox, LHV_co, Ka0_voltz, Ta_voltz, Kb0_voltz, Tb_voltz, Kc0_voltz, Tc_voltz, M_co_voltz, M_hc_voltz, k_mt_voltz
twc 7 A_CO_twc, Ea_CO_twc, dH_CO_twc, A_HC_twc, Ea_HC_twc, dH_HC_twc, A_NO_twc, Ea_NO_twc, dH_NO_twc, K_CO_inh_twc, M_CO_twc, M_HC_twc, M_NO_twc, M_O2_twc
twc_brinkmeier 8 A_brnk, Ea_brnk, dH_brnk, K_CO_inh_brnk, K_HC_inh_brnk, Omega_OSC_brnk, A_charge_brnk, Ea_charge_brnk, dH_charge_brnk, A_d_CO_brnk, Ea_d_CO_brnk, A_d_HC_brnk, Ea_d_HC_brnk, osc_discharge_heat_brnk, dH_osc_chem_brnk, A_nh3_form_brnk, Ea_nh3_form_brnk, dH_nh3_form_brnk, A_c3h6_ox_brnk, Ea_c3h6_ox_brnk, dH_c3h6_ox_brnk, theta_Ce_init
hnco_hydrolysis 10 A, Ea, dH_rxn, M_reactant
mechanism 12 —

family turbo

  • Family: turbo
  • Spec class: —
  • Registration: —
kind code required fields
compressor 0 —
turbine 1 —

family turbo_map

  • Family: turbo_map
  • Spec class: —
  • Registration: —
kind code required fields
synthetic_centrifugal 0 n_corr_max, mdot_corr_max, pr_max, eta_peak
synthetic_turbine 1 n_corr_max, mdot_corr_max, pr_inv_max, eta_peak
learned_npz 2 npz_path
synthetic_vgt_turbine 3 n_corr_max, mdot_corr_max, pr_inv_max, eta_peak, vane_levels
synthetic_igv_centrifugal 4 n_corr_max, mdot_corr_max, pr_max, eta_peak, vane_levels
from_csv 5 csv_path
from_npz 6 npz_path