Function reference
Full-Order Model (FOM)
| fom.fem_utils | Finite element utilities for preconditioning, mesh operations, and nonlinear solving. |
Reduced-Order Model (ROM)
| rom.bilinear_form_rom | Implements reduced-order bilinear form assembly for full-order to reduced-order transformations. |
| rom.linear_form_rom | Implements reduced-order linear form assembly for full-order to reduced-order transformations. |
| rom.rom_error_est | Compute and visualize ROM error metrics for flat data reconstructions. |
| rom.rom_utils | Utilities for ROM workflows. |
DEIM Hyper-Reduction
| rom.deim.bilinear_form_hyperrom_deim | DEIM-based hyperreduction for finite element bilinear forms. |
| rom.deim.linear_form_hyperrom_deim | DEIM-based hyperreduction for finite element linear forms. |
| rom.deim.deim | Discrete Empirical Interpolation Method (DEIM) for nonlinear ROM acceleration. |
| rom.deim.deim_o | Discrete Empirical Interpolation Method (DEIM) for nonlinear ROM acceleration. |
ECM Hyper-Reduction
| rom.ecm.bilinear_form_hyperrom_ecm | ECM-based hyperreduction for finite element bilinear forms. |
| rom.ecm.linear_form_hyperrom_ecm | ECM-based hyperreduction for finite element linear forms. |
| rom.ecm.empirical_cubature_method | |
| rom.ecm.helpers | Helper utilities for ECM-based hyperreduction. |
| rom.ecm.train_ecm |
ECSW Hyper-Reduction
| rom.ecsw.bilinear_form_hyperrom_ecsw | ECSW-based hyperreduction for finite element bilinear forms with element clustering. |
| rom.ecsw.linear_form_hyperrom_ecsw | |
| rom.ecsw.custom_nnls | Implements bounded non-negative least squares (NNLS) for Empirical Cubature Subset Weighting (ECSW). |
| rom.ecsw.hyperreduce | Implements the end-to-end hyper-reduction pipeline combining randomized SVD and bounded NNLS. |
Problem Classes
| problem_classes.masterclass | Static reduced-order modeling (ROM) framework. |
| problem_classes.masterclass_parallel | Parallel implementation of master_class using multithreading for snapshot generation and ROM evaluation. |
Templates
Utilities
| utils.imports | The utils package aggregates frequently used libraries and helper routines for the pyHyperRom framework: |
| utils.hdf5_store | hdf5_arraylist.py |
| utils.save_h5 | hdf5_arraylist.py |
| utils.reduced_basis.svd | |
| utils.dynamics.integrators |
Visualization
| utils.visualization.color_palette | |
| utils.visualization.generate_vtk | VTK export utilities. |
| utils.visualization.generate_vtu | |
| utils.visualization.plot_utils | |
| utils.visualization.vtuwriter |
Command Line Interface
| cli |