diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 869eac1..198795a 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -20,5 +20,10 @@ build: python: "3.13" jobs: post_build: - - mkdir -p $READTHEDOCS_OUTPUT/html/files - - cp $READTHEDOCS_OUTPUT/pdf/openstream.pdf $READTHEDOCS_OUTPUT/html/files/OpenSTREAM.pdf \ No newline at end of file + - | + PDF_FILE_SRC="$READTHEDOCS_OUTPUT/pdf/openstream.pdf" + PDF_FILE_DST="$READTHEDOCS_OUTPUT/html/files/OpenSTREAM.pdf" + if [ -f "$PDF_FILE_SRC" ]; then + mkdir -p $READTHEDOCS_OUTPUT/html/files + cp "$PDF_FILE_SRC" "$PDF_FILE_DST" + fi \ No newline at end of file diff --git a/docs/source/Applications/database.rst b/docs/source/Applications/database.rst index e4f4264..349d41a 100644 --- a/docs/source/Applications/database.rst +++ b/docs/source/Applications/database.rst @@ -269,9 +269,9 @@ OpenSTREAM-database requires: OpenSTREAM is maintained as a separate repository and must be installed independently. Consult the -`OpenSTREAM installation guide -`_ -for the current MATLAB, Python, CoolProp, and installation requirements. +:doc:`OpenSTREAM installation guide +` for the current MATLAB, Python, CoolProp, and +installation requirements. Installation ------------ diff --git a/docs/source/Applications/projects.rst b/docs/source/Applications/projects.rst index 4ddbf0c..c833fac 100644 --- a/docs/source/Applications/projects.rst +++ b/docs/source/Applications/projects.rst @@ -61,7 +61,7 @@ The workflow reproduces selected calculations and results from the paper: - Figure 7: developing disturbance-wave validation using ``Sawai1989``. `Open the completed NURETH21 companion workflow -`_ +`_ NUTHOS-15 MRM @@ -80,7 +80,7 @@ The workflow reproduces selected calculations and results from the paper: ``Becker1983`` post-boiling-transition cases. `Open the completed NUTHOS15_MRM companion workflow -`_ +`_ ---- diff --git a/docs/source/Guides/tutorials.rst b/docs/source/Guides/tutorials.rst index 1bbff5c..ddba3af 100644 --- a/docs/source/Guides/tutorials.rst +++ b/docs/source/Guides/tutorials.rst @@ -24,7 +24,7 @@ through the links below. -------------- `Open Tutorial 1: Quick Start -`_ +`_ Run a provided OpenSTREAM case using the mixture, two-fluid, three-field, and four-field solver frameworks. This tutorial introduces input loading, @@ -37,7 +37,7 @@ users. ------------------------------ `Open Tutorial 2: Mixture Solver Capabilities -`_ +`_ Explore homogeneous and nonhomogeneous mixture formulations, including fixed-slip and drift-flux models. The tutorial also introduces empirical @@ -50,7 +50,7 @@ calculation. -------------------------------- `Open Tutorial 3: Two-Fluid Solver Capabilities -`_ +`_ Construct and run two-fluid calculations with separate liquid and vapor fields. Examine phase mass flow rates, velocities, enthalpies, @@ -63,7 +63,7 @@ and physical transient behavior. ---------------------------------- `Open Tutorial 4: Three-Field Solver Capabilities -`_ +`_ Model annular flow using separate liquid-film and entrained-droplet fields together with the mixture-model vapor solution. Compare onset-of-annular- @@ -76,7 +76,7 @@ pseudo-time convergence, and transient behavior. --------------------------------- `Open Tutorial 5: Four-Field Solver Capabilities -`_ +`_ Extend the three-field formulation by separating the liquid film into base-film and disturbance-wave fields. Examine film decomposition, wave @@ -89,7 +89,7 @@ terms, pseudo-time convergence, and a physical transient calculation. -------------- `Open Tutorial 6: Input Files -`_ +`_ Learn how OpenSTREAM cases are assembled from physical-model, numerical- option, geometry, and boundary-condition inputs. This tutorial demonstrates @@ -102,7 +102,7 @@ files to JSON. ----------------------------------------------- `Open Tutorial 7: Numerical Convergence and Solver Diagnostics -`_ +`_ Distinguish local pointwise convergence, pseudo-time convergence, and physical-time advancement. Inspect solver states and initialization @@ -115,7 +115,7 @@ converged solution is numerically consistent. --------------------------------- `Open Tutorial 8: Mesh and Time-Step Sensitivity -`_ +`_ Evaluate the sensitivity of mixture-solver results to spatial and temporal discretization. Compare steady-state solutions calculated with different @@ -129,7 +129,7 @@ sensitivity assessment and a systematic convergence study. --------------------------------------------- `Open Tutorial 9: Advanced Visualization and Post-Processing -`_ +`_ Apply the principal OpenSTREAM visualization and post-processing capabilities to a transient solution. Generate animated axial diff --git a/docs/source/_static/html/project_NURETH21.html b/docs/source/_static/html/project_NURETH21.html index cd1778b..febe267 100644 --- a/docs/source/_static/html/project_NURETH21.html +++ b/docs/source/_static/html/project_NURETH21.html @@ -54,7 +54,7 @@ .embeddedOutputsTextElement.rightPaneElement,.embeddedOutputsVariableStringElement.rightPaneElement { min-height: 16px;} .rightPaneElement .textElement { padding-top: 2px; padding-left: 9px;} .S17 { border-left: 1px solid rgb(217, 217, 217); border-right: 1px solid rgb(217, 217, 217); border-top: 1px solid rgb(217, 217, 217); border-bottom: 1px solid rgb(217, 217, 217); border-radius: 4px 4px 0px 0px; padding: 6px 45px 4px 13px; line-height: 18.004px; min-height: 0px; white-space: nowrap; color: rgb(33, 33, 33); font-family: Menlo, Monaco, Consolas, "Courier New", monospace, Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 14px; } -.S18 { border-left: 1px solid rgb(217, 217, 217); border-right: 1px solid rgb(217, 217, 217); border-top: 1px solid rgb(217, 217, 217); border-bottom: 1px solid rgb(217, 217, 217); border-radius: 0px; padding: 6px 45px 4px 13px; line-height: 18.004px; min-height: 0px; white-space: nowrap; color: rgb(33, 33, 33); font-family: Menlo, Monaco, Consolas, "Courier New", monospace, Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 14px; }

banner-transparent.png

NURETH21: OpenSTREAM: An Open-Source Platform for Two-Phase Flow Modeling and Simulation

Companion Live Script for:
J.-M. Le Corre, J. Chan, E. Walter, E. T. Hurlburt, and R. W. Morse, “OpenSTREAM: An open-source platform for two-phase flow modeling and simulation,” 21st International Topical Meeting on Nuclear Reactor Thermal Hydraulics (NURETH-21), Busan, Korea, August 31 to September 5, 2025.
This Live Script is a reproducible computational companion to the NURETH-21 publication. It combines explanatory text, model selections, executable OpenSTREAM calculations, figures, convergence information, and interpretation in a single interactive document.
The workflow reproduces the principal OpenSTREAM calculations associated with Figures 3, 4, 6, and 7 of the publication. Each section explains the purpose of the calculation, the selected models and numerical settings, the quantities shown in the resulting figures, and the principal conclusions.
The companion focuses on the calculations needed to illustrate the published figures and conclusions. It does not include all cases, closure-model development, sensitivity studies, or numerical investigations performed during the underlying research.
Scope and paper mapping
  • Figure 3 compares the mixture, two-fluid, three-field, and four-field frameworks.
  • Figure 4 compares film characteristics predicted by the three-field and four-field frameworks.
  • Figure 6 validates fully developed base-film and disturbance-wave properties using Wurtz1978.
  • Figure 7 validates developing disturbance-wave behavior using Sawai1989.
  • Figure 5 is not generated because the original project does not include the TRACE reference results required for a complete reproduction.
Note: This file is designed for use with output displayed inline (View > Output Inline) in the MATLAB Live Editor.
Table of Contents
1. Setup +.S18 { border-left: 1px solid rgb(217, 217, 217); border-right: 1px solid rgb(217, 217, 217); border-top: 1px solid rgb(217, 217, 217); border-bottom: 1px solid rgb(217, 217, 217); border-radius: 0px; padding: 6px 45px 4px 13px; line-height: 18.004px; min-height: 0px; white-space: nowrap; color: rgb(33, 33, 33); font-family: Menlo, Monaco, Consolas, "Courier New", monospace, Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 14px; }

banner-transparent.png

NURETH21: OpenSTREAM: An Open-Source Platform for Two-Phase Flow Modeling and Simulation

Companion Live Script for:
J.-M. Le Corre, J. Chan, E. Walter, E. T. Hurlburt, and R. W. Morse, “OpenSTREAM: An open-source platform for two-phase flow modeling and simulation,” 21st International Topical Meeting on Nuclear Reactor Thermal Hydraulics (NURETH-21), Busan, Korea, August 31 to September 5, 2025.
This Live Script is a reproducible computational companion to the NURETH-21 publication. It combines explanatory text, model selections, executable OpenSTREAM calculations, figures, convergence information, and interpretation in a single interactive document.
The workflow reproduces the principal OpenSTREAM calculations associated with Figures 3, 4, 6, and 7 of the publication. Each section explains the purpose of the calculation, the selected models and numerical settings, the quantities shown in the resulting figures, and the principal conclusions.
The companion focuses on the calculations needed to illustrate the published figures and conclusions. It does not include all cases, closure-model development, sensitivity studies, or numerical investigations performed during the underlying research.
Scope and paper mapping
  • Figure 3 compares the mixture, two-fluid, three-field, and four-field frameworks.
  • Figure 4 compares film characteristics predicted by the three-field and four-field frameworks.
  • Figure 6 validates fully developed base-film and disturbance-wave properties using Wurtz1978.
  • Figure 7 validates developing disturbance-wave behavior using Sawai1989.
  • Figure 5 is not generated because the original project does not include the TRACE reference results required for a complete reproduction.
Note: This file is designed for use with output displayed inline (View > Output Inline) in the MATLAB Live Editor.
Table of Contents
1. Setup 2. Demonstration case: four solver frameworks 2.1 Lightweight in-memory dataset 2.2 Mixture solution @@ -1052,7 +1052,7 @@ % % Companion Live Script for: % -%
banner-transparent.png

NUTHOS-15: A Mixture Relaxation Model for Thermal Nonequilibrium in Convective Flow Boiling

Companion Live Script for:
J.-M. Le Corre, F. Francois, and H. Anglart, “A Mixture Relaxation Model for Thermal Nonequilibrium in Convective Flow Boiling,” 15th International Topical Meeting on Nuclear Reactor Thermal-Hydraulics, Operation and Safety (NUTHOS-15), Kashiwa-no-ha, Japan, September 28 to October 1, 2026.
This Live Script is a reproducible computational companion to the NUTHOS-15 publication. It combines explanatory text, selected experimental cases, physical-model settings, executable OpenSTREAM calculations, convergence checks, calculated-versus-measured comparisons, and interpretation in a single interactive document.
The workflow reproduces the selected OpenSTREAM calculations associated with Figures 1 to 6 of the paper. It covers two subcooled-boiling cases from the Bartolomey datasets and two post-boiling-transition cases from Becker1983. For each regime, the Mixture Relaxation Model (MRM) is compared with thermal-equilibrium and frozen-flow limiting assumptions.
The companion focuses on the calculations needed to illustrate the published figures and conclusions. It does not include all model-development activities, calibration studies, sensitivity analyses, numerical investigations, or unsuccessful model variants performed during the underlying research.
Scope and paper mapping
  • Figures 1 and 2 show heat-flux partitioning, vapor quantities, measured void fraction, and interfacial-condensation relaxation time for the two subcooled-boiling cases.
  • Figure 3 compares MRM void-fraction predictions with thermal-equilibrium and frozen-flow limits.
  • Figures 4 and 5 show vapor quantities, phase and wall temperatures, measured wall temperature, and interfacial relaxation times for the two post-boiling-transition cases.
  • Figure 6 compares MRM wall-temperature predictions with the two limiting models.
Note: This file is designed for use with output displayed inline (View > Output Inline) in the MATLAB Live Editor.
Table of Contents
1. Setup +.S17 { border-left: 1px solid rgb(217, 217, 217); border-right: 1px solid rgb(217, 217, 217); border-top: 1px solid rgb(217, 217, 217); border-bottom: 0px none rgb(33, 33, 33); border-radius: 0px; padding: 6px 45px 0px 13px; line-height: 18.004px; min-height: 0px; white-space: nowrap; color: rgb(33, 33, 33); font-family: Menlo, Monaco, Consolas, "Courier New", monospace, Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 14px; }
banner-transparent.png

NUTHOS-15: A Mixture Relaxation Model for Thermal Nonequilibrium in Convective Flow Boiling

Companion Live Script for:
J.-M. Le Corre, F. Francois, and H. Anglart, “A Mixture Relaxation Model for Thermal Nonequilibrium in Convective Flow Boiling,” 15th International Topical Meeting on Nuclear Reactor Thermal-Hydraulics, Operation and Safety (NUTHOS-15), Kashiwa-no-ha, Japan, September 28 to October 1, 2026.
This Live Script is a reproducible computational companion to the NUTHOS-15 publication. It combines explanatory text, selected experimental cases, physical-model settings, executable OpenSTREAM calculations, convergence checks, calculated-versus-measured comparisons, and interpretation in a single interactive document.
The workflow reproduces the selected OpenSTREAM calculations associated with Figures 1 to 6 of the paper. It covers two subcooled-boiling cases from the Bartolomey datasets and two post-boiling-transition cases from Becker1983. For each regime, the Mixture Relaxation Model (MRM) is compared with thermal-equilibrium and frozen-flow limiting assumptions.
The companion focuses on the calculations needed to illustrate the published figures and conclusions. It does not include all model-development activities, calibration studies, sensitivity analyses, numerical investigations, or unsuccessful model variants performed during the underlying research.
Scope and paper mapping
  • Figures 1 and 2 show heat-flux partitioning, vapor quantities, measured void fraction, and interfacial-condensation relaxation time for the two subcooled-boiling cases.
  • Figure 3 compares MRM void-fraction predictions with thermal-equilibrium and frozen-flow limits.
  • Figures 4 and 5 show vapor quantities, phase and wall temperatures, measured wall temperature, and interfacial relaxation times for the two post-boiling-transition cases.
  • Figure 6 compares MRM wall-temperature predictions with the two limiting models.
Note: This file is designed for use with output displayed inline (View > Output Inline) in the MATLAB Live Editor.
Table of Contents
1. Setup 2. Subcooled boiling 2.1 Selected cases and model configuration 2.2 MRM calculations and Figures 1–2 @@ -313,7 +313,7 @@ % % Companion Live Script for: % -%