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

luminarycloud/params/simulation/physics/fluid/turbulence/sub_grid_scale_model/__init__.py

@@ -1,5 +1,5 @@
 from .amd_ import Amd
-from .vreman_ import Vreman
-from .wale_ import Wale
 from .sigma_ import Sigma
 from .smagorinsky_ import Smagorinsky
+from .vreman_ import Vreman
+from .wale_ import Wale

luminarycloud/params/simulation/physics/fluid/turbulence/sub_grid_scale_model/amd_.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.physics.fluid.turbulence.sub_grid_scale_model_ import (
     SubGridScaleModel,

luminarycloud/params/simulation/physics/fluid/turbulence/sub_grid_scale_model/sigma_.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.physics.fluid.turbulence.sub_grid_scale_model_ import (
     SubGridScaleModel,

luminarycloud/params/simulation/physics/fluid/turbulence/sub_grid_scale_model/smagorinsky_.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.physics.fluid.turbulence.sub_grid_scale_model_ import (
     SubGridScaleModel,

luminarycloud/params/simulation/physics/fluid/turbulence/sub_grid_scale_model/vreman_.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.physics.fluid.turbulence.sub_grid_scale_model_ import (
     SubGridScaleModel,

luminarycloud/params/simulation/physics/fluid/turbulence/sub_grid_scale_model/wale_.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.physics.fluid.turbulence.sub_grid_scale_model_ import (
     SubGridScaleModel,

luminarycloud/params/simulation/physics/fluid/turbulence/sub_grid_scale_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/physics/fluid/turbulence_.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.physics.fluid.turbulence.sub_grid_scale_model.amd_ import Amd
 from luminarycloud.params.simulation.physics.fluid.turbulence.sub_grid_scale_model.amd_ import *
@@ -54,9 +55,9 @@ class Turbulence(CodeRepr, ParamGroupWrapper[clientpb.Turbulence]):
     """Turbulence settings for a fluid flow physics solver."""
 
     des_formulation: DesFormulation = field(default_factory=DdesVtm)
-    "Select a Detached Eddy Simulation (DES) formulation."
-    sub_grid_scale_model: Optional[SubGridScaleModel] = field(default_factory=Vreman)
-    "Sub-grid scale models available for Large Eddy Simulation (LES)."
+    "Select a Detached Eddy Simulation (DES) formulation. Possible types: ``DdesVtm``, ``DdesVtmSigma``, ``Iddes``, ``Ddes``, ``Des97``, ``Zdes`` from the ``des_formulation`` module."
+    sub_grid_scale_model: SubGridScaleModel | None = field(default_factory=Vreman)
+    "Sub-grid scale models available for Large Eddy Simulation (LES). Possible types: ``Smagorinsky``, ``Vreman``, ``Wale``, ``Sigma``, ``Amd`` from the ``sub_grid_scale_model`` module."
     turbulent_prandtl_number: float = 0.85
     "Turbulent Prandtl number for computing an effective thermal conductivity for heat transport."
     transition_model: enum.TransitionModel = enum.TransitionModel.NO_TRANSITION

luminarycloud/params/simulation/physics/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.physics.fluid.adjoint_controls_fluid_ import (
     AdjointControlsFluid,
@@ -105,28 +106,26 @@ from luminarycloud.params.simulation.physics.fluid.boundary_conditions.wall_ imp
 class Fluid(CodeRepr, ParamGroupWrapper[clientpb.Fluid]):
     """Configuration for a fluid flow physics solver - simulates the flow of liquids and gases."""
 
-    basic: Optional[BasicFluid] = field(default_factory=BasicFluid)
+    basic: BasicFluid = field(default_factory=BasicFluid)
     "Basic settings for a fluid flow physics solver."
-    turbulence: Optional[Turbulence] = field(default_factory=SpalartAllmaras)
-    "Turbulence settings for a fluid flow physics solver."
-    solution_controls: Optional[SolutionControlsFluid] = field(
-        default_factory=SolutionControlsFluid
-    )
+    turbulence: Turbulence = field(default_factory=SpalartAllmaras)
+    "Turbulence settings for a fluid flow physics solver. Possible types: ``SpalartAllmaras``, ``KomegaSst`` from the ``turbulence`` module."
+    solution_controls: SolutionControlsFluid = field(default_factory=SolutionControlsFluid)
     "Solution controls for a fluid flow physics solver."
-    adjoint_controls: Optional[AdjointControlsFluid] = field(default_factory=AdjointControlsFluid)
+    adjoint_controls: AdjointControlsFluid = field(default_factory=AdjointControlsFluid)
     ""
-    spatial_discretization: Optional[SpatialDiscretizationFluid] = field(
+    spatial_discretization: SpatialDiscretizationFluid = field(
         default_factory=SpatialDiscretizationFluid
     )
     "Spatial discretization settings for a fluid flow physics solver."
     boundary_conditions: list[BoundaryConditionsFluid] = field(default_factory=list)
-    "Boundary conditions for a fluid flow physics solver."
+    "Boundary conditions for a fluid flow physics solver. Possible types: ``Wall``, ``Inlet``, ``Outlet``, ``Symmetry``, ``Farfield`` from the ``boundary_conditions`` module."
     sliding_interfaces: list[SlidingInterfaces] = field(default_factory=list)
     "Defines the two sides that form a sliding interface. The two sides are abutting, possibly in combination with a periodic transformation, and should have the same normal grid velocity. The tangential grid velocity can, and usually will, be different. Each side of the sliding interface can be composed out of an arbitrary number of surfaces."
     periodic_pair: list[PeriodicPair] = field(default_factory=list)
     "Defines the input options needed for periodic boundaries. We assume each periodic BC can have translational OR rotational periodicity. To transform a point on boundary A to its periodically matching point on boundary B, we first subtract the center of rotation from the point coordinates to get the distance vector from the center to the point of interest, then we apply rotation around the periodicity axis and add back the center of rotation to get the coordinates of the transformed point."
-    initialization: Optional[InitializationFluid] = field(default_factory=FluidPrescribedValues)
-    "Type of initial condition for the field variables."
+    initialization: InitializationFluid = field(default_factory=FluidPrescribedValues)
+    "Type of initial condition for the field variables. Possible types: ``FluidPrescribedValues``, ``FluidFarfieldValues``, ``FluidPotentialFlow``, ``FluidVerificationSolution``, ``FluidExistingSolution`` from the ``initialization`` module."
     physical_behavior: list[PhysicalBehavior] = field(default_factory=list)
     "Physical behavior settings for a fluid flow physics solver."
     porous_behavior: list[PorousBehavior] = field(default_factory=list)

luminarycloud/params/simulation/physics/heat/__init__.py

@@ -1,10 +1,10 @@
-from . import solution_controls
+from . import boundary_conditions
 from . import heat_source
 from . import initialization
-from . import boundary_conditions
-from .heat_source_ import HeatSource
+from . import solution_controls
+from .adjoint_controls_heat_ import AdjointControlsHeat
 from .boundary_conditions_heat_ import BoundaryConditionsHeat
+from .heat_source_ import HeatSource
 from .initialization_heat_ import InitializationHeat
-from .adjoint_controls_heat_ import AdjointControlsHeat
 from .solution_controls_heat_ import SolutionControlsHeat
 from .spatial_discretization_heat_ import SpatialDiscretizationHeat

luminarycloud/params/simulation/physics/heat/adjoint_controls_heat_.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/physics/heat/boundary_conditions/__init__.py

@@ -1,5 +1,5 @@
+from .heat_bc_convection_ import HeatBcConvection
+from .heat_bc_heat_flux_ import HeatBcHeatFlux
 from .heat_bc_integrated_heat_flux_ import HeatBcIntegratedHeatFlux
 from .heat_bc_symmetry_ import HeatBcSymmetry
-from .heat_bc_convection_ import HeatBcConvection
 from .heat_bc_temperature_ import HeatBcTemperature
-from .heat_bc_heat_flux_ import HeatBcHeatFlux

luminarycloud/params/simulation/physics/heat/boundary_conditions/heat_bc_convection_.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.physics.heat.boundary_conditions_heat_ import (
     BoundaryConditionsHeat,
@@ -34,14 +35,14 @@ class HeatBcConvection(BoundaryConditionsHeat):
 
     def _to_proto(self) -> clientpb.BoundaryConditionsHeat:
         _proto = super()._to_proto()
-        _proto.heat_physical_boundary = enum.HeatPhysicalBoundary.HEAT_BC_CONVECTION.value
+        _proto.heat_physical_boundary = clientpb.HeatPhysicalBoundary.HEAT_BC_CONVECTION
         _proto.fixed_temperature.CopyFrom(_to_ad_proto(self.fluid_temperature))
         _proto.heat_transfer_coefficient.CopyFrom(_to_ad_proto(self.heat_transfer_coefficient))
         return _proto
 
     def _from_proto(self, proto: clientpb.BoundaryConditionsHeat) -> None:
         super()._from_proto(proto)
-        assert proto.heat_physical_boundary == enum.HeatPhysicalBoundary.HEAT_BC_CONVECTION.value
+        assert proto.heat_physical_boundary == clientpb.HeatPhysicalBoundary.HEAT_BC_CONVECTION
         self.fluid_temperature = _from_ad_proto(proto.fixed_temperature)
         self.heat_transfer_coefficient = _from_ad_proto(proto.heat_transfer_coefficient)
         return None

luminarycloud/params/simulation/physics/heat/boundary_conditions/heat_bc_heat_flux_.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.physics.heat.boundary_conditions_heat_ import (
     BoundaryConditionsHeat,
@@ -34,14 +35,14 @@ class HeatBcHeatFlux(BoundaryConditionsHeat):
 
     def _to_proto(self) -> clientpb.BoundaryConditionsHeat:
         _proto = super()._to_proto()
-        _proto.heat_physical_boundary = enum.HeatPhysicalBoundary.HEAT_BC_HEAT_FLUX.value
+        _proto.heat_physical_boundary = clientpb.HeatPhysicalBoundary.HEAT_BC_HEAT_FLUX
         _proto.fixed_heat_flux.CopyFrom(_to_ad_proto(self.heat_flux))
         _proto.heat_flux_col.value = self.heat_flux_column_index
         return _proto
 
     def _from_proto(self, proto: clientpb.BoundaryConditionsHeat) -> None:
         super()._from_proto(proto)
-        assert proto.heat_physical_boundary == enum.HeatPhysicalBoundary.HEAT_BC_HEAT_FLUX.value
+        assert proto.heat_physical_boundary == clientpb.HeatPhysicalBoundary.HEAT_BC_HEAT_FLUX
         self.heat_flux = _from_ad_proto(proto.fixed_heat_flux)
         self.heat_flux_column_index = proto.heat_flux_col.value
         return None

luminarycloud/params/simulation/physics/heat/boundary_conditions/heat_bc_integrated_heat_flux_.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.physics.heat.boundary_conditions_heat_ import (
     BoundaryConditionsHeat,
@@ -34,7 +35,7 @@ class HeatBcIntegratedHeatFlux(BoundaryConditionsHeat):
 
     def _to_proto(self) -> clientpb.BoundaryConditionsHeat:
         _proto = super()._to_proto()
-        _proto.heat_physical_boundary = enum.HeatPhysicalBoundary.HEAT_BC_INTEGRATED_HEAT_FLUX.value
+        _proto.heat_physical_boundary = clientpb.HeatPhysicalBoundary.HEAT_BC_INTEGRATED_HEAT_FLUX
         _proto.fixed_integrated_heat_flux.CopyFrom(_to_ad_proto(self.heat_flux))
         _proto.heat_flux_col.value = self.heat_flux_column_index
         return _proto
@@ -43,7 +44,7 @@ class HeatBcIntegratedHeatFlux(BoundaryConditionsHeat):
         super()._from_proto(proto)
         assert (
             proto.heat_physical_boundary
-            == enum.HeatPhysicalBoundary.HEAT_BC_INTEGRATED_HEAT_FLUX.value
+            == clientpb.HeatPhysicalBoundary.HEAT_BC_INTEGRATED_HEAT_FLUX
         )
         self.heat_flux = _from_ad_proto(proto.fixed_integrated_heat_flux)
         self.heat_flux_column_index = proto.heat_flux_col.value

luminarycloud/params/simulation/physics/heat/boundary_conditions/heat_bc_symmetry_.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.physics.heat.boundary_conditions_heat_ import (
     BoundaryConditionsHeat,
@@ -29,10 +30,10 @@ class HeatBcSymmetry(BoundaryConditionsHeat):
 
     def _to_proto(self) -> clientpb.BoundaryConditionsHeat:
         _proto = super()._to_proto()
-        _proto.heat_physical_boundary = enum.HeatPhysicalBoundary.HEAT_BC_SYMMETRY.value
+        _proto.heat_physical_boundary = clientpb.HeatPhysicalBoundary.HEAT_BC_SYMMETRY
         return _proto
 
     def _from_proto(self, proto: clientpb.BoundaryConditionsHeat) -> None:
         super()._from_proto(proto)
-        assert proto.heat_physical_boundary == enum.HeatPhysicalBoundary.HEAT_BC_SYMMETRY.value
+        assert proto.heat_physical_boundary == clientpb.HeatPhysicalBoundary.HEAT_BC_SYMMETRY
         return None

luminarycloud/params/simulation/physics/heat/boundary_conditions/heat_bc_temperature_.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.physics.heat.boundary_conditions_heat_ import (
     BoundaryConditionsHeat,
@@ -32,12 +33,12 @@ class HeatBcTemperature(BoundaryConditionsHeat):
 
     def _to_proto(self) -> clientpb.BoundaryConditionsHeat:
         _proto = super()._to_proto()
-        _proto.heat_physical_boundary = enum.HeatPhysicalBoundary.HEAT_BC_ISOTHERMAL.value
+        _proto.heat_physical_boundary = clientpb.HeatPhysicalBoundary.HEAT_BC_ISOTHERMAL
         _proto.fixed_temperature.CopyFrom(_to_ad_proto(self.temperature))
         return _proto
 
     def _from_proto(self, proto: clientpb.BoundaryConditionsHeat) -> None:
         super()._from_proto(proto)
-        assert proto.heat_physical_boundary == enum.HeatPhysicalBoundary.HEAT_BC_ISOTHERMAL.value
+        assert proto.heat_physical_boundary == clientpb.HeatPhysicalBoundary.HEAT_BC_ISOTHERMAL
         self.temperature = _from_ad_proto(proto.fixed_temperature)
         return None

luminarycloud/params/simulation/physics/heat/boundary_conditions_heat_.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)
@@ -30,8 +31,8 @@ class BoundaryConditionsHeat(CodeRepr, ParamGroupWrapper[clientpb.BoundaryCondit
     ""
     enable_profile: bool = False
     "Turn on or off the ability to use tabulated data to define spatially varying boundary conditions."
-    profile_table: Optional[RectilinearTable] = None
-    "Tabulated data for spatially varying boundary conditions"
+    profile_table: RectilinearTable | None = None
+    "Tabulated data for spatially varying boundary conditions."
     profile_type: enum.ProfileType = enum.ProfileType.CARTESIAN_X
     "Types of boundary condition profile."
 

luminarycloud/params/simulation/physics/heat/heat_source/heat_source_type/__init__.py

@@ -1,2 +1,2 @@
-from .heat_source_type_power_per_unit_of_volume_ import HeatSourceTypePowerPerUnitOfVolume
 from .heat_source_type_power_ import HeatSourceTypePower
+from .heat_source_type_power_per_unit_of_volume_ import HeatSourceTypePowerPerUnitOfVolume

luminarycloud/params/simulation/physics/heat/heat_source/heat_source_type/heat_source_type_power_.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.physics.heat.heat_source.heat_source_type_ import (
     HeatSourceType,

luminarycloud/params/simulation/physics/heat/heat_source/heat_source_type/heat_source_type_power_per_unit_of_volume_.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.physics.heat.heat_source.heat_source_type_ import (
     HeatSourceType,
@@ -28,4 +29,4 @@ class HeatSourceTypePowerPerUnitOfVolume(HeatSourceType):
     """Specify heat source power in Watts per unit volume."""
 
     power_per_unit_volume: float = 0.0
-    "Power per unit volume of the heat source"
+    "Power per unit volume of the heat source."

luminarycloud/params/simulation/physics/heat/heat_source/heat_source_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/physics/heat/heat_source_.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.physics.heat.heat_source.heat_source_type_ import (
     HeatSourceType,
@@ -37,8 +38,8 @@ class HeatSource(CodeRepr, ParamGroupWrapper[clientpb.HeatSource]):
 
     enable_profile: bool = False
     "Turn on or off the ability to use tabulated data to define time varying heat sources."
-    profile_table: Optional[RectilinearTable] = None
-    "Tabulated data for time varying heat sources"
+    profile_table: RectilinearTable | None = None
+    "Tabulated data for time varying heat sources."
     profile_type: enum.ProfileType = enum.ProfileType.CARTESIAN_X
     "Types of boundary condition profile."
     heat_source_column_index: int = 0
@@ -50,7 +51,7 @@ class HeatSource(CodeRepr, ParamGroupWrapper[clientpb.HeatSource]):
     volumes: list[str] = field(default_factory=list)
     "Ids of the zones the heat source is applied to."
     heat_source_type: HeatSourceType = field(default_factory=HeatSourceTypePower)
-    "Heat source specification."
+    "Heat source specification. Possible types: ``HeatSourceTypePower``, ``HeatSourceTypePowerPerUnitOfVolume`` from the ``heat_source_type`` module."
 
     def _to_proto(self) -> clientpb.HeatSource:
         _proto = clientpb.HeatSource()