Skip to content

Update Isosurface related docs #546

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 4 additions & 1 deletion flow360/component/simulation/outputs/output_entities.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,10 @@ class Slice(_SliceEntityBase):
class Isosurface(_OutputItemBase):
""":class:`Isosurface` class for defining an isosurface for :class:`~flow360.IsosurfaceOutput`."""

field: Literal[IsoSurfaceFieldNames] = pd.Field()
field: Literal[IsoSurfaceFieldNames] = pd.Field(
description="Isosurface field variable. One of :code:`p`, :code:`rho`, "
+ ":code:`Mach`, :code:`qcriterion`, :code:`s`, :code:`T`, :code:`Cp`, :code:`mut`, :code:`nuHat`."
)
# pylint: disable=fixme
# TODO: Maybe we need some unit helper function to help user figure out what is the value to use here?
iso_value: float = pd.Field(description="Expect non-dimensional value.")
Expand Down
6 changes: 3 additions & 3 deletions flow360/component/simulation/outputs/outputs.py
Original file line number Diff line number Diff line change
Expand Up @@ -173,8 +173,8 @@ class IsosurfaceOutput(_AnimationAndFileFormatSettings):
description="List of :class:`~flow360.Isosurface` entities.",
)
output_fields: UniqueItemList[CommonFieldNames] = pd.Field(
description=" Isosurface field variable to be written. One of :code:`p`, :code:`rho`, "
+ ":code:`Mach`, :code:`qcriterion`, :code:`s`, :code:`T`, :code:`Cp`, :code:`mut`, :code:`nuHat`."
description="List of output variables, see "
+ ":ref:`universal output variables<UniversalVariablesV2>`."
)
output_type: Literal["IsosurfaceOutput"] = pd.Field("IsosurfaceOutput", frozen=True)

Expand All @@ -191,7 +191,7 @@ class SurfaceIntegralOutput(Flow360BaseModel):
+ "the surface integral will be calculated.",
)
output_fields: UniqueItemList[CommonFieldNames] = pd.Field(
description="List of output variables. Including "
description="List of output variables, see "
+ ":ref:`universal output variables<UniversalVariablesV2>`."
)
output_type: Literal["SurfaceIntegralOutput"] = pd.Field("SurfaceIntegralOutput", frozen=True)
Expand Down
Loading