PODImodels 0.0.4

A py package to create ROM utilizing PODI method

PODImodels

PODImodels (Proper Orthogonal Decomposition-based Interpolation Models) is a Python package for creating Reduced-Order Models (ROM) using POD combined with various machine learning techniques. It provides a unified framework for reduced-order modeling of high-dimensional field data, particularly useful for computational fluid dynamics and other physics-based simulations.

Features

• Multiple Interpolation Methods: Support for Linear Regression, Ridge Regression, Gaussian Process Regression (GPR), Radial Basis Functions (RBF), and Artificial Neural Networks (ANN)
• Flexible Modeling Approaches: Choose between direct field prediction or POD coefficient interpolation
• Easy-to-Use API: Scikit-learn-inspired interface with fit() and predict() methods
• Built-in Scaling: Optional data normalization for improved model performance
• Extensible Architecture: Abstract base class for implementing custom interpolation models

Installation

Install PODImodels using pip:

pip install PODImodels

For development installation:

git clone https://github.com/Ruansh233/PODImodels.git
cd PODImodels
pip install -e .

Requirements

• Python >= 3.8
• numpy
• scikit-learn
• scipy
• pyvista
• torch

All dependencies will be automatically installed with the package.

Quick Start

import numpy as np
from PODImodels import PODGPR, fieldsRBF

# Prepare your data
# parameters: (n_samples, n_parameters)
# field_snapshots: (n_samples, n_field_points)
parameters = np.random.rand(100, 3)
field_snapshots = np.random.rand(100, 10000)

# Example 1: POD with Gaussian Process Regression
model = PODGPR(rank=15, with_scaler_x=True, with_scaler_y=True)
model.fit(parameters, field_snapshots)
predictions = model.predict(new_parameters)

# Example 2: Direct field prediction with Radial Basis Functions
model = fieldsRBF(kernel='thin_plate_spline', degree=2)
model.fit(parameters, field_snapshots)
field_prediction = model.predict(test_parameters)

Available Models

PODImodels provides two categories of models:

1. Direct Field Models (fields*): Learn direct mapping from parameters to field values
2. POD Coefficient Models (POD*): Learn mapping from parameters to POD coefficients (more efficient for large fields)

Linear Regression Models

• fieldsLinear: Direct field prediction using linear regression
• PODLinear: POD coefficient prediction using linear regression
• fieldsRidge: Direct field prediction using Ridge regression
• PODRidge: POD coefficient prediction using Ridge regression

Gaussian Process Regression Models

• fieldsGPR: Direct field prediction using Gaussian Process Regression
• PODGPR: POD coefficient prediction using Gaussian Process Regression
• fieldsRidgeGPR: Field prediction with Ridge regularization and GPR
• PODRidgeGPR: POD coefficient prediction with Ridge regularization and GPR

Radial Basis Function Models

• fieldsRBF: Direct field prediction using Radial Basis Function interpolation
• PODRBF: POD coefficient prediction using Radial Basis Function interpolation
• fieldsRidgeRBF: Field prediction with Ridge regularization and RBF
• PODRidgeRBF: POD coefficient prediction with Ridge regularization and RBF

Neural Network Models

• PODANN: POD coefficient prediction using Artificial Neural Networks

Usage Examples

Example 1: POD-GPR for CFD Field Reconstruction

from PODImodels import PODGPR
import numpy as np

# Load your simulation data
# X: Design parameters (e.g., Reynolds number, geometry params)
# Y: Field snapshots (e.g., velocity, pressure fields)
X_train = np.load('parameters.npy')  # shape: (n_samples, n_params)
Y_train = np.load('fields.npy')      # shape: (n_samples, n_points)

# Initialize model with 20 POD modes
model = PODGPR(rank=20, with_scaler_x=True, with_scaler_y=True)

# Train the model
model.fit(X_train, Y_train)

# Predict new fields
X_test = np.array([[100, 0.5, 1.2]])  # New parameter set
Y_pred = model.predict(X_test)

Example 2: Direct Field Interpolation with RBF

from PODImodels import fieldsRBF

# Initialize RBF model
model = fieldsRBF(
    kernel='thin_plate_spline',
    degree=2,
    with_scaler_x=True
)

# Train and predict
model.fit(X_train, Y_train)
Y_pred = model.predict(X_test)

Example 3: Using Neural Networks

from PODImodels import PODANN

# Initialize ANN model
model = PODANN(
    rank=15,
    hidden_layer_sizes=[64, 32],
    activation_function_name='relu',
    num_epochs=100
)

model.fit(X_train, Y_train)
Y_pred = model.predict(X_test)

Writing Results to VTK

PODImodels includes built-in helpers to export fields and reconstructions to VTK (.vtm) so you can visualize results in ParaView or PyVista.

1) Export true/reconstructed/error fields directly from a model

Use reconstruct(...) to write:

• true_i (reference field)
• rec_i (predicted field)
• err_i (difference field)

from PODImodels import PODGPR
import numpy as np

X = np.load("parameters.npy")  # (n_samples, n_params)
Y = np.load("fields.npy")      # (n_samples, n_points) or flattened vectors

model = PODGPR(rank=20, with_scaler_x=True, with_scaler_y=True)
model.reconstruct(
    x=X,
    y=Y,
    refVTMName="reference_mesh.vtm",   # mesh topology/template
    saveFileName="reconstruction_case",# writes reconstruction_case.vtm
    dataType="scalar",                 # or "vector"
    is2D=False,                        # set True for 2D vectors
)

2) Export POD modes to VTK

If you want to inspect POD basis modes:

from PODImodels import PODDataSet
import numpy as np

Y = np.load("fields.npy")
pod = PODDataSet(Y, rank=20, fullData=True)

pod.saveModes(
    saveFileName="pod_modes",
    refVTMName="reference_mesh.vtm",
    dataType="scalar",  # or "vector"
    rank=10,
    is2D=False,
)

This writes:

• pod_modes.vtm
• pod_modes_truncationError.txt
• pod_modes_singulars.txt

3) Low-level VTK writing helper

For full control, call vtk_writer(...) directly:

from PODImodels import vtk_writer

vtk_writer(
    field_data=[field_0, field_1],     # one array per output field
    field_name=["prediction_0", "prediction_1"],
    data_type="scalar",                # or "vector"
    refVTMName="reference_mesh.vtm",
    save_path_name="custom_output",    # writes custom_output.vtm
    is2D=False,
)

Notes:

• refVTMName must point to a valid reference .vtm mesh.
• Use dataType/data_type="vector" for vector fields.
• For 2D vector data, set is2D=True to append a zero z-component for VTK compatibility.

Model Selection Guide

• Linear/Ridge: Fast, interpretable, works well for linear relationships
• GPR: Best for smooth, continuous fields with uncertainty quantification
• RBF: Excellent for scattered data interpolation
• ANN: Powerful for complex nonlinear relationships, requires more data

Choose POD* models when dealing with large field dimensions (>1000 points) for better computational efficiency.

Documentation

For detailed documentation and API reference, visit the GitHub repository.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

Citation

If you use PODImodels in your research, please cite:

@software{PODImodels2024,
  author = {Ruan, Shenhui},
  title = {PODImodels: POD-based Interpolation Models for Reduced-Order Modeling},
  year = {2024},
  url = {https://github.com/Ruansh233/PODImodels}
}

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

Shenhui Ruan
Email: [e-mail]
GitHub: @Ruansh233

Acknowledgments

This package was developed for reduced-order modeling in computational physics applications, with a focus on CFD simulations.