From a847a33af155865ebd33ad5a37e69baad560c3ae Mon Sep 17 00:00:00 2001 From: Angran Li Date: Fri, 1 Nov 2024 20:21:47 +0000 Subject: [PATCH] Update Isosurface related docs --- flow360/component/simulation/outputs/output_entities.py | 5 ++++- flow360/component/simulation/outputs/outputs.py | 6 +++--- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/flow360/component/simulation/outputs/output_entities.py b/flow360/component/simulation/outputs/output_entities.py index 86e9d69fb..882352d81 100644 --- a/flow360/component/simulation/outputs/output_entities.py +++ b/flow360/component/simulation/outputs/output_entities.py @@ -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.") diff --git a/flow360/component/simulation/outputs/outputs.py b/flow360/component/simulation/outputs/outputs.py index 7e045287c..92663b8b4 100644 --- a/flow360/component/simulation/outputs/outputs.py +++ b/flow360/component/simulation/outputs/outputs.py @@ -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`." ) output_type: Literal["IsosurfaceOutput"] = pd.Field("IsosurfaceOutput", frozen=True) @@ -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`." ) output_type: Literal["SurfaceIntegralOutput"] = pd.Field("SurfaceIntegralOutput", frozen=True)