From 94a3043d1bf690ce80fedcfd8f96204186847883 Mon Sep 17 00:00:00 2001 From: Brandon Paul <86113916+bpaul4@users.noreply.github.com> Date: Thu, 1 Aug 2024 11:30:10 -0700 Subject: [PATCH] add code references to gas solid contactors docs (#1451) Co-authored-by: Ludovico Bianchi --- .../gas_solid_contactors/flowsheets/dyn_TGA_example.rst | 9 +++++++++ .../flowsheets/ss_BFB_OC_oxidation.rst | 7 +++++++ .../flowsheets/ss_BFB_methane_combustion.rst | 7 +++++++ .../flowsheets/ss_MB_methane_combustion.rst | 7 +++++++ .../unit_models/bubbling_fluidized_bed.rst | 6 ++++++ .../gas_solid_contactors/unit_models/fixed_bed_0D.rst | 6 ++++++ .../gas_solid_contactors/unit_models/fixed_bed_1D.rst | 8 +++++++- .../gas_solid_contactors/unit_models/moving_bed.rst | 8 +++++++- 8 files changed, 56 insertions(+), 2 deletions(-) diff --git a/docs/reference_guides/model_libraries/gas_solid_contactors/flowsheets/dyn_TGA_example.rst b/docs/reference_guides/model_libraries/gas_solid_contactors/flowsheets/dyn_TGA_example.rst index 8fcc4d5a75..6e37db3815 100644 --- a/docs/reference_guides/model_libraries/gas_solid_contactors/flowsheets/dyn_TGA_example.rst +++ b/docs/reference_guides/model_libraries/gas_solid_contactors/flowsheets/dyn_TGA_example.rst @@ -7,6 +7,15 @@ Dynamic flowsheet example of the fixed bed 0D model for thermogravimetric analys This model is for demonstration and tutorial purposes only. +The model code is located in the `main flowsheet module `_ and may be imported as: + +.. code:: python + + >>> from pyomo.environ import ConcreteModel + >>> from idaes.models_extra.gas_solid_contactors.flowsheets.dyn_TGA_example import main + >>> m = ConcreteModel() + >>> m = main(m) + Inputs: * Gas feed - flowrate, pressure, temperature, composition diff --git a/docs/reference_guides/model_libraries/gas_solid_contactors/flowsheets/ss_BFB_OC_oxidation.rst b/docs/reference_guides/model_libraries/gas_solid_contactors/flowsheets/ss_BFB_OC_oxidation.rst index a3696fd9be..eaa6d35eb1 100644 --- a/docs/reference_guides/model_libraries/gas_solid_contactors/flowsheets/ss_BFB_OC_oxidation.rst +++ b/docs/reference_guides/model_libraries/gas_solid_contactors/flowsheets/ss_BFB_OC_oxidation.rst @@ -7,6 +7,13 @@ Steady-state flowsheet example of the bubbling fluidized bed model for oxidation This model is for demonstration and tutorial purposes only. +The model code is located in the `main flowsheet module `_ and may be imported as: + +.. code:: python + + >>> from idaes.models_extra.gas_solid_contactors.flowsheets.ss_BFB_OC_oxidation import main + >>> m = main() + Inputs: * Bed diameter diff --git a/docs/reference_guides/model_libraries/gas_solid_contactors/flowsheets/ss_BFB_methane_combustion.rst b/docs/reference_guides/model_libraries/gas_solid_contactors/flowsheets/ss_BFB_methane_combustion.rst index 6b8761c2d0..b9b8b7db53 100644 --- a/docs/reference_guides/model_libraries/gas_solid_contactors/flowsheets/ss_BFB_methane_combustion.rst +++ b/docs/reference_guides/model_libraries/gas_solid_contactors/flowsheets/ss_BFB_methane_combustion.rst @@ -7,6 +7,13 @@ Steady-state flowsheet example of the bubbling fluidized bed model for methane c This model is for demonstration and tutorial purposes only. +The model code is located in the `main flowsheet module `_ and may be imported as: + +.. code:: python + + >>> from idaes.models_extra.gas_solid_contactors.flowsheets.ss_BFB_methane_combustion import main + >>> m = main() + Inputs: * Bed diameter diff --git a/docs/reference_guides/model_libraries/gas_solid_contactors/flowsheets/ss_MB_methane_combustion.rst b/docs/reference_guides/model_libraries/gas_solid_contactors/flowsheets/ss_MB_methane_combustion.rst index da36895eb1..5ac5495bc0 100644 --- a/docs/reference_guides/model_libraries/gas_solid_contactors/flowsheets/ss_MB_methane_combustion.rst +++ b/docs/reference_guides/model_libraries/gas_solid_contactors/flowsheets/ss_MB_methane_combustion.rst @@ -7,6 +7,13 @@ Steady-state flowsheet example of the moving bed reactor model for methane combu This model is for demonstration and tutorial purposes only. +The model code is located in the `main flowsheet module `_ and may be imported as: + +.. code:: python + + >>> from idaes.models_extra.gas_solid_contactors.flowsheets.ss_MB_methane_combustion import main + >>> m = main() + Inputs: * Bed diameter diff --git a/docs/reference_guides/model_libraries/gas_solid_contactors/unit_models/bubbling_fluidized_bed.rst b/docs/reference_guides/model_libraries/gas_solid_contactors/unit_models/bubbling_fluidized_bed.rst index 261b2eeed5..01737d0926 100644 --- a/docs/reference_guides/model_libraries/gas_solid_contactors/unit_models/bubbling_fluidized_bed.rst +++ b/docs/reference_guides/model_libraries/gas_solid_contactors/unit_models/bubbling_fluidized_bed.rst @@ -7,6 +7,12 @@ The BFBR model is represented as a 1-D axially discretized model with two phases and two regions (bubble and emulsion). The model captures the gas-solid interaction between both phases and regions through reaction, mass and heat transfer. +The model code is located in the `main unit model module `_ and may be imported as: + +.. code:: python + + >>> from idaes.models_extra.gas_solid_contactors.unit_models.bubbling_fluidized_bed import BubblingFluidizedBed + **Assumptions:** * Cloud-wake region effects are negligible and are not modelled. diff --git a/docs/reference_guides/model_libraries/gas_solid_contactors/unit_models/fixed_bed_0D.rst b/docs/reference_guides/model_libraries/gas_solid_contactors/unit_models/fixed_bed_0D.rst index 6b8f2d4262..94ef3c724e 100644 --- a/docs/reference_guides/model_libraries/gas_solid_contactors/unit_models/fixed_bed_0D.rst +++ b/docs/reference_guides/model_libraries/gas_solid_contactors/unit_models/fixed_bed_0D.rst @@ -6,6 +6,12 @@ solid phase bed. The FixedBed0D mathematical model is a 0-D time variant model with two phases (gas and solid). The model captures the gas-solid interaction between both phases through reaction, mass and heat transfer. +The model code is located in the `main unit model module `_ and may be imported as: + +.. code:: python + + >>> from idaes.models_extra.gas_solid_contactors.unit_models.fixed_bed_0D import FixedBed0D + **Assumptions:** * There is assumed to be no axial or radial variation in solid composition. diff --git a/docs/reference_guides/model_libraries/gas_solid_contactors/unit_models/fixed_bed_1D.rst b/docs/reference_guides/model_libraries/gas_solid_contactors/unit_models/fixed_bed_1D.rst index 06235e78d1..ee62fd08fd 100644 --- a/docs/reference_guides/model_libraries/gas_solid_contactors/unit_models/fixed_bed_1D.rst +++ b/docs/reference_guides/model_libraries/gas_solid_contactors/unit_models/fixed_bed_1D.rst @@ -4,7 +4,13 @@ Fixed Bed 1D Reactor The IDAES Fixed Bed 1D Reactor (FixedBed1D) model represents a unit operation where a gas stream passes through a solid phase bed in a linear reactor vessel. The FixedBed1D mathematical model is a 1-D time variant model with two phases (gas and solid). The model captures the -gas-solid interaction between both phases through reaction/adsorption, mass and heat transfer. +gas-solid interaction between both phases through reaction/adsorption, mass and heat transfer. + +The model code is located in the `main unit model module `_ and may be imported as: + +.. code:: python + + >>> from idaes.models_extra.gas_solid_contactors.unit_models.fixed_bed_1D import FixedBed1D **Assumptions:** diff --git a/docs/reference_guides/model_libraries/gas_solid_contactors/unit_models/moving_bed.rst b/docs/reference_guides/model_libraries/gas_solid_contactors/unit_models/moving_bed.rst index f34ef0fce2..f984bffaad 100644 --- a/docs/reference_guides/model_libraries/gas_solid_contactors/unit_models/moving_bed.rst +++ b/docs/reference_guides/model_libraries/gas_solid_contactors/unit_models/moving_bed.rst @@ -5,7 +5,13 @@ The IDAES Moving Bed Reactor (MBR) model represents a unit operation where two m solid phase and a gas phase – pass through a linear reactor vessel while undergoing chemical reaction(s). The two streams have opposite flow directions (counter-flow). The MBR mathematical model is a 1-D rigorous first-principles model consisting of a set of differential -equations obtained by applying the mass, energy (for each phase) and momentum balance equations. +equations obtained by applying the mass, energy (for each phase) and momentum balance equations. + +The model code is located in the `main unit model module `_ and may be imported as: + +.. code:: python + + >>> from idaes.models_extra.gas_solid_contactors.unit_models.moving_bed import MBR **Assumptions:**