How andytorrestb/rarefiedplume works
rarefiedPlume provides analytical and case-specific tooling for DSMC plume simulations in OpenFOAM. The principal workflow configures a study, generates case inputs and meshes, writes or injects inflow conditions, runs dsmcFoam, then verifies and post-processes results. Separate Cai & Wang and Markelov model families support their distinct physical setups; visualization and statistical-health analysis are additional capabilities. Edges reflect README statements or SOURCE INDEX references; unsampled case-runner and integration details are not expanded beyond documented behavior.
Main entry points: cai2012/generate_cases.py Cai case generation · markelov1999/generate_cases.py Markelov case generation · inflow.py Inflow orchestration · mesh.py Cai mesh planning
Components 27
Shared plume tools
- Case configuration
plumetools/config.py - Legacy source flow
plumetools/sourceflow.py - Inflow orchestration
plumetools/inflow.py - Mesh readers
plumetools/mesh/boundary.py - OpenFOAM I/O
plumetools/foamio
Cai 2012 family
- Cai configuration
plumetools/cai2012/config.py - Gas properties
plumetools/cai2012/gas.py - Nozzle geometry
plumetools/cai2012/geometry.py - Collisionless solution
plumetools/cai2012/analytical.py - Cai mesh planning
plumetools/cai2012/mesh.py - Study generation
plumetools/cai2012/study.py - Cai case generation
cases/cai2012/generate_cases.py - Cai post-processing
plumetools/cai2012/post.py - Statistical health
plumetools/cai2012/health.py
Markelov 1999 family
- Cylinder geometry
plumetools/markelov1999/geometry.py - Markelov study
plumetools/markelov1999/study.py - Markelov post-process
plumetools/markelov1999/postprocess.py - Markelov case generation
cases/markelov1999/generate_cases.py
DSMC runtime
- Patch inflow model
applications/dsmcBoundaryModels/plumeFieldInflow/plumeFieldInflow.C - dsmcFoam
Analysis and visualization
- Parcel occupancy audit
plumetools/cai2012/audit.py - Visualization specification
plumetools/viz/spec.py - Visualization catalog
plumetools/viz/catalog.py - ParaView rendering
plumetools/viz/render.py - Health analysis
cases/cai2012-health/analyse.py
Other components
- Researcher
- OpenFOAM studies
Connections 33
- Researcher → OpenFOAM studies: configures and runs
README.md - OpenFOAM studies → Case configuration: sets inputs
README.md - Case configuration → Inflow orchestration: configures
plumetools/inflow.py - Inflow orchestration → Legacy source flow: evaluates
plumetools/inflow.py - Inflow orchestration → Mesh readers: reads mesh
plumetools/inflow.py - OpenFOAM studies → OpenFOAM I/O: writes fields
README.md - Researcher → Cai case generation: generates cases
README.md - Cai case generation → Cai configuration: loads configuration
cases/cai2012/generate_cases.py - Cai case generation → Cai mesh planning: uses mesh plan
cases/cai2012/generate_cases.py - Cai case generation → Nozzle geometry: uses geometry
cases/cai2012/generate_cases.py - Cai configuration → Gas properties: uses gas model
plumetools/cai2012/config.py - Cai mesh planning → Nozzle geometry: uses geometry
plumetools/cai2012/mesh.py - Cai mesh planning → Collisionless solution: uses solution
plumetools/cai2012/mesh.py - Cai case generation → Study generation: loads study
cases/cai2012/generate_cases.py - Cai post-processing → Collisionless solution: compares solution
plumetools/cai2012/post.py - Statistical health → Study generation: uses study
plumetools/cai2012/health.py - Statistical health → Markelov study: uses study
plumetools/cai2012/health.py - Parcel occupancy audit → Cai post-processing: reads metrics
plumetools/cai2012/audit.py - Researcher → Markelov case generation: generates cases
README.md - Markelov case generation → Case configuration: loads configuration
cases/markelov1999/generate_cases.py - Markelov case generation → Cylinder geometry: uses geometry
cases/markelov1999/generate_cases.py - Markelov case generation → Markelov study: loads study
cases/markelov1999/generate_cases.py - Markelov post-process → Cylinder geometry: uses geometry
plumetools/markelov1999/postprocess.py - OpenFOAM studies → Patch inflow model: injects patch inflow
README.md - Patch inflow model → dsmcFoam: adds parcels
applications/dsmcBoundaryModels/plumeFieldInflow/plumeFieldInflow.C - Researcher → Visualization specification: defines plots
README.md - Visualization specification → Visualization catalog: uses catalog
plumetools/viz/spec.py - ParaView rendering → Visualization specification: renders specification
plumetools/viz/render.py - ParaView rendering → Visualization catalog: uses catalog
plumetools/viz/render.py - Health analysis → Statistical health: builds health table
cases/cai2012-health/analyse.py - Health analysis → Parcel occupancy audit: audits occupancy
cases/cai2012-health/analyse.py - dsmcFoam → Cai post-processing: produces simulation output
README.md - dsmcFoam → Markelov post-process: produces simulation output
README.md