Physics catalogue (beta)¶
The physics catalogue is the registry that model documents (designs with a physics section) are validated against (axmp validate); this version does not solve them: the physics types, the coupling terms between them, and the route table, one row per combination of physics, couplings, geometry class and study type that an engine of this version solves, with what the row offers and what it needs. It is compiled into every build and is the same in each, so a document validates the same way everywhere. Everything on this page is beta, and no route is implemented in this version: a model document is validated and resolved, and a planar or axisymmetric one is meshed (axmp mesh), but none is solved.
Print it with axmp physics (--routes adds the route table, --type T restricts it to one type, --all prints the details, --json the machine form of schema axionmultiphysics.physics_catalogue/1), or in Python with axionmultiphysics.physics(routes=True, type=None).
Physics types¶
| type | status | title | publishes |
|---|---|---|---|
fluid.incompressible |
beta | Incompressible flow (Stokes and Navier-Stokes) | u, p |
heat.transfer |
beta | Heat transfer in solids and fluids | T |
electrochem.current_distribution |
beta | Primary and secondary current distribution | phi |
chem.reactor |
beta | Reaction engineering (0D reactors) | c_<species> |
electrochem.porous_electrode |
beta | Porous electrode (1D) | none |
current.conduction |
absent | Electric currents (conduction) | V |
solid.linear |
absent | Linear elastic solid | displacement |
species.transport |
absent | Transport of diluted species | none |
Data-key types: number, boolean, names (a list of names), boundary (a boundary name), number_vector (a list of numbers), vector (a field expression per component: (x, y) planar, (r, z, theta) axisymmetric, (x, y, z) in 3D) and meridional_vector ((x, y), (r, z) and (x, y, z)). Option values are listed as text; an integer option is written as a number in a document.
fluid.incompressible (beta)¶
Incompressible flow (Stokes and Navier-Stokes).
Aliases (names other codes use; a document writes the name above): laminar_flow, creeping_flow.
Publishes the fields u, p.
| option | type | values | default | highest geometry order |
|---|---|---|---|---|
equation |
enum | stokes, navier_stokes |
none (to be written) | any |
viscous_form |
enum | stress, laplacian |
stress |
any |
convection |
enum | standard, skew |
standard |
any |
order |
integer | 2 |
2 |
any |
| condition kind | data keys | aliases |
|---|---|---|
wall |
velocity_m_s (vector; m/s; field expression; optional) |
no_slip |
inlet |
velocity_m_s (vector; m/s; field expression) |
none |
outlet |
pressure_Pa (number; Pa; optional) |
none |
open |
none | open_boundary |
traction |
traction_Pa (vector; Pa; field expression) |
boundary_stress |
slip |
none | none |
symmetry |
none | none |
periodic |
partner (boundary); translation_m (number_vector; m); pressure_drop_Pa (number; Pa; optional); flow_rate (number; m^2/s planar (per metre of depth), m^3/s in 3D; optional) |
periodic_flow_condition |
| source kind | data keys | aliases |
|---|---|---|
body_force |
force_N_m3 (vector; N/m^3; field expression) |
volume_force |
| geometry | quantities |
|---|---|
| planar | u [m/s] (velocity (u_x, u_y)); u_x [m/s]; u_y [m/s]; u_mag [m/s]; p [Pa]; vorticity [1/s] (du_y/dx - du_x/dy); wall_shear [Pa] (traction by the fluid on the wall along t = n rotated +90 deg); wall_shear_mag [Pa]; volume [m^2/s] (flux only: per metre of depth, positive out of the domain); mass [kg/(m s)] (flux only: per metre of depth, positive out of the domain) |
| axisymmetric | u [m/s] (velocity (u_r, u_z, u_theta)); u_r [m/s]; u_z [m/s]; u_theta [m/s]; u_mag [m/s]; p [Pa]; vorticity [1/s] (azimuthal component du_r/dz - du_z/dr); wall_shear [Pa] (traction by the fluid on the wall along t = n rotated +90 deg); wall_shear_mag [Pa] (includes the swirl part); wall_shear_theta [Pa] (the swirl part of the wall traction); volume [m^3/s] (flux only: 3D total, positive out of the domain); mass [kg/s] (flux only: 3D total, positive out of the domain) |
| 3d | u [m/s] (velocity (u_x, u_y, u_z)); u_x [m/s]; u_y [m/s]; u_z [m/s]; u_mag [m/s]; p [Pa]; vorticity [1/s] (magnitude of curl u); wall_shear_mag [Pa] (magnitude only (no tangent frame in 3D)); volume [m^3/s] (flux only: positive out of the domain); mass [kg/s] (flux only: positive out of the domain) |
Not implemented:
- solving through the model document: every route of this type is not implemented in this version
- periodic conditions through the document (they need a periodic instance mesh; roadmap item 'periodic flow')
- slip and symmetry conditions with Navier-Stokes, and in axisymmetric geometry
- the swirl-free axisymmetric formulation: an axisymmetric flow has the three components (u_r, u_z, u_theta)
- inflow by flow rate, backflow stabilization and the directional do-nothing outlet (roadmap item F2b)
- inductionless MHD, the equal-order (GLS) discretization and turbulence models as options
- a force on a moving wall with the Laplacian viscous form on the Navier-Stokes rows
heat.transfer (beta)¶
Heat transfer in solids and fluids.
Aliases (names other codes use; a document writes the name above): heat_transfer_in_solids, heat_transfer_in_fluids.
Publishes the fields T.
| option | type | values | default | highest geometry order |
|---|---|---|---|---|
order |
integer | 1, 2 |
2 |
any |
stabilization |
enum | none, supg |
none |
supg: 1 |
advective_form |
enum | convective, conservative_flux, conservative_divergence |
convective |
any |
| condition kind | data keys | aliases |
|---|---|---|
temperature |
T_K (number; K; field expression) |
none |
heat_flux |
q_W_m2 (number; W/m^2) |
none |
total_flux |
q_W_m2 (number; W/m^2) |
none |
convection |
h_W_m2K (number; W/(m^2 K)); T_ext_K (number; K) |
convective_heat_flux |
insulation |
none | thermal_insulation |
outflow |
none | none |
| source kind | data keys | aliases |
|---|---|---|
heat_source |
q_W_m3 (number; W/m^3; field expression; optional); P_W (number; W; optional; P_W_m in a planar model) |
none |
prescribed_advection |
velocity_m_s (meridional_vector; m/s; field expression) |
velocity_field |
| geometry | quantities |
|---|---|
| planar | T [K]; heat_flux_n [W/m^2] (conductive flux -k grad T . n, positive out of the domain); heat [W/m] (flux only: conductive plus advected, per metre of depth, positive out of the domain); heat_conductive [W/m] (flux only: conductive part, per metre of depth, positive out of the domain) |
| axisymmetric | T [K]; heat_flux_n [W/m^2] (conductive flux -k grad T . n, positive out of the domain); heat [W] (flux only: conductive plus advected, 3D total, positive out of the domain); heat_conductive [W] (flux only: conductive part, 3D total, positive out of the domain) |
| 3d | T [K]; heat_flux_n [W/m^2] (conductive flux -k grad T . n, positive out of the domain); heat [W] (flux only: conductive plus advected, 3D total, positive out of the domain); heat_conductive [W] (flux only: conductive part, 3D total, positive out of the domain) |
Not implemented:
- solving through the model document: every route of this type is not implemented in this version
- a transient heat solve
- heat transfer in 3D
- a conductivity or a heat source that differs from region to region (one expression over the instance until the transport operator takes data per region)
- a heat capacity rho cp that differs between the regions of an advected instance (conjugate heat transfer)
- SUPG on curved (isoparametric) elements
- quadrilateral elements
- the heat-to-heat interface term and thermal contact
electrochem.current_distribution (beta)¶
Primary and secondary current distribution.
Aliases (names other codes use; a document writes the name above): primary_current_distribution, secondary_current_distribution.
Publishes the fields phi.
| option | type | values | default | highest geometry order |
|---|---|---|---|---|
kinetics |
enum | primary, secondary |
secondary |
any |
order |
integer | 1, 2 |
2 |
any |
T_K |
number | a number | 298.15 |
any |
| condition kind | data keys | aliases |
|---|---|---|
electrode |
reactions (names; optional); phi_s_V (number; V; optional; rampable); current_A (number; A; optional; rampable; current_A_m in a planar model); primary (boolean; optional); E_eq_V (number; V; optional) |
electrode_surface |
insulation |
none | none |
normal_current |
i_A_m2 (number; A/m^2) |
normal_current_density |
| geometry | quantities |
|---|---|
| planar | phi_l [V] (electrolyte potential); i_mag [A/m^2] (magnitude of the current density); i_n [A/m^2] (normal current density, positive out of the electrolyte); overpotential [V] (eta = phi_s - phi_l - E_eq, anodic positive) |
| axisymmetric | phi_l [V] (electrolyte potential); i_mag [A/m^2] (magnitude of the current density); i_n [A/m^2] (normal current density, positive out of the electrolyte); overpotential [V] (eta = phi_s - phi_l - E_eq, anodic positive) |
| 3d | phi_l [V] (electrolyte potential); i_mag [A/m^2] (magnitude of the current density); i_n [A/m^2] (normal current density, positive out of the electrolyte); overpotential [V] (eta = phi_s - phi_l - E_eq, anodic positive) |
Not implemented:
- solving through the model document: every route of this type is not implemented in this version
- every electrode galvanostatic: the potential level is then free
- P1 elements on curved (isoparametric) geometry
- concentration-dependent kinetics and species transport in the electrolyte
chem.reactor (beta)¶
Reaction engineering (0D reactors).
Aliases (names other codes use; a document writes the name above): reaction_engineering.
Publishes the fields c_<species>.
Not implemented:
- solving through the model document: the route of this type is not implemented in this version
- the reactor's own data (volume, feed, initial composition) in the document grammar
- a stationary solve: a reactor is solved in time only
electrochem.porous_electrode (beta)¶
Porous electrode (1D).
Not implemented:
- everything but the name: the type has no condition kinds, options or route yet
current.conduction (absent)¶
Electric currents (conduction).
Aliases (names other codes use; a document writes the name above): electric_currents.
Publishes the fields V.
Not implemented in this version: a document that uses it is reported unavailable ("physics type 'current.conduction'").
| condition kind | data keys | aliases |
|---|---|---|
potential |
V_V (number; V; field expression) |
electric_potential |
ground |
none | none |
insulation |
none | electric_insulation |
| geometry | quantities |
|---|---|
| planar | V [V] (electric potential); J_mag [A/m^2] (magnitude of the current density); joule_power_density [W/m^3]; charge [A/m] (flux only: current per metre of depth, positive out of the domain) |
| axisymmetric | V [V] (electric potential); J_mag [A/m^2] (magnitude of the current density); joule_power_density [W/m^3]; charge [A] (flux only: current, positive out of the domain) |
| 3d | V [V] (electric potential); J_mag [A/m^2] (magnitude of the current density); joule_power_density [W/m^3]; charge [A] (flux only: current, positive out of the domain) |
Not implemented:
- the type: it has no engine in this version
solid.linear (absent)¶
Linear elastic solid.
Aliases (names other codes use; a document writes the name above): solid_mechanics.
Publishes the fields displacement.
Not implemented in this version: a document that uses it is reported unavailable ("'solid.linear' as a physics instance").
| condition kind | data keys | aliases |
|---|---|---|
fixed |
none | fixed_constraint |
free |
none | none |
| geometry | quantities |
|---|---|
| planar | displacement_mag [m]; von_mises [Pa] (von Mises equivalent stress) |
| axisymmetric | displacement_mag [m]; von_mises [Pa] (von Mises equivalent stress) |
| 3d | displacement_mag [m]; von_mises [Pa] (von Mises equivalent stress) |
Not implemented:
- the type as a physics instance: elasticity runs only behind the electromagnetic 'mechanics' section in this version
species.transport (absent)¶
Transport of diluted species. Not implemented in this version: a document that uses it is reported unavailable ("physics type 'species.transport'").
Not implemented:
- the type: it has no engine in this version
Coupling terms¶
| term | status | from | to | support | reads | data keys |
|---|---|---|---|---|---|---|
advection |
beta | fluid.* |
heat.transfer, species.transport |
domain | u |
none |
buoyancy |
beta | heat.transfer |
fluid.incompressible |
domain | T |
T_ref_K (number; K); gravity_m_s2 (meridional_vector; m/s^2) |
joule_heating |
absent | current.conduction |
heat.transfer |
domain | V |
none |
thermal_expansion |
absent | heat.transfer |
solid.linear |
domain | T |
T_ref_K (number; K) |
Routes¶
| route | physics | couplings | geometry | study | status |
|---|---|---|---|---|---|
stokes_planar |
fluid.incompressible |
none | planar | stationary | not implemented yet |
stokes_axisymmetric |
fluid.incompressible |
none | axisymmetric | stationary | not implemented yet |
navier_stokes_steady_planar |
fluid.incompressible |
none | planar | stationary | not implemented yet |
navier_stokes_steady_axisymmetric |
fluid.incompressible |
none | axisymmetric | stationary | not implemented yet |
navier_stokes_transient_planar |
fluid.incompressible |
none | planar | transient | not implemented yet |
navier_stokes_transient_axisymmetric |
fluid.incompressible |
none | axisymmetric | transient | not implemented yet |
stokes_3d |
fluid.incompressible |
none | 3d | stationary | not implemented yet |
heat_planar |
heat.transfer |
none | planar | stationary | not implemented yet |
heat_axisymmetric |
heat.transfer |
none | axisymmetric | stationary | not implemented yet |
heat_prescribed_advection_planar |
heat.transfer |
none | planar | stationary | not implemented yet |
heat_prescribed_advection_axisymmetric |
heat.transfer |
none | axisymmetric | stationary | not implemented yet |
flow_then_heat_planar |
fluid.incompressible, heat.transfer |
advection |
planar | stationary | not implemented yet |
flow_then_heat_axisymmetric |
fluid.incompressible, heat.transfer |
advection |
axisymmetric | stationary | not implemented yet |
boussinesq_planar |
fluid.incompressible, heat.transfer |
advection, buoyancy |
planar | stationary | not implemented yet |
boussinesq_axisymmetric |
fluid.incompressible, heat.transfer |
advection, buoyancy |
axisymmetric | stationary | not implemented yet |
current_distribution_planar |
electrochem.current_distribution |
none | planar | stationary | not implemented yet |
current_distribution_axisymmetric |
electrochem.current_distribution |
none | axisymmetric | stationary | not implemented yet |
current_distribution_3d |
electrochem.current_distribution |
none | 3d | stationary | not implemented yet |
chem_reactor |
chem.reactor |
none | none | transient | not implemented yet |
stokes_planar¶
- Status: not implemented yet.
- Physics:
fluid.incompressible; couplings: none; geometry: planar; study: stationary. - Selected by:
equation=stokes. - Engine: StokesSolver.
- Needs: the mesher, an MPI build, the fluids library, any number of ranks.
- Condition kinds offered (fluid.incompressible):
wall,inlet,outlet,open,traction,slip,symmetry. - Not offered (fluid.incompressible):
periodic: not_exposed: the engine needs a topologically periodic mesh, and the instance mesh has no boundary element on an interior face; exposing it takes a periodic instance mesh, the partition rule's exception for the partner and matching nodes on the two sides (roadmap item 'periodic flow'). - Options (fluid.incompressible):
equation:stokes(default`);viscous_form:stress,laplacian(defaultstress);order:2(default2`). - Material blocks (fluid.incompressible):
fluid. - Uniform over the instance with
viscous_form=laplacianand aforceoutput (fluid.incompressible):fluid.mu_Pa_s(engine_refuses: StokesSolver::physical_reaction). - Element types:
triangle,quadrilateral. - Force output: physical_reaction.
- Layer rules:
geometry_order_exceeds_field_order. - a force output with the Laplacian viscous form needs one viscosity over the instance (the engine's physical reaction is defined for a constant viscosity only).
- periodic conditions are not exposed yet (roadmap item 'periodic flow').
- any number of MPI ranks for the solve; outputs and point sampling on rank 0 from the saved solution.
stokes_axisymmetric¶
- Status: not implemented yet.
- Physics:
fluid.incompressible; couplings: none; geometry: axisymmetric; study: stationary. - Selected by:
equation=stokes. - Engine: StokesSolver.
- Needs: the mesher, an MPI build, the fluids library, any number of ranks.
- Condition kinds offered (fluid.incompressible):
wall,inlet,outlet,open,traction. - Not offered (fluid.incompressible):
periodic: engine_refuses. - Not offered (fluid.incompressible):
slip: engine_refuses. - Not offered (fluid.incompressible):
symmetry: engine_refuses. - Options (fluid.incompressible):
equation:stokes(default`);viscous_form:stress,laplacian(defaultstress);order:2(default2`). - Material blocks (fluid.incompressible):
fluid. - Uniform over the instance with
viscous_form=laplacianand aforceoutput (fluid.incompressible):fluid.mu_Pa_s(engine_refuses: StokesSolver::physical_reaction). - Element types:
triangle,quadrilateral. - Force output: physical_reaction.
- Axisymmetric integrals of the engine: includes 2pi.
- Layer rules:
geometry_order_exceeds_field_order. - a force output with the Laplacian viscous form needs one viscosity over the instance (the engine's physical reaction is defined for a constant viscosity only).
- no slip, symmetry or periodic condition in axisymmetric geometry.
- an axisymmetric flow has the three velocity components (u_r, u_z, u_theta); forces and torques are 3D totals (the engine includes 2 pi).
- any number of MPI ranks for the solve; outputs and point sampling on rank 0 from the saved solution.
navier_stokes_steady_planar¶
- Status: not implemented yet.
- Physics:
fluid.incompressible; couplings: none; geometry: planar; study: stationary. - Selected by:
equation=navier_stokes. - Engine: NavierStokesSolver.
- Needs: the mesher, an MPI build, the fluids library, any number of ranks.
- Condition kinds offered (fluid.incompressible):
wall,inlet,outlet,open,traction. - Not offered (fluid.incompressible):
periodic: engine_refuses. - Not offered (fluid.incompressible):
slip: engine_refuses. - Not offered (fluid.incompressible):
symmetry: engine_refuses. - Options (fluid.incompressible):
equation:navier_stokes(default`);viscous_form:stress,laplacian(defaultstress);convection:standard,skew(defaultstandard);order:2(default2`). - Material blocks (fluid.incompressible):
fluid,density. - Uniform over the instance (fluid.incompressible):
density. - Uniform over the instance with
viscous_form=laplacianand aforceoutput (fluid.incompressible):fluid.mu_Pa_s(layer_rule: force_with_laplacian_form). - Element types:
triangle,quadrilateral. - Force output: reaction: walls at rest only with the laplacian form.
- Layer rules:
force_with_laplacian_form,geometry_order_exceeds_field_order. - Solver settings (fluid.incompressible):
newton_rtol(number, default1e-12),newton_maxit(integer, default30),n_picard(integer, default3),line_search(boolean, defaulttrue),residual_floor_factor(number, default4.0). - density is one constant over the instance: the engine takes one density per solve.
- a force output is the engine's reaction of the solved form: the physical force with the stress form; with the Laplacian form the force on walls at rest only.
- no slip, symmetry or periodic condition with convection.
- any number of MPI ranks for the solve; outputs and point sampling on rank 0 from the saved solution.
navier_stokes_steady_axisymmetric¶
- Status: not implemented yet.
- Physics:
fluid.incompressible; couplings: none; geometry: axisymmetric; study: stationary. - Selected by:
equation=navier_stokes. - Engine: NavierStokesSolver.
- Needs: the mesher, an MPI build, the fluids library, any number of ranks.
- Condition kinds offered (fluid.incompressible):
wall,inlet,outlet,open,traction. - Not offered (fluid.incompressible):
periodic: engine_refuses. - Not offered (fluid.incompressible):
slip: engine_refuses. - Not offered (fluid.incompressible):
symmetry: engine_refuses. - Options (fluid.incompressible):
equation:navier_stokes(default`);viscous_form:stress,laplacian(defaultstress);convection:standard,skew(defaultstandard);order:2(default2`). - Material blocks (fluid.incompressible):
fluid,density. - Uniform over the instance (fluid.incompressible):
density. - Uniform over the instance with
viscous_form=laplacianand aforceoutput (fluid.incompressible):fluid.mu_Pa_s(layer_rule: force_with_laplacian_form). - Element types:
triangle,quadrilateral. - Force output: reaction: walls at rest only with the laplacian form.
- Axisymmetric integrals of the engine: includes 2pi.
- Layer rules:
force_with_laplacian_form,geometry_order_exceeds_field_order. - Solver settings (fluid.incompressible):
newton_rtol(number, default1e-12),newton_maxit(integer, default30),n_picard(integer, default3),line_search(boolean, defaulttrue),residual_floor_factor(number, default4.0). - density is one constant over the instance: the engine takes one density per solve.
- a force output is the engine's reaction of the solved form: the physical force with the stress form; with the Laplacian form the force on walls at rest only.
- no slip, symmetry or periodic condition with convection.
- an axisymmetric flow has the three velocity components (u_r, u_z, u_theta); forces and torques are 3D totals (the engine includes 2 pi).
- any number of MPI ranks for the solve; outputs and point sampling on rank 0 from the saved solution.
navier_stokes_transient_planar¶
- Status: not implemented yet.
- Physics:
fluid.incompressible; couplings: none; geometry: planar; study: transient. - Selected by:
equation=navier_stokes. - Engine: TransientNavierStokes.
- Needs: the mesher, an MPI build, the fluids library, any number of ranks.
- Condition kinds offered (fluid.incompressible):
wall,inlet,outlet,open,traction. - Not offered (fluid.incompressible):
periodic: engine_refuses. - Not offered (fluid.incompressible):
slip: engine_refuses. - Not offered (fluid.incompressible):
symmetry: engine_refuses. - Options (fluid.incompressible):
equation:navier_stokes(default`);viscous_form:stress,laplacian(defaultstress);convection:standard(defaultstandard);order:2(default2`). - Material blocks (fluid.incompressible):
fluid,density. - Uniform over the instance (fluid.incompressible):
density. - Uniform over the instance with
viscous_form=laplacianand aforceoutput (fluid.incompressible):fluid.mu_Pa_s(layer_rule: force_with_laplacian_form). - Element types:
triangle,quadrilateral. - Force output: reaction: walls at rest only with the laplacian form.
- Layer rules:
force_with_laplacian_form,geometry_order_exceeds_field_order. - Solver settings (fluid.incompressible):
newton_rtol(number, default1e-12),newton_maxit(integer, default30). - density is one constant over the instance: the engine takes one density per solve.
- a force output is the engine's reaction of the solved form: the physical force with the stress form; with the Laplacian form the force on walls at rest only.
- no slip, symmetry or periodic condition with convection.
- convection skew is refused: the time stepper takes the standard convective form only.
- any number of MPI ranks for the time steps; the point evaluation of a stored state needs one rank.
navier_stokes_transient_axisymmetric¶
- Status: not implemented yet.
- Physics:
fluid.incompressible; couplings: none; geometry: axisymmetric; study: transient. - Selected by:
equation=navier_stokes. - Engine: TransientNavierStokes.
- Needs: the mesher, an MPI build, the fluids library, any number of ranks.
- Condition kinds offered (fluid.incompressible):
wall,inlet,outlet,open,traction. - Not offered (fluid.incompressible):
periodic: engine_refuses. - Not offered (fluid.incompressible):
slip: engine_refuses. - Not offered (fluid.incompressible):
symmetry: engine_refuses. - Options (fluid.incompressible):
equation:navier_stokes(default`);viscous_form:stress,laplacian(defaultstress);convection:standard(defaultstandard);order:2(default2`). - Material blocks (fluid.incompressible):
fluid,density. - Uniform over the instance (fluid.incompressible):
density. - Uniform over the instance with
viscous_form=laplacianand aforceoutput (fluid.incompressible):fluid.mu_Pa_s(layer_rule: force_with_laplacian_form). - Element types:
triangle,quadrilateral. - Force output: reaction: walls at rest only with the laplacian form.
- Axisymmetric integrals of the engine: includes 2pi.
- Layer rules:
force_with_laplacian_form,geometry_order_exceeds_field_order. - Solver settings (fluid.incompressible):
newton_rtol(number, default1e-12),newton_maxit(integer, default30). - density is one constant over the instance: the engine takes one density per solve.
- a force output is the engine's reaction of the solved form: the physical force with the stress form; with the Laplacian form the force on walls at rest only.
- no slip, symmetry or periodic condition with convection.
- an axisymmetric flow has the three velocity components (u_r, u_z, u_theta); forces and torques are 3D totals (the engine includes 2 pi).
- convection skew is refused: the time stepper takes the standard convective form only.
- any number of MPI ranks for the time steps; the point evaluation of a stored state needs one rank.
stokes_3d¶
- Status: not implemented yet.
- Physics:
fluid.incompressible; couplings: none; geometry: 3d; study: stationary. - Selected by:
equation=stokes. - Engine: StokesSolver (3D, distributed).
- Needs: the mesher, an MPI build, the fluids library, the 3D engine, any number of ranks.
- Condition kinds offered (fluid.incompressible):
wall,inlet,outlet,open,traction,slip,symmetry. - Not offered (fluid.incompressible):
periodic: not_exposed: the engine needs a topologically periodic mesh, and the instance mesh has no boundary element on an interior face; exposing it takes a periodic instance mesh, the partition rule's exception for the partner and matching nodes on the two sides (roadmap item 'periodic flow'). - Options (fluid.incompressible):
equation:stokes(default`);viscous_form:stress,laplacian(defaultstress);order:2(default2`). - Material blocks (fluid.incompressible):
fluid. - Uniform over the instance with
viscous_form=laplacianand aforceoutput (fluid.incompressible):fluid.mu_Pa_s(engine_refuses: StokesSolver::physical_reaction). - Element types:
tetrahedron. - Force output: physical_reaction.
- Layer rules:
geometry_order_exceeds_field_order. - a force output with the Laplacian viscous form needs one viscosity over the instance (the engine's physical reaction is defined for a constant viscosity only).
- periodic conditions are not exposed yet (roadmap item 'periodic flow').
- distributed over the MPI ranks; every cell of this row is confirmed against the engine when the row is implemented.
heat_planar¶
- Status: not implemented yet.
- Physics:
heat.transfer; couplings: none; geometry: planar; study: stationary. - Engine: transport::ScalarTransport.
- Needs: the mesher, an MPI build, the fluids library, at most 1 rank.
- Condition kinds offered (heat.transfer):
temperature,heat_flux,total_flux,convection,insulation,outflow. - Not offered with
advective_form=conservative_divergence(heat.transfer):total_flux: engine_refuses. - Not offered with
advective_form=conservative_flux(heat.transfer):heat_flux: engine_refuses. - Not offered with
advective_form=conservative_flux(heat.transfer):outflow: layer_rule: outflow_with_conservative_flux. - Not offered with
advective_form=convective(heat.transfer):total_flux: engine_refuses. - Options (heat.transfer):
order:1,2(default2);stabilization:none(defaultnone);advective_form:convective,conservative_divergence,conservative_flux(defaultconvective). - Material blocks (heat.transfer):
thermal. - One expression over the instance (heat.transfer):
thermal.k_W_mK,heat_source. - Element types:
triangle. - Layer rules:
outflow_with_conservative_flux,per_depth_keys,geometry_order_exceeds_field_order. - one MPI rank.
- triangles only (the transport operator's constructor refuses other elements).
- thermal.k_W_mK and the heat source are one expression over the instance until the transport operator takes data per region.
- stabilization supg is refused: there is no velocity for it.
- without advection the three advective forms are one operator, and the condition kinds still depend on advective_form (the transport operator checks them against the form).
heat_axisymmetric¶
- Status: not implemented yet.
- Physics:
heat.transfer; couplings: none; geometry: axisymmetric; study: stationary. - Engine: transport::ScalarTransport.
- Needs: the mesher, an MPI build, the fluids library, at most 1 rank.
- Condition kinds offered (heat.transfer):
temperature,heat_flux,total_flux,convection,insulation,outflow. - Not offered with
advective_form=conservative_divergence(heat.transfer):total_flux: engine_refuses. - Not offered with
advective_form=conservative_flux(heat.transfer):heat_flux: engine_refuses. - Not offered with
advective_form=conservative_flux(heat.transfer):outflow: layer_rule: outflow_with_conservative_flux. - Not offered with
advective_form=convective(heat.transfer):total_flux: engine_refuses. - Options (heat.transfer):
order:1,2(default2);stabilization:none(defaultnone);advective_form:convective,conservative_divergence,conservative_flux(defaultconvective). - Material blocks (heat.transfer):
thermal. - One expression over the instance (heat.transfer):
thermal.k_W_mK,heat_source. - Element types:
triangle. - Axisymmetric integrals of the engine: per radian.
- Layer rules:
outflow_with_conservative_flux,per_depth_keys,geometry_order_exceeds_field_order. - one MPI rank.
- triangles only (the transport operator's constructor refuses other elements).
- thermal.k_W_mK and the heat source are one expression over the instance until the transport operator takes data per region.
- stabilization supg is refused: there is no velocity for it.
- without advection the three advective forms are one operator, and the condition kinds still depend on advective_form (the transport operator checks them against the form).
- the engine's integrals are per radian; the results are 3D totals (times 2 pi).
heat_prescribed_advection_planar¶
- Status: not implemented yet.
- Physics:
heat.transfer; couplings: none; geometry: planar; study: stationary. - Selected by the sources: heat.transfer:
prescribed_advection. - Engine: transport::ScalarTransport with a callable velocity.
- Needs: the mesher, an MPI build, the fluids library, at most 1 rank.
- Condition kinds offered (heat.transfer):
temperature,heat_flux,total_flux,convection,insulation,outflow. - Not offered with
advective_form=conservative_divergence(heat.transfer):total_flux: engine_refuses. - Not offered with
advective_form=conservative_flux(heat.transfer):heat_flux: engine_refuses. - Not offered with
advective_form=conservative_flux(heat.transfer):outflow: layer_rule: outflow_with_conservative_flux. - Not offered with
advective_form=convective(heat.transfer):total_flux: engine_refuses. - Options (heat.transfer):
order:1,2(default2);stabilization:none,supg(defaultnone);advective_form:convective,conservative_divergence,conservative_flux(defaultconvective). - Material blocks (heat.transfer):
thermal,thermal.cp_J_kgK,density. - Uniform over the instance (heat.transfer):
density,thermal.cp_J_kgK. - One expression over the instance (heat.transfer):
thermal.k_W_mK,heat_source,prescribed_advection.velocity. - Element types:
triangle. - Layer rules:
insulation_on_throughflow,outflow_with_conservative_flux,per_depth_keys,geometry_order_exceeds_field_order,uniform_capacity_in_stagnant_part. - one MPI rank.
- triangles only (the transport operator's constructor refuses other elements).
- thermal.k_W_mK and the heat source are one expression over the instance until the transport operator takes data per region.
- one prescribed_advection source covering the whole instance (one velocity per solve), and no flow instance.
- density and thermal.cp_J_kgK are one constant over the instance (one advective capacity per solve).
- stabilization supg needs straight elements (geometry order 1).
- the condition kinds depend on advective_form.
heat_prescribed_advection_axisymmetric¶
- Status: not implemented yet.
- Physics:
heat.transfer; couplings: none; geometry: axisymmetric; study: stationary. - Selected by the sources: heat.transfer:
prescribed_advection. - Engine: transport::ScalarTransport with a callable velocity.
- Needs: the mesher, an MPI build, the fluids library, at most 1 rank.
- Condition kinds offered (heat.transfer):
temperature,heat_flux,total_flux,convection,insulation,outflow. - Not offered with
advective_form=conservative_divergence(heat.transfer):total_flux: engine_refuses. - Not offered with
advective_form=conservative_flux(heat.transfer):heat_flux: engine_refuses. - Not offered with
advective_form=conservative_flux(heat.transfer):outflow: layer_rule: outflow_with_conservative_flux. - Not offered with
advective_form=convective(heat.transfer):total_flux: engine_refuses. - Options (heat.transfer):
order:1,2(default2);stabilization:none,supg(defaultnone);advective_form:convective,conservative_divergence,conservative_flux(defaultconvective). - Material blocks (heat.transfer):
thermal,thermal.cp_J_kgK,density. - Uniform over the instance (heat.transfer):
density,thermal.cp_J_kgK. - One expression over the instance (heat.transfer):
thermal.k_W_mK,heat_source,prescribed_advection.velocity. - Element types:
triangle. - Axisymmetric integrals of the engine: per radian.
- Layer rules:
insulation_on_throughflow,outflow_with_conservative_flux,per_depth_keys,geometry_order_exceeds_field_order,uniform_capacity_in_stagnant_part. - one MPI rank.
- triangles only (the transport operator's constructor refuses other elements).
- thermal.k_W_mK and the heat source are one expression over the instance until the transport operator takes data per region.
- one prescribed_advection source covering the whole instance (one velocity per solve), and no flow instance.
- density and thermal.cp_J_kgK are one constant over the instance (one advective capacity per solve).
- stabilization supg needs straight elements (geometry order 1).
- the condition kinds depend on advective_form.
- the engine's integrals are per radian; the results are 3D totals (times 2 pi).
flow_then_heat_planar¶
- Status: not implemented yet.
- Physics:
fluid.incompressible,heat.transfer; couplings:advection; geometry: planar; study: stationary. - Engine: the flow row's engine (StokesSolver or NavierStokesSolver), then transport::ScalarTransport with the finite-element velocity.
- Needs: the mesher, an MPI build, the fluids library, at most 1 rank.
- Coupling strategies:
one_way(defaultone_way). - Condition kinds offered (heat.transfer):
temperature,heat_flux,total_flux,convection,insulation,outflow. - Not offered with
advective_form=conservative_divergence(heat.transfer):total_flux: engine_refuses. - Not offered with
advective_form=conservative_flux(heat.transfer):heat_flux: engine_refuses. - Not offered with
advective_form=conservative_flux(heat.transfer):outflow: layer_rule: outflow_with_conservative_flux. - Not offered with
advective_form=convective(heat.transfer):total_flux: engine_refuses. - Options (heat.transfer):
order:1,2(default2);stabilization:none,supg(defaultnone);advective_form:convective,conservative_divergence,conservative_flux(defaultconvective). - Material blocks (fluid.incompressible):
fluid. - Material blocks (heat.transfer):
thermal,thermal.cp_J_kgK,density. - Uniform over the instance (heat.transfer):
density,thermal.cp_J_kgK. - One expression over the instance (heat.transfer):
thermal.k_W_mK,heat_source. - Element types:
triangle. - Equal domains: every instance of the row has the same domain.
- Layer rules:
insulation_on_throughflow,outflow_with_conservative_flux,per_depth_keys,geometry_order_exceeds_field_order,uniform_capacity_in_stagnant_part. - Solver settings (fluid.incompressible): those of the row of its own type that the instance's options select in this geometry.
- one MPI rank.
- triangles only (the transport operator's constructor refuses other elements).
- thermal.k_W_mK and the heat source are one expression over the instance until the transport operator takes data per region.
- the flow instance is checked against the Stokes or steady Navier-Stokes row of the same geometry that its equation selects, and solved first; its solver settings are those of that row.
- the flow and heat instances have the same domain (one mesh, no interpolation).
- density and thermal.cp_J_kgK are one constant over the instance, on a Stokes flow too.
- stabilization supg needs straight elements, for the flow as well (one master mesh).
- triangles only for the flow as well (one master mesh).
- the condition kinds depend on advective_form.
- no force output on this row.
flow_then_heat_axisymmetric¶
- Status: not implemented yet.
- Physics:
fluid.incompressible,heat.transfer; couplings:advection; geometry: axisymmetric; study: stationary. - Engine: the flow row's engine (StokesSolver or NavierStokesSolver), then transport::ScalarTransport with the finite-element velocity.
- Needs: the mesher, an MPI build, the fluids library, at most 1 rank.
- Coupling strategies:
one_way(defaultone_way). - Condition kinds offered (heat.transfer):
temperature,heat_flux,total_flux,convection,insulation,outflow. - Not offered with
advective_form=conservative_divergence(heat.transfer):total_flux: engine_refuses. - Not offered with
advective_form=conservative_flux(heat.transfer):heat_flux: engine_refuses. - Not offered with
advective_form=conservative_flux(heat.transfer):outflow: layer_rule: outflow_with_conservative_flux. - Not offered with
advective_form=convective(heat.transfer):total_flux: engine_refuses. - Options (heat.transfer):
order:1,2(default2);stabilization:none,supg(defaultnone);advective_form:convective,conservative_divergence,conservative_flux(defaultconvective). - Material blocks (fluid.incompressible):
fluid. - Material blocks (heat.transfer):
thermal,thermal.cp_J_kgK,density. - Uniform over the instance (heat.transfer):
density,thermal.cp_J_kgK. - One expression over the instance (heat.transfer):
thermal.k_W_mK,heat_source. - Element types:
triangle. - Equal domains: every instance of the row has the same domain.
- Axisymmetric integrals of the engine: per radian.
- Layer rules:
insulation_on_throughflow,outflow_with_conservative_flux,per_depth_keys,geometry_order_exceeds_field_order,uniform_capacity_in_stagnant_part. - Solver settings (fluid.incompressible): those of the row of its own type that the instance's options select in this geometry.
- one MPI rank.
- triangles only (the transport operator's constructor refuses other elements).
- thermal.k_W_mK and the heat source are one expression over the instance until the transport operator takes data per region.
- the flow instance is checked against the Stokes or steady Navier-Stokes row of the same geometry that its equation selects, and solved first; its solver settings are those of that row.
- the flow and heat instances have the same domain (one mesh, no interpolation).
- density and thermal.cp_J_kgK are one constant over the instance, on a Stokes flow too.
- stabilization supg needs straight elements, for the flow as well (one master mesh).
- triangles only for the flow as well (one master mesh).
- the condition kinds depend on advective_form.
- no force output on this row.
- the engine's integrals are per radian; the results are 3D totals (times 2 pi).
boussinesq_planar¶
- Status: not implemented yet.
- Physics:
fluid.incompressible,heat.transfer; couplings:advection,buoyancy; geometry: planar; study: stationary. - Selected by:
equation=navier_stokes. - Engine: BoussinesqSolver.
- Needs: the mesher, an MPI build, the fluids library, at most 1 rank.
- Coupling strategies:
monolithic(defaultmonolithic). - Condition kinds offered (heat.transfer):
temperature,heat_flux,convection,insulation,outflow. - Not offered (heat.transfer):
total_flux: engine_refuses. - Options (heat.transfer):
order:2(default2);stabilization:none,supg(defaultnone);advective_formforced toconvective. - Material blocks (fluid.incompressible):
fluid,density,fluid.beta_1_K. - Material blocks (heat.transfer):
thermal,thermal.cp_J_kgK. - Uniform over the instance (fluid.incompressible):
density,fluid.beta_1_K. - Uniform over the instance (heat.transfer):
thermal.cp_J_kgK. - One expression over the instance (heat.transfer):
thermal.k_W_mK,heat_source. - Element types:
triangle. - Equal domains: every instance of the row has the same domain.
- Layer rules:
insulation_on_throughflow,per_depth_keys,geometry_order_exceeds_field_order,uniform_capacity_in_stagnant_part. - Solver settings (fluid.incompressible):
newton_rtol(number, default1e-12),newton_maxit(integer, default30),line_search(boolean, defaulttrue). - one MPI rank.
- triangles only (the transport operator's constructor refuses other elements).
- thermal.k_W_mK and the heat source are one expression over the instance (the engine's options take one function of position).
- steady only; one monolithic Newton solve of velocity, pressure and temperature.
- the flow instance is checked against the steady Navier-Stokes row of the same geometry.
- gravity along the vertical axis only (y planar, z axisymmetric); T_ref_K is required.
- advective_form is forced to convective (the engine's only energy form).
- the temperature is P2: heat order 1 is refused.
- density, thermal.cp_J_kgK and fluid.beta_1_K are one constant over the instance.
- the flow and heat instances have the same domain.
- stabilization supg needs straight elements.
- no force output on this row (the engine exposes no reaction).
boussinesq_axisymmetric¶
- Status: not implemented yet.
- Physics:
fluid.incompressible,heat.transfer; couplings:advection,buoyancy; geometry: axisymmetric; study: stationary. - Selected by:
equation=navier_stokes. - Engine: BoussinesqSolver.
- Needs: the mesher, an MPI build, the fluids library, at most 1 rank.
- Coupling strategies:
monolithic(defaultmonolithic). - Condition kinds offered (heat.transfer):
temperature,heat_flux,convection,insulation,outflow. - Not offered (heat.transfer):
total_flux: engine_refuses. - Options (heat.transfer):
order:2(default2);stabilization:none,supg(defaultnone);advective_formforced toconvective. - Material blocks (fluid.incompressible):
fluid,density,fluid.beta_1_K. - Material blocks (heat.transfer):
thermal,thermal.cp_J_kgK. - Uniform over the instance (fluid.incompressible):
density,fluid.beta_1_K. - Uniform over the instance (heat.transfer):
thermal.cp_J_kgK. - One expression over the instance (heat.transfer):
thermal.k_W_mK,heat_source. - Element types:
triangle. - Equal domains: every instance of the row has the same domain.
- Axisymmetric integrals of the engine: per radian.
- Layer rules:
insulation_on_throughflow,per_depth_keys,geometry_order_exceeds_field_order,uniform_capacity_in_stagnant_part. - Solver settings (fluid.incompressible):
newton_rtol(number, default1e-12),newton_maxit(integer, default30),line_search(boolean, defaulttrue). - one MPI rank.
- triangles only (the transport operator's constructor refuses other elements).
- thermal.k_W_mK and the heat source are one expression over the instance (the engine's options take one function of position).
- steady only; one monolithic Newton solve of velocity, pressure and temperature.
- the flow instance is checked against the steady Navier-Stokes row of the same geometry.
- gravity along the vertical axis only (y planar, z axisymmetric); T_ref_K is required.
- advective_form is forced to convective (the engine's only energy form).
- the temperature is P2: heat order 1 is refused.
- density, thermal.cp_J_kgK and fluid.beta_1_K are one constant over the instance.
- the flow and heat instances have the same domain.
- stabilization supg needs straight elements.
- no force output on this row (the engine exposes no reaction).
- the engine's integrals are per radian; the results are 3D totals (times 2 pi).
current_distribution_planar¶
- Status: not implemented yet.
- Physics:
electrochem.current_distribution; couplings: none; geometry: planar; study: stationary. - Engine: chem::CurrentDistribution.
- Needs: the mesher, at most 1 rank.
- Condition kinds offered (electrochem.current_distribution):
electrode,insulation,normal_current. - Options (electrochem.current_distribution):
kinetics:primary,secondary(defaultsecondary);order:1,2(default2);T_K: a number (default298.15). - Material blocks (electrochem.current_distribution):
electrolyte. - Element types:
triangle. - Rampable:
phi_s_V,current_A_m. - Layer rules:
per_depth_keys. - Solver settings (electrochem.current_distribution):
newton_rtol(number, default1e-12),newton_maxit(integer, default60). - at least one electrode with a given potential: with every electrode galvanostatic the potential level is free (electrochem.potential_level_free).
- one process.
- order 1 on straight elements only: the engine refuses curved edge nodes with P1.
- a galvanostatic current is per metre of depth (current_A_m).
- rampable: one electrode's phi_s_V or current, through a warm-started continuation.
current_distribution_axisymmetric¶
- Status: not implemented yet.
- Physics:
electrochem.current_distribution; couplings: none; geometry: axisymmetric; study: stationary. - Engine: chem::CurrentDistribution.
- Needs: the mesher, at most 1 rank.
- Condition kinds offered (electrochem.current_distribution):
electrode,insulation,normal_current. - Options (electrochem.current_distribution):
kinetics:primary,secondary(defaultsecondary);order:1,2(default2);T_K: a number (default298.15). - Material blocks (electrochem.current_distribution):
electrolyte. - Element types:
triangle. - Axisymmetric integrals of the engine: per radian.
- Rampable:
phi_s_V,current_A. - Layer rules:
per_depth_keys. - Solver settings (electrochem.current_distribution):
newton_rtol(number, default1e-12),newton_maxit(integer, default60). - at least one electrode with a given potential: with every electrode galvanostatic the potential level is free (electrochem.potential_level_free).
- one process.
- order 1 on straight elements only: the engine refuses curved edge nodes with P1.
- a galvanostatic current is the 3D total (current_A).
- the engine's integrals are per radian; the results are 3D totals (times 2 pi).
- rampable: one electrode's phi_s_V or current, through a warm-started continuation.
current_distribution_3d¶
- Status: not implemented yet.
- Physics:
electrochem.current_distribution; couplings: none; geometry: 3d; study: stationary. - Engine: chem::CurrentDistribution3D.
- Needs: the mesher, an MPI build, the 3D engine, any number of ranks.
- Condition kinds offered (electrochem.current_distribution):
electrode,insulation,normal_current. - Options (electrochem.current_distribution):
kinetics:primary,secondary(defaultsecondary);order:1,2(default2);T_K: a number (default298.15). - Material blocks (electrochem.current_distribution):
electrolyte. - Element types:
tetrahedron. - Rampable:
phi_s_V,current_A. - Layer rules:
per_depth_keys,geometry_order_exceeds_field_order. - Solver settings (electrochem.current_distribution):
newton_rtol(number, default1e-12),newton_maxit(integer, default60). - at least one electrode with a given potential: with every electrode galvanostatic the potential level is free (electrochem.potential_level_free).
- distributed over the MPI ranks; every cell of this row is confirmed against the engine when the row is implemented.
- a galvanostatic current is the 3D total (current_A).
- rampable: one electrode's phi_s_V or current, through a warm-started continuation.
chem_reactor¶
- Status: not implemented yet.
- Physics:
chem.reactor; couplings: none; geometry: no geometry; study: transient. - Engine: chem reactor problems (batch, CSTR, semibatch, constant-pressure gas, adiabatic liquid, plug flow) with the time core.
- Needs: any number of ranks.
- Element types: none.
- no geometry and no mesher.
- no stationary route: the default study is refused with the transient step to write (study.type_not_offered).
Layer rules¶
Rules of this layer that are stricter than the engine on purpose; each route lists the ones it applies.
| rule | what it refuses |
|---|---|
insulation_on_throughflow |
insulation is refused on a boundary that the advecting velocity crosses (heat.insulation_on_throughflow); the engine takes a zero flux anywhere |
outflow_with_conservative_flux |
outflow is refused with the conservative_flux form, where a zero total flux would block the advected heat (on a row without advection too, so that the name means the same on every heat row); the engine takes it as a zero flux and only the Python binding refuses the name, which this layer mirrors |
force_with_laplacian_form |
with the Laplacian viscous form a force output is accepted on walls at rest only (output.force_needs_stress_form), and needs one viscosity over the instance |
per_depth_keys |
an absolute input is written per metre of depth in a planar model (current_A_m, P_W_m) and as the 3D total otherwise (current_A, P_W) (model.per_depth_key) |
geometry_order_exceeds_field_order |
mesh.geometry_order may not exceed the smallest field order of the instances (model.geometry_order_exceeds_field_order) |
uniform_capacity_in_stagnant_part |
density and thermal.cp_J_kgK are one constant over an advected heat instance, in its stagnant parts as well, although a steady solve needs the capacity only where the velocity is not zero |
Reserved instance ids¶
A physics instance may not be called em, mechanics, thermal, electrostatics, hts, fullwave, cavity, mesh_motion.