Alphabetical index of the public PyMRM API with direct links to source-backed reference pages.
| Name | Module | Summary |
|---|---|---|
pymrm.convect.clam | pymrm.convect | Compute the CLAM TVD correction in normalized-variable space. |
pymrm.convect.construct_convflux_bc | pymrm.convect | Construct boundary-face upwind corrections and source terms. |
pymrm.convect.construct_convflux_upwind | pymrm.convect | Construct a first-order upwind convective-flux operator. |
pymrm.convect.construct_convflux_upwind_int | pymrm.convect | Construct the internal-face upwind advection operator. |
pymrm.convect.minmod | pymrm.convect | Compute the Minmod TVD correction in normalized-variable space. |
pymrm.convect.muscl | pymrm.convect | Compute the MUSCL TVD correction in normalized-variable space. |
pymrm.convect.osher | pymrm.convect | Compute the Osher TVD correction in normalized-variable space. |
pymrm.convect.smart | pymrm.convect | Compute the SMART TVD correction in normalized-variable space. |
pymrm.convect.stoic | pymrm.convect | Compute the STOIC TVD correction in normalized-variable space. |
pymrm.convect.upwind | pymrm.convect | Return zero correction (first-order upwind limiter). |
pymrm.convect.vanleer | pymrm.convect | Compute the van-Leer TVD correction in normalized-variable space. |
pymrm.coupling.construct_interface_matrices | pymrm.coupling | Construct implicit interface-coupling matrices for two adjacent domains. |
pymrm.coupling.translate_indices_to_larger_array | pymrm.coupling | Map flat indices from a local array shape to a larger embedding shape. |
pymrm.coupling.update_array_indices | pymrm.coupling | Update sparse-matrix indices for a new embedding shape. |
pymrm.coupling.update_csc_array_indices | pymrm.coupling | Update CSC matrix row/column indexing for embedding in a larger domain. |
pymrm.coupling.update_csr_array_indices | pymrm.coupling | Update CSR matrix row/column indexing for embedding in a larger domain. |
pymrm.grid.generate_grid | pymrm.grid | Return face coordinates and optionally cell-center coordinates. |
pymrm.grid.non_uniform_grid | pymrm.grid | Generate a one-dimensional stretched face grid. |
pymrm.helpers.construct_coefficient_matrix | pymrm.helpers | Build a sparse coefficient matrix with optional broadcasting and (row, col) coupling. |
pymrm.ibm.IBM | pymrm.ibm | Consolidated IBM crossing data for both sides of an immersed interface. |
pymrm.ibm.apply_ibm | pymrm.ibm | Apply the immersed-boundary method to an operator matrix. |
pymrm.ibm.apply_ibm_vector | pymrm.ibm | Apply the IBM per-row conditioning scale to a flat vector. |
pymrm.ibm.construct_ibm | pymrm.ibm | Build the immersed-boundary data from a spatial signed-distance field. |
pymrm.ibm_coupling.apply_ibm_interface | pymrm.ibm_coupling | Apply general linear interface conditions to an operator matrix. |
pymrm.ibm_coupling.construct_ibm_boundary_values | pymrm.ibm_coupling | Eliminate the interface value of a single side (immersed Robin BC). |
pymrm.ibm_coupling.construct_ibm_interface_values | pymrm.ibm_coupling | Eliminate the interface values for linear interface conditions. |
pymrm.ibm_recon.IBMNormalDerivative | pymrm.ibm_recon | One-sided normal-derivative operators and diagnostics per IBM crossing. |
pymrm.ibm_recon.construct_ibm_normal_derivative | pymrm.ibm_recon | Construct one-sided normal-derivative operators for every IBM crossing. |
pymrm.ibm_recon.construct_ibm_normal_derivative_ops | pymrm.ibm_recon | Expand the reconstruction operators to the full field layout. |
pymrm.ibm_recon.gfd_normal_derivative_weights | pymrm.ibm_recon | GFD weights for a directional derivative at a single interface point. |
pymrm.ibm_recon.interface_normals | pymrm.ibm_recon | Unit interface normals (solid -> fluid) at each wall crossing. |
pymrm.interpolate.compute_boundary_values | pymrm.interpolate | Compute boundary values and boundary-normal gradients. |
pymrm.interpolate.construct_boundary_value_matrices | pymrm.interpolate | Build matrices that evaluate boundary values from cell-centered unknowns. |
pymrm.interpolate.create_staggered_array | pymrm.interpolate | Create a face/staggered field from scalar, centered, or staggered input. |
pymrm.interpolate.interp_cntr_to_stagg | pymrm.interpolate | Interpolate cell-centered values to face/staggered locations. |
pymrm.interpolate.interp_cntr_to_stagg_tvd | pymrm.interpolate | Perform TVD interpolation from cell centers to faces. |
pymrm.interpolate.interp_stagg_to_cntr | pymrm.interpolate | Interpolate face/staggered values to cell centers. |
pymrm.numjac.NumJac | pymrm.numjac | Numerical Jacobian evaluator based on grouped finite differences. |
pymrm.numjac.stencil_block_diagonals | pymrm.numjac | Generate a block-diagonal or block-banded stencil description. |
pymrm.operators.construct_div | pymrm.operators | Construct a divergence matrix that maps face fluxes to cell balances. |
pymrm.operators.construct_grad | pymrm.operators | Construct the full gradient operator including boundary contributions. |
pymrm.operators.construct_grad_bc | pymrm.operators | Construct boundary-face gradient corrections and source terms. |
pymrm.operators.construct_grad_int | pymrm.operators | Construct the interior-face gradient operator. |
pymrm.particles.AnalyticParticle | pymrm.particles | Particle from a user-supplied body-frame level function. |
pymrm.particles.Box | pymrm.particles | Axis-aligned (in body frame) box; rotate via orientation. |
pymrm.particles.GridParticle | pymrm.particles | Particle from level-function samples on its own body-frame grid. |
pymrm.particles.Particle | pymrm.particles | Abstract particle: a shape at a position with an orientation. |
pymrm.particles.ParticleIBMInfo | pymrm.particles | Side-car information produced by construct_ibm_particles. |
pymrm.particles.Sphere | pymrm.particles | Sphere (any dimension; in 2-D this is a disk — see Circle). |
pymrm.particles.construct_ibm_particles | pymrm.particles | Build immersed-boundary data directly from a particle assembly. |
pymrm.particles.contact_conditions | pymrm.particles | Per-crossing ic: base_ic everywhere, a contact condition on contacts. |
pymrm.segmentation.Segmentation | pymrm.segmentation | Per-cell integer labelling of one region of the spatial grid. |
pymrm.segmentation.combine_interface_conditions | pymrm.segmentation | Merge per-segment interface conditions into one per-crossing ic. |
pymrm.segmentation.crossing_segments | pymrm.segmentation | Segment label of the body bounded by each IBM crossing. |
pymrm.segmentation.segment_domain | pymrm.segmentation | Label the disjoint regions of a signed distance field. |
pymrm.segmentation.segment_field | pymrm.segmentation | Expand per-segment values to a per-cell spatial field. |
pymrm.segmentation.segment_values | pymrm.segmentation | Expand per-segment values to a per-crossing array for pymrm.apply_ibm. |
pymrm.segmentation.wall_contact | pymrm.segmentation | Whether each segment reaches each domain wall. |
pymrm.segmentation.wall_patch | pymrm.segmentation | Segment labels on one domain wall, shaped as a full-field coefficient. |
pymrm.segmentation.wall_values | pymrm.segmentation | Per-segment values on one domain wall as a full-field BC coefficient. |
pymrm.solve.clip_approach | pymrm.solve | Project values onto bounds, optionally with a relaxed approach rule. |
pymrm.solve.newton | pymrm.solve | Solve function(x) = 0 with Newton iterations. |