luminarycloud 0.14.1__py3-none-any.whl → 0.15.0__py3-none-any.whl

luminarycloud/params/simulation/material/fluid/thermal_conductivity_model/temperature_dependent_conductivity_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.material.fluid.thermal_conductivity_model_ import (
     ThermalConductivityModel,
@@ -27,5 +28,5 @@ from luminarycloud.params.simulation.material.fluid.thermal_conductivity_model_
 class TemperatureDependentConductivity(ThermalConductivityModel):
     """Tabulated thermal conductivity values vs temperature."""
 
-    conductivity_table: Optional[RectilinearTable] = None
+    conductivity_table: RectilinearTable | None = None
     "Correlation between thermal conductivity and temperature."

luminarycloud/params/simulation/material/fluid/thermal_conductivity_model_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 
 @dataclass(kw_only=True)

luminarycloud/params/simulation/material/fluid/viscosity_model/__init__.py

@@ -1,3 +1,3 @@
-from .temperature_dependent_viscosity_ import TemperatureDependentViscosity
 from .prescribed_viscosity_ import PrescribedViscosity
 from .sutherland_ import Sutherland
+from .temperature_dependent_viscosity_ import TemperatureDependentViscosity

luminarycloud/params/simulation/material/fluid/viscosity_model/prescribed_viscosity_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.material.fluid.viscosity_model_ import ViscosityModel
 from luminarycloud.params.simulation.material.fluid.viscosity_model_ import *

luminarycloud/params/simulation/material/fluid/viscosity_model/sutherland_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.material.fluid.viscosity_model_ import ViscosityModel
 from luminarycloud.params.simulation.material.fluid.viscosity_model_ import *

luminarycloud/params/simulation/material/fluid/viscosity_model/temperature_dependent_viscosity_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.material.fluid.viscosity_model_ import ViscosityModel
 from luminarycloud.params.simulation.material.fluid.viscosity_model_ import *
@@ -25,5 +26,5 @@ from luminarycloud.params.simulation.material.fluid.viscosity_model_ import *
 class TemperatureDependentViscosity(ViscosityModel):
     """Tabulated dynamic viscosity values vs temperature."""
 
-    viscosity_table: Optional[RectilinearTable] = None
+    viscosity_table: RectilinearTable | None = None
     "Correlation between dynamic viscosity and temperature."

luminarycloud/params/simulation/material/fluid/viscosity_model_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 
 @dataclass(kw_only=True)

luminarycloud/params/simulation/material/material_fluid_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.material.fluid.boussinesq_approximation_ import (
     BoussinesqApproximation,
@@ -78,17 +79,17 @@ class MaterialFluid(CodeRepr, ParamGroupWrapper[clientpb.MaterialFluid]):
     reference_pressure: float = 0.0
     "Reference pressure for the simulation. Unless otherwise stated, all pressure values are relative to this field (i.e. gauge pressures)."
     material_model: MaterialModel = field(default_factory=IdealGas)
-    "Material model."
+    "Material model. Possible types: ``IdealGas``, ``IncompressibleFluid``, ``IncompressibleFluidWithEnergy`` from the ``material_model`` module."
     thermal_conductivity_model: ThermalConductivityModel = field(
         default_factory=PrescribedPrandtlNumber
     )
-    "Model for the laminar thermal conductivity of a fluid."
+    "Model for the laminar thermal conductivity of a fluid. Possible types: ``PrescribedPrandtlNumber``, ``PrescribedConductivity``, ``TemperatureDependentConductivity`` from the ``thermal_conductivity_model`` module."
     boussinesq_approximation: BoussinesqApproximation = field(default_factory=BoussinesqOn)
-    "Introduce a body force due to thermal expansion without modifying the material density."
+    "Introduce a body force due to thermal expansion without modifying the material density. Possible types: ``BoussinesqOff``, ``BoussinesqOn`` from the ``boussinesq_approximation`` module."
     preset: enum.MaterialFluidPreset = enum.MaterialFluidPreset.CUSTOM_MATERIAL_FLUID
     "Select a predefined set of material properties or allow a custom set of properties."
     viscosity_model: ViscosityModel = field(default_factory=Sutherland)
-    "Models available for the dynamic viscosity of the fluid."
+    "Models available for the dynamic viscosity of the fluid. Possible types: ``Sutherland``, ``PrescribedViscosity``, ``TemperatureDependentViscosity`` from the ``viscosity_model`` module."
 
     def _to_proto(self) -> clientpb.MaterialFluid:
         _proto = clientpb.MaterialFluid()

luminarycloud/params/simulation/material/material_solid_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 
 @dataclass(kw_only=True)
@@ -28,7 +29,7 @@ class MaterialSolid(CodeRepr, ParamGroupWrapper[clientpb.MaterialSolid]):
     "Specific heat at constant pressure."
     thermal_conductivity: float = 167
     "The thermal conductivity of the material."
-    thermal_conductivity_table: Optional[RectilinearTable] = None
+    thermal_conductivity_table: RectilinearTable | None = None
     "Correlation between thermal conductivity and temperature."
     preset: enum.MaterialSolidPreset = enum.MaterialSolidPreset.CUSTOM_MATERIAL_SOLID
     "Select a predefined set of material properties or allow a custom set of properties."

luminarycloud/params/simulation/material_entity_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.material.material_fluid_ import MaterialFluid
 from luminarycloud.params.simulation.material.material_fluid_ import *
@@ -27,12 +28,12 @@ from luminarycloud.params.simulation.material.material_solid_ import *
 class MaterialEntity(CodeRepr, ParamGroupWrapper[clientpb.MaterialEntity]):
     """Material entity."""
 
-    material_identifier: Optional[EntityIdentifier] = None
-    "Unique identifier for a material entity"
-    fluid: Optional[MaterialFluid] = None
-    "Configuration for Fluid materials"
-    solid: Optional[MaterialSolid] = None
-    "Configuration for Solid materials"
+    material_identifier: EntityIdentifier | None = None
+    "Unique identifier for a material entity."
+    fluid: MaterialFluid | None = None
+    "Configuration for Fluid materials."
+    solid: MaterialSolid | None = None
+    "Configuration for Solid materials."
 
     def _to_proto(self) -> clientpb.MaterialEntity:
         _proto = clientpb.MaterialEntity()

luminarycloud/params/simulation/monitor_plane_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 
 @dataclass(kw_only=True)
@@ -27,9 +28,9 @@ class MonitorPlane(CodeRepr, ParamGroupWrapper[clientpb.MonitorPlane]):
     name: str = ""
     ""
     point: Vector3 = field(default_factory=lambda: Vector3(0.0, 0.0, 0.0))
-    "A point on the plane"
+    "A point on the plane."
     normal: Vector3 = field(default_factory=lambda: Vector3(0.0, 0.0, 1.0))
-    "A vector normal to the plane"
+    "A vector normal to the plane."
     enable_box_clip: bool = False
     "Turn on or off the ability to clip a monitor plane using a box."
     box_center: Vector3 = field(default_factory=lambda: Vector3(0.0, 0.0, 0.0))

luminarycloud/params/simulation/motion_data/__init__.py

@@ -1,4 +1,4 @@
-from . import motion_type
 from . import frame_transforms
+from . import motion_type
 from .frame_transforms_ import FrameTransforms
 from .motion_type_ import MotionType

luminarycloud/params/simulation/motion_data/frame_transforms/__init__.py

@@ -1,3 +1,3 @@
-from .translational_transform_ import TranslationalTransform
 from .no_transform_ import NoTransform
 from .rotational_transform_ import RotationalTransform
+from .translational_transform_ import TranslationalTransform

luminarycloud/params/simulation/motion_data/frame_transforms/no_transform_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.motion_data.frame_transforms_ import FrameTransforms
 from luminarycloud.params.simulation.motion_data.frame_transforms_ import *
@@ -27,10 +28,10 @@ class NoTransform(FrameTransforms):
 
     def _to_proto(self) -> clientpb.FrameTransforms:
         _proto = super()._to_proto()
-        _proto.transform_type = enum.TransformType.NO_TRANSFORM.value
+        _proto.transform_type = clientpb.TransformType.NO_TRANSFORM
         return _proto
 
     def _from_proto(self, proto: clientpb.FrameTransforms) -> None:
         super()._from_proto(proto)
-        assert proto.transform_type == enum.TransformType.NO_TRANSFORM.value
+        assert proto.transform_type == clientpb.TransformType.NO_TRANSFORM
         return None

luminarycloud/params/simulation/motion_data/frame_transforms/rotational_transform_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.motion_data.frame_transforms_ import FrameTransforms
 from luminarycloud.params.simulation.motion_data.frame_transforms_ import *
@@ -30,12 +31,12 @@ class RotationalTransform(FrameTransforms):
 
     def _to_proto(self) -> clientpb.FrameTransforms:
         _proto = super()._to_proto()
-        _proto.transform_type = enum.TransformType.ROTATIONAL_TRANSFORM.value
+        _proto.transform_type = clientpb.TransformType.ROTATIONAL_TRANSFORM
         _proto.transform_rotation_angles.CopyFrom(self.rotation_angles._to_ad_proto())
         return _proto
 
     def _from_proto(self, proto: clientpb.FrameTransforms) -> None:
         super()._from_proto(proto)
-        assert proto.transform_type == enum.TransformType.ROTATIONAL_TRANSFORM.value
+        assert proto.transform_type == clientpb.TransformType.ROTATIONAL_TRANSFORM
         self.rotation_angles._from_ad_proto(proto.transform_rotation_angles)
         return None

luminarycloud/params/simulation/motion_data/frame_transforms/translational_transform_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.motion_data.frame_transforms_ import FrameTransforms
 from luminarycloud.params.simulation.motion_data.frame_transforms_ import *
@@ -30,12 +31,12 @@ class TranslationalTransform(FrameTransforms):
 
     def _to_proto(self) -> clientpb.FrameTransforms:
         _proto = super()._to_proto()
-        _proto.transform_type = enum.TransformType.TRANSLATIONAL_TRANSFORM.value
+        _proto.transform_type = clientpb.TransformType.TRANSLATIONAL_TRANSFORM
         _proto.transform_translation.CopyFrom(self.translation._to_ad_proto())
         return _proto
 
     def _from_proto(self, proto: clientpb.FrameTransforms) -> None:
         super()._from_proto(proto)
-        assert proto.transform_type == enum.TransformType.TRANSLATIONAL_TRANSFORM.value
+        assert proto.transform_type == clientpb.TransformType.TRANSLATIONAL_TRANSFORM
         self.translation._from_ad_proto(proto.transform_translation)
         return None

luminarycloud/params/simulation/motion_data/frame_transforms_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 
 @dataclass(kw_only=True)

luminarycloud/params/simulation/motion_data/motion_type/__init__.py

@@ -1,2 +1,2 @@
-from .constant_translation_motion_ import ConstantTranslationMotion
 from .constant_angular_motion_ import ConstantAngularMotion
+from .constant_translation_motion_ import ConstantTranslationMotion

luminarycloud/params/simulation/motion_data/motion_type/constant_angular_motion_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.motion_data.motion_type_ import MotionType
 from luminarycloud.params.simulation.motion_data.motion_type_ import *
@@ -28,6 +29,6 @@ class ConstantAngularMotion(MotionType):
     motion_formulation: enum.MotionFormulation = enum.MotionFormulation.AUTOMATIC_MOTION_FORMULATION
     "Formulation used to model motion of volumes in transient simulations."
     angular_velocity: Vector3 = field(default_factory=lambda: Vector3(0.0, 0.0, 0.0))
-    "Constant angular velocity of this frame"
+    "Constant angular velocity of this frame."
     rotation_angles: Vector3 = field(default_factory=lambda: Vector3(0.0, 0.0, 0.0))
-    "Constant rotation of this frame"
+    "Constant rotation of this frame."

luminarycloud/params/simulation/motion_data/motion_type/constant_translation_motion_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.motion_data.motion_type_ import MotionType
 from luminarycloud.params.simulation.motion_data.motion_type_ import *
@@ -28,6 +29,6 @@ class ConstantTranslationMotion(MotionType):
     motion_formulation: enum.MotionFormulation = enum.MotionFormulation.AUTOMATIC_MOTION_FORMULATION
     "Formulation used to model motion of volumes in transient simulations."
     translation_velocity: Vector3 = field(default_factory=lambda: Vector3(0.0, 0.0, 0.0))
-    "Constant translation velocity of this frame"
+    "Constant translation velocity of this frame."
     translation: Vector3 = field(default_factory=lambda: Vector3(0.0, 0.0, 0.0))
-    "Constant translation of this frame"
+    "Constant translation of this frame."

luminarycloud/params/simulation/motion_data/motion_type_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 
 @dataclass(kw_only=True)

luminarycloud/params/simulation/motion_data_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.motion_data.motion_type.constant_angular_motion_ import (
     ConstantAngularMotion,
@@ -55,10 +56,10 @@ class MotionData(CodeRepr, ParamGroupWrapper[clientpb.MotionData]):
     "Domains that are attached to this frame."
     attached_boundaries: list[str] = field(default_factory=list)
     "Surfaces that are attached to this frame."
-    motion_type: Optional[MotionType] = None
-    "Type of the Motion."
+    motion_type: MotionType | None = None
+    "Type of the Motion. Possible types: ``ConstantTranslationMotion``, ``ConstantAngularMotion`` from the ``motion_type`` module."
     frame_transforms: list[FrameTransforms] = field(default_factory=list)
-    "Type of the Transformation."
+    "Type of the Transformation. Possible types: ``NoTransform``, ``RotationalTransform``, ``TranslationalTransform`` from the ``frame_transforms`` module."
 
     def _to_proto(self) -> clientpb.MotionData:
         _proto = clientpb.MotionData()

luminarycloud/params/simulation/multi_physics_coupling_options_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 
 @dataclass(kw_only=True)

luminarycloud/params/simulation/output_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 
 @dataclass(kw_only=True)

luminarycloud/params/simulation/particle_group/particle_group_type/__init__.py

@@ -1,5 +1,5 @@
 from . import actuator_disk
+from .actuator_disk_ import ActuatorDisk
 from .actuator_line_ import ActuatorLine
 from .probe_points_ import ProbePoints
-from .actuator_disk_ import ActuatorDisk
 from .source_points_ import SourcePoints

luminarycloud/params/simulation/particle_group/particle_group_type/actuator_disk/actuator_disk_orientation_selection/actuator_disk_specify_normal_vector_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.particle_group.particle_group_type.actuator_disk.actuator_disk_orientation_selection_ import (
     ActuatorDiskOrientationSelection,
@@ -28,4 +29,4 @@ class ActuatorDiskSpecifyNormalVector(ActuatorDiskOrientationSelection):
     """Specify the normal direction to the plane of the actuator disk."""
 
     normal: Vector3 = field(default_factory=lambda: Vector3(0.0, 0.0, 1.0))
-    "Vector normal to the actuator disk (thrust direction defined as negative-Z)"
+    "Vector normal to the actuator disk (thrust direction defined as negative-Z)."