turbigen 2.3.0__tar.gz → 2.4.0__tar.gz

{turbigen-2.3.0 → turbigen-2.4.0}/.gitignore

@@ -1,4 +1,6 @@
 venv
+.coverage
+plug
 uv.lock
 tests/back-to-back/*/emb
 doc/examples/*.rst

{turbigen-2.3.0 → turbigen-2.4.0}/.gitlab-ci.yml

@@ -36,13 +36,11 @@ build_wheels:
 
 profile:
   stage: test
-  artifacts:
-    paths:
-      - plots
   script:
     - uv pip install .[parallel]
     # Serial profiling.
-    - ./scripts/profile.sh
+    - OMP_NUM_THREADS=1 LINE_PROFILE=1 turbigen examples/axial_turbine.yaml -I
+    - cat profile_output.txt
     # Now parallel benchmarking
     - ./scripts/benchmark.sh
 
@@ -67,6 +65,7 @@ doc:
   script:
     - python doc/generate_examples.py
     - python doc/generate_meanline.py
+    - python doc/generate_data_structures.py
     - sphinx-build -W doc doc/_build
 
 pages:

{turbigen-2.3.0 → turbigen-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: turbigen
-Version: 2.3.0
+Version: 2.4.0
 Summary: Framework for turbomachinery design and computational fluid dynamics simulation
 Keywords: turbomachinery,computational fluid dynamics,compressor,turbine
 Author-Email: James Brind <jb753@cam.ac.uk>

{turbigen-2.3.0 → turbigen-2.4.0}/doc/changelog.rst

@@ -1,6 +1,15 @@
 Changelog
 =========
 
+v2.4.0
+^^^^^^
+
+* Add exit throttling to ember solver
+* Allow profiling the code speed by exporting LINE_PROFILE=1
+* Bug fix for Lieblein diffusion factor
+* Bug fix for rotor-only mean-line check
+* Finish tutorial
+
 v2.3.0
 ^^^^^^
 

turbigen-2.4.0/doc/data_structures.rst

@@ -0,0 +1,319 @@
+
+Data Structures
+===============
+
+This page documents the internal data structures used in :program:`turbigen`.
+It is intended as a reference for users extending the program using custom
+plugins or developers modifying the source code.
+
+
+Working fluids
+--------------
+
+Both perfect and real working fluids are represented by a :class:`State`
+class, which has a common interface for setting and reading thermodynamic
+properties. The interface allows the same mean-line design code to work
+with any working fluid. :class:`State` does not store velocity information
+and hence makes no distinction between static and stagnation states, the
+handling of which is left to the calling code.
+
+Setter methods
+^^^^^^^^^^^^^^
+
+The following methods are used to set the thermodynamic state of the fluid
+to a new value. The object is updated in-place; a copy can be explicitly
+created using :meth:`State.copy`. By the two-property rule, the setters all
+take two arguments to uniquely specify the thermodynamic state. The
+following methods are available:
+
+.. list-table::
+   :widths: 50 25 25
+   :header-rows: 1
+
+   * - Method
+     - Arguments
+     -
+   * - ``State.set_h_s(h, s)``
+     - Enthalpy
+     - Entropy
+   * - ``State.set_P_h(P, h)``
+     - Pressure
+     - Enthalpy
+   * - ``State.set_P_rho(P, rho)``
+     - Pressure
+     - Density
+   * - ``State.set_P_s(P, s)``
+     - Pressure
+     - Entropy
+   * - ``State.set_P_T(P, T)``
+     - Pressure
+     - Temperature
+   * - ``State.set_rho_u(rho, u)``
+     - Density
+     - Internal energy
+
+Property attributes
+^^^^^^^^^^^^^^^^^^^
+
+Thermodynamic and transport properties of the fluid are accessed as attributes of the
+:class:`State` object. The following properties are available:
+
+.. list-table::
+   :widths: 25 55 20
+   :header-rows: 1
+
+   * - Property
+     - Description
+     - Units
+
+   * - ``State.a``
+     - Acoustic speed
+     - m/s
+   * - ``State.cp``
+     - Specific heat at constant pressure
+     - J/kg/K
+   * - ``State.cv``
+     - Specific heat at constant volume
+     - J/kg/K
+   * - ``State.gamma``
+     - Ratio of specific heats
+     - --
+   * - ``State.h``
+     - Specific enthalpy
+     - J/kg
+   * - ``State.mu``
+     - Kinematic viscosity
+     - m^2/s
+   * - ``State.P``
+     - Pressure
+     - Pa
+   * - ``State.Pr``
+     - Prandtl number
+     - --
+   * - ``State.rgas``
+     - Specific gas constant
+     - J/kg/K
+   * - ``State.rho``
+     - Density
+     - kg/m^3
+   * - ``State.s``
+     - Specific entropy
+     - J/kg/K
+   * - ``State.T``
+     - Temperature
+     - K
+   * - ``State.u``
+     - Specific internal energy
+     - J/kg
+
+Flow fields
+-----------
+
+Augmenting a thermodynamic state with velocity and coordinate data
+allows the :class:`FlowField` class to represent a flow field.
+Composite properties such as stagnation pressure and Mach number
+can then be computed from the thermodynamic state and velocity vector.
+Setting an angular velocity allows evaluation of quantities in a rotating
+frame. Circumferential periodicity is represented by a number of blades.
+
+Setter methods
+^^^^^^^^^^^^^^
+
+The :class:`FlowField` class has the same thermodynamic setter methods as
+the :class:`State` class. Velocity and coordinate data are set directly
+by assigning to the corresponding attributes.
+
+Property attributes
+^^^^^^^^^^^^^^^^^^^
+
+In addition to all the pure thermodynamic properties defined in
+:class:`State`, incorporating velocity and coordinate data allow the
+:class:`FlowField` to provide the following other properties:
+
+.. list-table::
+   :widths: 25 60 15
+   :header-rows: 1
+
+   * - Property
+     - Description
+     - Units
+
+   * - ``FlowField.Alpha``
+     - Yaw angle
+     - deg
+   * - ``FlowField.Alpha_rel``
+     - Relative frame yaw angle
+     - deg
+   * - ``FlowField.ao``
+     - Stagnation acoustic speed
+     - m/s
+   * - ``FlowField.Beta``
+     - Pitch angle
+     - deg
+   * - ``FlowField.e``
+     - Specific total energy
+     - J/kg
+   * - ``FlowField.halfVsq``
+     - Specific kinetic energy
+     - J/kg
+   * - ``FlowField.halfVsq_rel``
+     - Relative frame specific kinetic energy
+     - J/kg
+   * - ``FlowField.ho``
+     - Stagnation specific enthalpy
+     - J/kg
+   * - ``FlowField.ho_rel``
+     - Relative frame stagnation specific enthalpy
+     - J/kg
+   * - ``FlowField.I``
+     - Rothalpy
+     - J/kg
+   * - ``FlowField.Ma``
+     - Mach number
+     - --
+   * - ``FlowField.Ma_rel``
+     - Relative frame Mach number
+     - --
+   * - ``FlowField.Omega``
+     - Reference frame angular velocity
+     - rad/s
+   * - ``FlowField.Po``
+     - Stagnation pressure
+     - Pa
+   * - ``FlowField.Po_rel``
+     - Relative frame stagnation pressure
+     - Pa
+   * - ``FlowField.r``
+     - Radial coordinate
+     - m
+   * - ``FlowField.rhoe``
+     - Volumetric total energy
+     - J/m^3
+   * - ``FlowField.rhorVt``
+     - Volumetric angular momentum
+     - kg/m^2/s
+   * - ``FlowField.rhoVr``
+     - Volumetric radial momentum
+     - kg/m^2/s
+   * - ``FlowField.rhoVt``
+     - Volumetric angular momentum
+     - kg/m^2/s
+   * - ``FlowField.rhoVx``
+     - Volumetric axial momentum
+     - kg/m^2/s
+   * - ``FlowField.rpm``
+     - Reference frame revolutions per minute
+     - rpm
+   * - ``FlowField.t``
+     - Circumferential coordinate
+     - rad
+   * - ``FlowField.tanAlpha``
+     - Tangent of yaw angle
+     - --
+   * - ``FlowField.tanAlpha_rel``
+     - Tangent of relative frame yaw angle
+     - --
+   * - ``FlowField.tanBeta``
+     - Tangent of pitch angle
+     - --
+   * - ``FlowField.To``
+     - Stagnation temperature
+     - K
+   * - ``FlowField.To_rel``
+     - Relative frame stagnation temperature
+     - K
+   * - ``FlowField.U``
+     - Blade speed
+     - m/s
+   * - ``FlowField.V``
+     - Absolute velocity magnitude
+     - m/s
+   * - ``FlowField.V_rel``
+     - Relative frame velocity magnitude
+     - m/s
+   * - ``FlowField.Vm``
+     - Meridional velocity magnitude
+     - m/s
+   * - ``FlowField.Vr``
+     - Radial velocity
+     - m/s
+   * - ``FlowField.Vt``
+     - Circumferential velocity
+     - m/s
+   * - ``FlowField.Vt_rel``
+     - Relative frame circumferential velocity
+     - m/s
+   * - ``FlowField.Vx``
+     - Axial velocity
+     - m/s
+   * - ``FlowField.x``
+     - Axial coordinate
+     - m
+
+Mean line
+---------
+
+The :class:`MeanLine` class encapsulates the quasi-one-dimensional geometry
+and flow field of a turbomachine. In addition to thermodynamic states and
+velocity vectors, it also contains a root-mean-square radii and annulus
+areas. Assuming the span is perpendicular to the mean-line pitch angle,
+These data are sufficient to determine hub and tip radii, and
+the midspan blade angles.
+
+Property attributes
+^^^^^^^^^^^^^^^^^^^
+
+In addition to the properties defined in
+:class:`State` and
+:class:`FlowField`, the :class:`MeanLine` class provides the following
+
+.. list-table::
+   :widths: 25 60 15
+   :header-rows: 1
+
+   * - Property
+     - Description
+     - Units
+
+   * - ``MeanLine.A``
+     - Annulus area
+     - m^2
+   * - ``MeanLine.eta_poly``
+     - Total-to-total polytropic efficiency
+     - --
+   * - ``MeanLine.eta_ts``
+     - Total-to-static isentropic efficiency
+     - --
+   * - ``MeanLine.eta_tt``
+     - Total-to-total isentropic efficiency
+     - --
+   * - ``MeanLine.htr``
+     - Hub-to-tip radius ratio
+     - --
+   * - ``MeanLine.mdot``
+     - Mass flow rate
+     - kg/s
+   * - ``MeanLine.Nb``
+     - Number of blades
+     - --
+   * - ``MeanLine.PR_ts``
+     - Total-to-static pressure ratio
+     - --
+   * - ``MeanLine.PR_tt``
+     - Total-to-total pressure ratio
+     - --
+   * - ``MeanLine.rhub``
+     - Hub radius
+     - m
+   * - ``MeanLine.rmid``
+     - Midspan radius
+     - m
+   * - ``MeanLine.rrms``
+     - Root-mean-square radius
+     - m
+   * - ``MeanLine.rtip``
+     - Tip radius
+     - m
+   * - ``MeanLine.span``
+     - Span
+     - m

turbigen-2.4.0/doc/generate_data_structures.py

@@ -0,0 +1,199 @@
+"""Make documentation for fluid, flowfield, meanline data structures."""
+
+import turbigen.abstract
+import inspect
+
+prop_names = {
+    "rho": "Density",
+    "u": "Internal energy",
+    "T": "Temperature",
+    "P": "Pressure",
+    "h": "Enthalpy",
+    "s": "Entropy",
+}
+
+
+def generate_fluid(cls):
+    rst_str = ""
+
+    # Base class first
+    doc = inspect.getdoc(cls)
+    rst_str += doc
+
+    # Get names of setter methods
+    setters = [
+        m[0]
+        for m in inspect.getmembers(cls, predicate=inspect.isfunction)
+        if m[0].startswith("set_")
+    ]
+    setters.sort(key=str.lower)
+
+    # Start table
+    setter_str = ".. list-table::\n   :widths: 50 25 25\n   :header-rows: 1\n\n"
+    setter_str += "   * - Method\n     - Arguments\n     - "
+    for method in setters:
+        props = method.split("_")[1:]
+        methods_str = f"   * - ``{cls.__name__}.{method}({', '.join(props)})``"
+        params_str = "\n     - ".join([prop_names[p] for p in props])
+        setter_str += f"\n{methods_str}\n     - {params_str}"
+
+    rst_str = rst_str.replace("xxx", setter_str)
+
+    # Get names and docstrings of quantities that use @property decorator
+    quantities = [
+        m[0]
+        for m in inspect.getmembers(cls)
+        if isinstance(m[1], property) and not m[0].startswith("_")
+    ]
+    quantities.sort(key=str.lower)
+    # Start quantities table
+    quantities_str = ".. list-table::\n   :widths: 25 55 20\n   :header-rows: 1\n\n"
+    quantities_str += "   * - Property\n     - Description\n     - Units\n"
+    for quantity in quantities:
+        doc = inspect.getdoc(getattr(cls, quantity))
+        # get units
+        if not doc:
+            continue
+        split = doc.split(" [")
+        name = split[0]
+        if len(split) == 1:
+            units = ""
+        else:
+            units = split[1]
+        units = units.split("]")[0]
+        quantities_str += (
+            f"\n   * - ``{cls.__name__}.{quantity}``\n     - {name}\n     - {units}"
+        )
+    rst_str = rst_str.replace("yyy", quantities_str)
+
+    return rst_str
+
+
+def generate_flowfield(cls):
+    rst_str = ""
+
+    # Base class first
+    doc = inspect.getdoc(cls)
+    rst_str += doc
+
+    # Get names of setter methods
+    setters = [
+        m[0]
+        for m in inspect.getmembers(cls, predicate=inspect.isfunction)
+        if m[0].startswith("set_")
+    ]
+    setters.sort(key=str.lower)
+
+    # Start table
+    setter_str = ".. list-table::\n   :widths: 65 35\n   :header-rows: 1\n\n"
+    setter_str += "   * - Method\n     - Arguments\n"
+    for method in setters:
+        args = [
+            k
+            for k in inspect.signature(getattr(cls, method)).parameters.keys()
+            if k != "self"
+        ]
+        methods_str = f"   * - ``{cls.__name__}.{method}({', '.join(args)})``"
+        doc = inspect.getdoc(getattr(cls, method)).splitlines()[0].strip(".")
+        setter_str += f"\n{methods_str}\n     - {doc}"
+
+    rst_str = rst_str.replace("xxx", setter_str)
+
+    # Get names and docstrings of quantities that use @property decorator
+    quantities = [m[0] for m in inspect.getmembers(cls) if not m[0].startswith("_")]
+    quantities.sort(key=str.lower)
+    # Start quantities table
+    quantities_str = ".. list-table::\n   :widths: 25 60 15\n   :header-rows: 1\n\n"
+    quantities_str += "   * - Property\n     - Description\n     - Units\n"
+    for quantity in quantities:
+        doc = inspect.getdoc(getattr(cls, quantity))
+        try:
+            assert len(doc.split(" [")) == 2
+            assert "\n" not in doc
+            name, units = doc.split(" [")
+        except (AttributeError, ValueError, AssertionError):
+            continue
+        units = units.split("]")[0]
+        quantities_str += (
+            f"\n   * - ``{cls.__name__}.{quantity}``\n     - {name}\n     - {units}"
+        )
+    rst_str = rst_str.replace("yyy", quantities_str)
+
+    return rst_str
+
+
+def generate_meanline(cls):
+    rst_str = ""
+
+    # Base class first
+    doc = inspect.getdoc(cls)
+    rst_str += doc
+
+    # Get names of setter methods
+    setters = [
+        m[0]
+        for m in inspect.getmembers(cls, predicate=inspect.isfunction)
+        if m[0].startswith("set_")
+    ]
+    setters.sort(key=str.lower)
+
+    # Start table
+    setter_str = ".. list-table::\n   :widths: 65 35\n   :header-rows: 1\n\n"
+    setter_str += "   * - Method\n     - Arguments\n"
+    for method in setters:
+        args = [
+            k
+            for k in inspect.signature(getattr(cls, method)).parameters.keys()
+            if k != "self"
+        ]
+        methods_str = f"   * - ``{cls.__name__}.{method}({', '.join(args)})``"
+        doc = inspect.getdoc(getattr(cls, method)).splitlines()[0].strip(".")
+        setter_str += f"\n{methods_str}\n     - {doc}"
+
+    rst_str = rst_str.replace("xxx", setter_str)
+
+    # Get names and docstrings of quantities that use @property decorator
+    quantities = [m[0] for m in inspect.getmembers(cls) if not m[0].startswith("_")]
+    quantities.sort(key=str.lower)
+    # Start quantities table
+    quantities_str = ".. list-table::\n   :widths: 25 60 15\n   :header-rows: 1\n\n"
+    quantities_str += "   * - Property\n     - Description\n     - Units\n"
+    for quantity in quantities:
+        doc = inspect.getdoc(getattr(cls, quantity))
+        try:
+            assert len(doc.split(" [")) == 2
+            assert "\n" not in doc
+            name, units = doc.split(" [")
+        except (AttributeError, ValueError, AssertionError):
+            continue
+        units = units.split("]")[0]
+        quantities_str += (
+            f"\n   * - ``{cls.__name__}.{quantity}``\n     - {name}\n     - {units}"
+        )
+    rst_str = rst_str.replace("yyy", quantities_str)
+
+    return rst_str
+
+
+if __name__ == "__main__":
+    state_str = generate_fluid(turbigen.abstract.State)
+
+    rst_str = """
+Data Structures
+===============
+
+This page documents the internal data structures used in :program:`turbigen`.
+It is intended as a reference for users extending the program using custom
+plugins or developers modifying the source code.
+
+
+"""
+
+    rst_str += state_str + "\n\n"
+
+    rst_str += generate_flowfield(turbigen.abstract.FlowField)
+    rst_str += "\n\n"
+    rst_str += generate_flowfield(turbigen.abstract.MeanLine)
+    # Write the rst string to a file
+    with open("doc/data_structures.rst", "w") as f:
+        f.write(rst_str)

{turbigen-2.3.0 → turbigen-2.4.0}/doc/index.rst

@@ -9,17 +9,27 @@
 This documentation contains
 usage instructions, descriptions of the theory involved, and listings of configuration options.
 
+Publications using :program:`turbigen`:
+
+- Brind, J., "Data-driven radial compressor design space mapping". *J. Turbomach.* :cite:`Brind2024`.
+
+- Torres-Gomez, A., Brind, J., and Pullan, G. "Cryogenic Radial Turbine Design for High-Efficiency Hydrogen Liquefaction Plants". *ASME Turbo Expo 2025* :cite:`TorresGomez2025`.
+
+
 User manual
 ===========
 .. toctree::
    :maxdepth: 2
 
    quickstart
+   tutorial
    nomenclature
    usage
+   data_structures
    meanline
    solver
    examples/index
    changelog
    license
+   Source code repository <https://gitlab.developers.cam.ac.uk/jb753/turbigen>
    references

{turbigen-2.3.0 → turbigen-2.4.0}/doc/nomenclature.rst

@@ -8,6 +8,29 @@ General conventions for variable names:
 * Stagnation quantities are denoted by a subscript letter oh: `Po`, `ho_rel`.
 * Depending on context, concatenation of symbols is either: a product, such as `rhoVx`; or a stack along the first array dimension, like `xrt`.
 
+The yaw angle, `Alpha` or :math:`\alpha`, is defined as the angle between the flow direction and
+the meridional direction:
+
+.. math::
+    \alpha = \arctan\left(\frac{V_\theta}{V_m}\right)
+
+where :math:`V_\theta` is the tangential and :math:`V_m` the meridional
+components of flow velocity. In the rotating frame, the relative yaw angle,
+`Alpha_rel` or :math:`\alpha^\mathrm{rel}`, is defined as:
+
+.. math::
+    \alpha^\mathrm{rel} = \arctan\left(\frac{V_\theta^\mathrm{rel}}{V_m}\right)
+
+The pitch angle, `Beta`, is defined as the angle between
+the meridional flow direction and the axial direction:
+
+.. math::
+    \beta = \arctan\left(\frac{V_r}{V_x}\right)
+
+where :math:`V_r` is the radial velocity component. Throughout the code, angles
+have units of degrees.
+
+
 =========== ============================================ =======
  Symbol      Quantity                                     Units
 =========== ============================================ =======

{turbigen-2.3.0 → turbigen-2.4.0}/doc/refs.bib

@@ -78,3 +78,21 @@
   year = {1992},
   pages = {18–26}
 }
+
+@article{Brind2024,
+  title = {{Data-Driven Radial Compressor Design Space Mapping}},
+  volume = {147},
+  DOI = {10.1115/1.4066229},
+  number = {2},
+  journal = {J. Turbomach.},
+  author = {Brind,  J.},
+  year = {2024}
+}
+
+
+@article{TorresGomez2025,
+    author = {A. Torres-Gomez, J. Brind, and G. Pullan},
+    title = {{Cryogenic Radial Turbine Design for High-Efficiency Hydrogen Liquefaction Plants}},
+    journal = {ASME Turbo Expo},
+    year = {2025},
+}