Skip to content

[docs] docstring updates #1935

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benflexcompute merged 2 commits into from
Mar 29, 2026
Merged

[docs] docstring updates #1935

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a4f9cc5
docstrings fixed so that sphinx does not complain
piotrkluba Mar 27, 2026
54b2701
fix lint
piotrkluba Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions flow360/component/simulation/meshing_param/volume_params.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -635,8 +635,8 @@ class _FarfieldAllowingEnclosedEntities(_FarfieldBase):
None,
description="""
The surfaces/surface groups that are the interior boundaries of the `farfield` zone when defining custom volumes.
- Only allowed when using one or more `CustomZone`(s) to define volume zone(s) in meshing parameters
- Cylinder, AxisymmetricBody, Sphere entities must be associated with `RotationVolume`(s)
- Only allowed when using one or more ``CustomZone(s)`` to define volume zone(s) in meshing parameters
- Cylinder, AxisymmetricBody, Sphere entities must be associated with ``RotationVolume(s)``
""",
)

Expand Down
2 changes: 1 addition & 1 deletion flow360/component/simulation/models/material.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,7 @@ def get_specific_heat_ratio(self, temperature: AbsoluteTemperatureType) -> pd.Po

For thermally perfect gas, gamma = cp/cv = (cp/R) / (cp/R - 1) varies with temperature.
The cp/R is computed from the NASA 9-coefficient polynomial:
cp/R = a0*T^-2 + a1*T^-1 + a2 + a3*T + a4*T^2 + a5*T^3 + a6*T^4
cp/R = a0*T^-2 + a1*T^-1 + a2 + a3*T + a4*T^2 + a5*T^3 + a6*T^4

Parameters
----------
Expand Down
Loading