turbigen 2.4.0__tar.gz → 2.7.3__tar.gz

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

@@ -43,3 +43,5 @@ tests/*.log
 /build/
 *.prof
 tests/bench.dat
+src/ember/*wrapper*
+src/ember/embercmodule.c

turbigen-2.7.3/.gitlab-ci.yml

@@ -0,0 +1,100 @@
+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_API_VERSION: 1.41
+  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~=8.0.0 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.4.0 → turbigen-2.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: turbigen
-Version: 2.4.0
+Version: 2.7.3
 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.4.0 → turbigen-2.7.3}/doc/changelog.rst

@@ -1,6 +1,39 @@
 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
 ^^^^^^
 

{turbigen-2.4.0 → turbigen-2.7.3}/doc/data_structures.rst

@@ -1,5 +1,5 @@
 
-Data Structures
+Data structures
 ===============
 
 This page documents the internal data structures used in :program:`turbigen`.
@@ -7,8 +7,10 @@ It is intended as a reference for users extending the program using custom
 plugins or developers modifying the source code.
 
 
-Working fluids
---------------
+.. _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
@@ -106,6 +108,8 @@ Thermodynamic and transport properties of the fluid are accessed as attributes o
      - Specific internal energy
      - J/kg
 
+.. _flowfield:
+
 Flow fields
 -----------
 
@@ -250,6 +254,8 @@ In addition to all the pure thermodynamic properties defined in
      - Axial coordinate
      - m
 
+.. _meanline:
+
 Mean line
 ---------
 

{turbigen-2.4.0 → turbigen-2.7.3}/doc/generate_meanline.py

@@ -1,6 +1,6 @@
 """Make documentation for an abstract base class and subclasses."""
 
-import turbigen.meanline
+import turbigen.meanline_design
 from turbigen import util
 import inspect
 
@@ -51,4 +51,4 @@ def format_yaml_snippet(data_dict, title):
 
 
 if __name__ == "__main__":
-    print(generate_subclass(turbigen.meanline.MeanLineDesigner, "meanline"))
+    print(generate_subclass(turbigen.meanline_design.MeanLineDesigner, "meanline"))

{turbigen-2.4.0 → turbigen-2.7.3}/doc/generate_solver.py

@@ -1,7 +1,7 @@
 """Make documentation for an abstract base class and subclasses."""
 
 import turbigen.solvers.base
-from turbigen.solvers import ember, ts3, ts4
+from turbigen.solvers import ember, ts3, ts4  # noqa: F401
 import inspect
 import dataclasses
 

{turbigen-2.4.0 → turbigen-2.7.3}/doc/meanline.rst

@@ -112,7 +112,7 @@ Then, create a new Python file in the `plug` directory, e.g.
 
             Parameters
             ----------
-            So1: Fluid
+            So1: State
                 The working fluid and its thermodynamic state at inlet.
             phi: float
                 Flow coefficient at inlet.
@@ -132,7 +132,7 @@ Then, create a new Python file in the `plug` directory, e.g.
                 Shaft angular velocities at all stations [rad/s].
             Vxrt: (3, 2*nrow) array
                 Velocity components at all stations [m/s].
-            S: (2*nrow,) list of Fluid
+            S: (2*nrow,) list of State
                 Static states for all stations.
 
             '''
@@ -193,7 +193,7 @@ Then, create a new Python file in the `plug` directory, e.g.
 
 You will need to implement two static methods: `forward()` and `backward()`.
 
-The `forward()` function takes as arguments an inlet state object and
+The `forward()` function takes as arguments an inlet :ref:`state` object and
 some duty, geometric, or aerodynamic design variables. This function
 returns all information required to lay out the mean-line: radii, annulus
 areas, angular velocities, velocity components, and thermodynamic states at
@@ -226,7 +226,7 @@ the `MyCustomMeanLine` class and calls its `forward()` method like:
 Some notes on implementing the `forward()` method:
 
 * Retain generality of the working fluid by using the set property methods
-  of the `Fluid` class, as in the example above. This is preferable to
+  of the :ref:`state` class, as in the example above. This is preferable to
   hard-coding calculations assuming a specific equation of state such as
   ideal gas.
 * Specify aerodynamic design variables instead of geometric ones, e.g.
@@ -251,7 +251,7 @@ Some notes on implementing the `forward()` method:
   total-to-static pressure ratio requires iteration because the exit
   dynamic head is not known a priori.
 
-The `backward()` function takes a mean-line flow field as its only
+The `backward()` function takes a :ref:`meanline` flow field object as its only
 argument, and calculates a dictionary of the arguments to `forward()`.
 Given a suitably averaged CFD solution, `backward()` is a post-processing
 step that allows comparison of the three-dimensional simulated flow field

{turbigen-2.4.0 → turbigen-2.7.3}/doc/tutorial.rst

@@ -220,7 +220,7 @@ We can now start to add the :ref:`tut-ml-algo` to the `forward` function inside
 The first task is to calculate the ideal exit enthalpy :math:`h_{02s}=h(p_{01}+\Delta p_0, s_1)`
 in Eqn. :eq:`eqn-eta`. Mean-line design functions should be written to make
 no assumptions about the working fluid equation of state --- this is accomplished
-using the fluid modelling abstractions in :py:mod:`turbigen.fluid`. We take a
+using the fluid modelling abstractions of the :ref:`state` class. We take a
 copy of the inlet state, and set its pressure and entropy to the required
 values.
 
@@ -343,7 +343,7 @@ radius, and the shaft angular velocity. The completed function is:
        Omega = U / rrms
 
        # Return mean-line data
-      return rrms, A, Omega, Vxrt, S
+       return rrms, A, Omega, Vxrt, S
 
 
 This concludes the `forward` function --- all the required quantities have been
@@ -384,8 +384,8 @@ Implementing backward
 The `backward` function serves as a verification check that the mean-line
 matches the design intent, and also to extract design variables from a
 mixed-out CFD solution. We add the design variables as keys in the output
-dictionary, using the attributes of the flowfield class to calculate them. Many
-useful quantities are already available in the `mean_line` object, such as efficiency.
+dictionary, using the attributes of the :ref:`meanline` class to calculate them. Many
+useful quantities are already available in the :ref:`meanline` object, such as efficiency.
 
 .. code-block:: python
    :caption: ./plugins/fan.py
@@ -652,7 +652,7 @@ Extensions
 
 This tutorial has demonstrated some of the functionality of
 :program:`turbigen`. Within the current choice of parameterisation, any change to
-the design is just an edit to the `config.yaml`, as described in ???
+the design is just an edit to the `config.yaml`.
 
 * Increase the number of blades by changing `DFL`
 * Increase the grid density under `mesh`

turbigen-2.7.3/dspace.yaml

@@ -0,0 +1,106 @@
+workdir: runs/*
+
+inlet:
+  Po: 16.0e5
+  To: 1600.
+  cp: 1100.
+  gamma: 1.33
+
+# Set viscosity by vane Reynolds number
+Re_surf: 5e5
+
+mean_line:
+  type: axial_turbine
+  # Duty
+  mdot: 500.
+  rrms: 1.0
+  # Aerodynamics
+  psi: 1.6
+  phi2: 0.6
+  Ma2: 0.7
+  fac_Ma3_rel: 1.0
+  zeta: [1.0, 1.0]
+  # Guess of loss
+  Ys: [0.05, 0.1]
+
+annulus:
+  type: smooth
+  AR_gap: [2.0, 3.33, 2.0]
+  AR_chord: [2.0, 2.0]
+  smooth: false
+
+mesh:
+  type: h
+  yplus: 50.0
+  ni_TE: 3
+  dm_TE: 0.0
+  dspf_mid: 0.05
+  AR_cusp: 1.2
+  ni_cusp: 4
+  ER_span: 1.3
+  ER_stream: 1.3
+  ER_pitch: 1.3
+  dm_LE: 0.002
+
+
+blades:
+    - spf: 0.5
+      thick: [0.04, 0.12, 0.35, 0.0, 0.04, 0.15]
+      camber: [0., 0., 0.0]
+    - spf: 0.5
+      thick: [0.04, 0.12, 0.35, 0.0, 0.04, 0.15]
+      camber: [0., 0., 0.0]
+      tip: 0.01
+
+nblade:
+  - Co: 0.6
+  - Co: 0.6
+
+job:
+  type: local
+
+iterate:
+  mean_line:
+    tolerance:
+      Ys: 0.01
+    relaxation_factor: 1.0
+  deviation:
+    tolerance: 0.5
+  incidence:
+    tolerance: 16.
+    relaxation_factor: 0.05
+  repeat:
+    dPo_max: 0.05
+    dTo_max: 0.05
+    dAlpha_max: 10.
+    dBeta_max: 0.
+
+post_process:
+  - type: inlet_profiles
+  - type: contour
+    coord: spf
+    value: 0.5
+    variable: Ma_rel
+  - type: contour
+    coord: m
+    value: [2.05, 4.05]
+    variable: Ys
+
+design_space:
+  independent:
+    mean_line:
+      phi2: [0.4, 1.2]
+      psi: [0.8, 2.4]
+      zeta[0]: [0.9, 1.0]
+      zeta[1]: [1.0, 1.1]
+      Ma2: [0.5, 0.9]
+      fac_Ma3_rel: [0.8, 1.2]
+    nblade:
+      0:
+        Co: [0.6, 0.8]
+      1:
+        Co: [0.6, 0.8]
+  order_max: 3
+  nsample_target: 512
+
+fac_nstep_initial: 2.0

turbigen-2.7.3/dspace2.yaml

@@ -0,0 +1,114 @@
+workdir: runs/*
+
+inlet:
+  Po: 16.0e5
+  To: 1600.
+  cp: 1100.
+  gamma: 1.33
+
+# Set viscosity by vane Reynolds number
+Re_surf: 5e5
+
+mean_line:
+  type: axial_turbine
+  # Duty
+  mdot: 500.
+  rrms: 1.0
+  # Aerodynamics
+  psi: 1.6
+  phi2: 0.6
+  Ma2: 0.6
+  fac_Ma3_rel: 1.0
+  zeta: [1.0, 1.0]
+  # Guess of loss
+  Ys: [0.05, 0.1]
+
+annulus:
+  type: smooth
+  AR_gap: [2.0, 3.33, 2.0]
+  AR_chord: [2.0, 2.0]
+  smooth: false
+
+mesh:
+  type: h
+  yplus: 40.0
+  ni_TE: 6
+  dm_TE: 0.0
+  dspf_mid: 0.03
+  AR_cusp: 1.2
+  ni_cusp: 8
+  ER_span: 1.2
+  ER_stream: 1.2
+  ER_pitch: 1.2
+  dm_LE: 0.001
+
+
+blades:
+    - spf: 0.5
+      thick: [0.04, 0.12, 0.35, 0.0, 0.02, 0.15]
+      camber: [0., 0., 0.0]
+    - spf: 0.5
+      thick: [0.04, 0.12, 0.35, 0.0, 0.02, 0.15]
+      camber: [0., 0., 0.0]
+      tip: 0.00
+
+nblade:
+  - Co: 0.6
+  - Co: 0.6
+
+job:
+  type: local
+
+iterate:
+  mean_line:
+    tolerance:
+      Ys: 0.01
+    relaxation_factor: 1.0
+  deviation:
+    tolerance: 0.5
+  incidence:
+    tolerance: 16.
+    relaxation_factor: 0.05
+  repeat:
+    dPo_max: 0.05
+    dTo_max: 0.05
+    dAlpha_max: 10.
+    dBeta_max: 0.
+
+post_process:
+  - type: inlet_profiles
+  - type: contour
+    coord: spf
+    value: 0.5
+    variable: Ma_rel
+  - type: contour
+    coord: m
+    value: [2.05, 4.05]
+    variable: Ys
+
+design_space:
+  independent:
+    mean_line:
+      phi2: [0.4, 1.2]
+      psi: [0.8, 2.4]
+      zeta[0]: [0.9, 1.0]
+      zeta[1]: [1.0, 1.1]
+      Ma2: [0.5, 0.9]
+      fac_Ma3_rel: [0.8, 1.2]
+    nblade:
+      0:
+        Co: [0.6, 0.8]
+      1:
+        Co: [0.6, 0.8]
+  order_max: 3
+  nsample_target: 512
+
+fac_nstep_initial: 2.0
+
+
+
+solver:
+  type: ember
+  n_step: 4000
+  n_step_avg: 1000
+  n_step_ramp: 500

turbigen-2.7.3/dspace3.yaml

@@ -0,0 +1,144 @@
+workdir: runs/*
+
+inlet:
+  Po: 16.0e5
+  To: 1600.
+  cp: 1100.
+  gamma: 1.33
+
+# Set viscosity by vane Reynolds number
+Re_surf: 5e5
+
+mean_line:
+  type: axial_turbine
+  # Duty
+  mdot: 500.
+  rrms: 1.0
+  # Aerodynamics
+  psi: 1.6
+  phi2: 0.6
+  Ma2: 0.7
+  fac_Ma3_rel: 1.0
+  zeta: [1.0, 1.0]
+  # Guess of loss
+  Ys: [0.05, 0.1]
+
+annulus:
+  type: smooth
+  AR_gap: [2.0, 3.33, 2.0]
+  AR_chord: [2.0, 2.0]
+  smooth: false
+
+mesh:
+  type: h
+  yplus: 40.0
+  ni_TE: 3
+  dm_TE: 0.0
+  dspf_mid: 0.05
+  AR_cusp: 1.2
+  ni_cusp: 4
+  ER_span: 1.3
+  ER_stream: 1.3
+  ER_pitch: 1.3
+  dm_LE: 0.002
+
+
+blades:
+    - spf: [0.2, 0.5, 0.8]
+      thick: [
+        [0.04, 0.12, 0.35, 0.0, 0.02, 0.15],
+        [0.04, 0.12, 0.35, 0.0, 0.02, 0.15],
+        [0.04, 0.12, 0.35, 0.0, 0.02, 0.15],
+      ]
+      camber: [
+        [0., 0., 0.0],
+        [0., 0., 0.0],
+        [0., 0., 0.0],
+      ]
+    - spf: [0.2, 0.5, 0.8]
+      thick: [
+        [0.04, 0.12, 0.35, 0.0, 0.02, 0.15],
+        [0.04, 0.12, 0.35, 0.0, 0.02, 0.15],
+        [0.04, 0.12, 0.35, 0.0, 0.02, 0.15],
+      ]
+      camber: [
+        [0., 0., 0.0],
+        [0., 0., 0.0],
+        [0., 0., 0.0],
+      ]
+      tip: 0.01
+
+nblade:
+  - Co: 0.6
+  - Co: 0.6
+
+
+solver:
+  type: ember
+  n_step: 2500
+  n_step_avg: 1500
+  n_step_ramp: 1000
+  xllim_pitch: 0.01
+  K_mix: 0.1
+  sf_mix: 0.5
+  sf_Alpha: 1e-3
+
+job:
+  type: local
+
+iterate:
+  mean_line:
+    tolerance:
+      Ys: 0.0004
+    relaxation_factor: 1.0
+  deviation:
+    tolerance: 0.5
+  incidence:
+    tolerance: 16.
+    relaxation_factor: 0.05
+    clip: 0.5
+  repeat:
+    dPo_max: 0.05
+    dTo_max: 0.05
+    dAlpha_max: 10.
+    dBeta_max: 0.
+    rtol: 0.005
+    relaxation_factor: 0.5
+
+post_process:
+  - type: inlet_profiles
+  - type: sections
+  - type: contour
+    coord: spf
+    value: 0.5
+    variable: Ma_rel
+  - type: contour
+    coord: m
+    value: [0.01, 2.48, 2.52, 4.25]
+    variable: Alpha
+  - type: contour
+    coord: m
+    value: [0.01, 2.48, 2.52, 4.25]
+    variable: Cho
+  - type: contour
+    coord: m
+    value: [0.01, 2.48, 2.52, 4.25]
+    variable: Ys
+
+design_space:
+  independent:
+    mean_line:
+      phi2: [0.4, 1.2]
+      psi: [0.8, 2.4]
+      # zeta[0]: [0.9, 1.0]
+      # zeta[1]: [1.0, 1.1]
+      # Ma2: [0.5, 0.9]
+      # fac_Ma3_rel: [0.8, 1.2]
+    tip:
+      1: [0.005, 0.05]
+  order_max: 3
+  nsample_target: 16
+
+fac_nstep_initial: 2.0
+
+save_iteration_grids: false

turbigen-2.7.3/dspace_emb.yaml

@@ -0,0 +1,8 @@
+include:
+  - dspace.yaml
+
+solver:
+  type: ember
+  n_step: 2000
+  n_step_avg: 1000
+  n_step_ramp: 1000

turbigen-2.7.3/dspace_ts3.yaml

@@ -0,0 +1,9 @@
+include:
+  - dspace.yaml
+
+solver:
+  type: ts3
+  # soft_start: true
+  nstep: 10000
+  nstep_avg: 2500
+  ilos: 1