turbigen 2.3.0__tar.gz → 2.7.0__tar.gz

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

@@ -1,4 +1,6 @@
 venv
+.coverage
+plug
 uv.lock
 tests/back-to-back/*/emb
 doc/examples/*.rst
@@ -41,3 +43,5 @@ tests/*.log
 /build/
 *.prof
 tests/bench.dat
+src/ember/*wrapper*
+src/ember/embercmodule.c

turbigen-2.7.0/.gitlab-ci.yml

@@ -0,0 +1,99 @@
+image: python:3.11
+
+stages:
+- build
+- test
+- deploy
+- publish
+
+
+before_script:
+  - curl -LsSf https://astral.sh/uv/install.sh | sh
+  - source $HOME/.local/bin/env
+  - uv venv
+  - source .venv/bin/activate
+
+variables:
+  UV_CACHE_DIR: "$CI_PROJECT_DIR/.uv-cache"
+  DOCKER_HOST: unix:///var/run/docker.sock
+  DOCKER_TLS_CERTDIR: ""
+
+build_test_wheel:
+  stage: build
+  script:
+    - apt update && apt install -y gfortran
+    - ./scripts/generate_meson.sh
+    - curl -sSL https://get.docker.com/ | sh
+    - uv pip install cibuildwheel
+    - cibuildwheel --only cp311-manylinux_x86_64 --output-dir dist .
+    - python -m build --sdist
+    - ls -l dist
+  artifacts:
+    expire_in: 2 hours
+    paths:
+      - dist
+
+tests:
+  stage: test
+  script:
+    - uv pip install dist/*.whl pytest
+    - pytest --slow
+
+profile:
+  stage: deploy
+  script:
+    - apt update && apt install -y gfortran libopenmpi-dev
+    - uv pip install mpi4py line_profiler==4.2.0 dist/*.whl
+    # Serial profiling.
+    - OMP_NUM_THREADS=1 LINE_PROFILE=1 turbigen examples/axial_turbine.yaml -I
+    - cat profile_output.txt
+    # Now parallel benchmarking
+    - ./scripts/benchmark.sh
+
+doc:
+  stage: deploy
+  artifacts:
+    paths:
+      - doc/_build
+  script:
+    - apt update && apt install -y pdf2svg fonts-freefont-ttf
+    - uv pip install dist/*.whl sphinx sphinx-autobuild sphinx-argparse sphinxcontrib-programoutput sphinxcontrib-bibtex snowballstemmer==2.2.0 autodocsumm
+    - python doc/generate_examples.py
+    - python doc/generate_meanline.py
+    - python doc/generate_data_structures.py
+    - sphinx-build -W doc doc/_build
+
+build_all_wheels:
+  stage: deploy
+  script:
+    - apt update && apt install -y gfortran
+    - ./scripts/generate_meson.sh
+    - curl -sSL https://get.docker.com/ | sh
+    - uv pip install cibuildwheel
+    - cibuildwheel --platform linux --output-dir dist .
+    - python -m build --sdist
+    - ls -l dist
+  artifacts:
+    expire_in: 1 day
+    paths:
+      - dist
+
+pypi:
+  stage: publish
+  script:
+    - uv pip install twine
+    - ls -l dist
+    - twine upload dist/*
+  only:
+    - master
+
+
+pages:
+  stage: publish
+  script:
+    - mv doc/_build public
+  artifacts:
+    paths:
+      - public
+  only:
+  - master

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: turbigen
-Version: 2.3.0
+Version: 2.7.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>
@@ -19,21 +19,6 @@ Requires-Dist: scipy~=1.15.0
 Requires-Dist: h5py~=3.13.0
 Requires-Dist: numpy-stl~=3.2.0
 Requires-Dist: metis~=0.2a5
-Provides-Extra: dev
-Requires-Dist: sphinx; extra == "dev"
-Requires-Dist: sphinx-autobuild; extra == "dev"
-Requires-Dist: sphinx-argparse; extra == "dev"
-Requires-Dist: sphinxcontrib-programoutput; extra == "dev"
-Requires-Dist: sphinxcontrib-bibtex; extra == "dev"
-Requires-Dist: snowballstemmer==2.2.0; extra == "dev"
-Requires-Dist: autodocsumm; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: build; extra == "dev"
-Requires-Dist: cibuildwheel; extra == "dev"
-Requires-Dist: twine; extra == "dev"
-Requires-Dist: bump-my-version; extra == "dev"
-Requires-Dist: setuptools; extra == "dev"
 Provides-Extra: parallel
 Requires-Dist: mpi4py~=3.1.6; extra == "parallel"
 Description-Content-Type: text/markdown

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

@@ -1,6 +1,48 @@
 Changelog
 =========
 
+v2.6.0
+^^^^^^
+
+* Allow hub gaps in OH meshing by setting negative tip values
+* Scale blade thickness on chord/span/absolute value
+* Fix broken TS3 to TS4 conversion script on Wilkes
+* More TS4 configuration options and better restart settings
+* OH meshing data now saves correctly into the config file
+* Bug fix where incidence was calculated on uncambered blades
+* Additional TaylorQuadratic camber line setting metal angle directly instead of metal angle tangent
+* Fix sections were always stacked at LE irrespective of mstack value
+
+
+v2.5.0
+^^^^^^
+
+* Allow scaling tip gap on chord, span, or absolute value
+* Implement trailing-edge cusps in ember
+* Print out area-averaged yplus in ember
+* Add post processing for inlet profile plot and streamtube loss breakdown
+* Bugfix for overly generous block equality
+* Speed improvement for matching patches
+* Add function to initialise a grid from TS3 hdf5
+* Low-level utility function for grid warping
+* Scripts to automate rebuilding the compiled Fortran code
+* Save config to iteration directories before running the solver
+* Split long Fortran routines into smaller subroutines
+* Write out metdata for TS3 probes into a yaml file
+* Allow per block overrides of block variables in TS3
+* Implement general unsteady inlet boundary condition
+* Functions for post-processing TS3 unsteady probes and wave separation
+* Much internal restructuring and tidying up
+
+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.7.0/doc/data_structures.rst

@@ -0,0 +1,325 @@
+
+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.
+
+
+.. _state:
+
+State
+-----
+
+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
+
+.. _flowfield:
+
+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
+
+.. _meanline:
+
+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.7.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)