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

luminarycloud/params/simulation/physics/fluid/initialization/turbulence_initialization_.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/initialization_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
 
 
 @dataclass(kw_only=True)

luminarycloud/params/simulation/physics/fluid/physical_behavior/__init__.py

@@ -1,3 +1,3 @@
 from . import physical_behavior_model
-from .physical_behavior_model_ import PhysicalBehaviorModel
 from .blade_element_airfoil_data_ import BladeElementAirfoilData
+from .physical_behavior_model_ import PhysicalBehaviorModel

luminarycloud/params/simulation/physics/fluid/physical_behavior/blade_element_airfoil_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
 
 
 @dataclass(kw_only=True)
@@ -23,13 +24,13 @@ class BladeElementAirfoilData(CodeRepr, ParamGroupWrapper[clientpb.BladeElementA
     """Construct a blade by assigning airfoil profiles to different radial stations"""
 
     id: str = field(default_factory=create_unique_id, init=False)
-    "Assign a unique ID to this airfoil"
+    "Assign a unique ID to this airfoil."
     name: str = ""
-    "Apply a descriptive name to this airfoil"
+    "Apply a descriptive name to this airfoil."
     radial_station: float = 0
-    "Airfoil shape on the blade at this r/R"
-    airfoil_performance_table: Optional[RectilinearTable] = None
-    "Lift, drag, and pitching moment coefficients vs. alpha & Mach number"
+    "Airfoil shape on the blade at this r/R."
+    airfoil_performance_table: RectilinearTable | None = None
+    "Lift, drag, and pitching moment coefficients vs. alpha & Mach number."
 
     def _to_proto(self) -> clientpb.BladeElementAirfoilData:
         _proto = clientpb.BladeElementAirfoilData()

luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/__init__.py

@@ -1,7 +1,7 @@
 from . import actuator_disk_model
 from . import actuator_line_model
 from . import particle_source_model
-from .actuator_line_model_ import ActuatorLineModel
 from .actuator_disk_model_ import ActuatorDiskModel
+from .actuator_line_model_ import ActuatorLineModel
 from .blade_element_params_ import BladeElementParams
 from .particle_source_model_ import ParticleSourceModel

luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/actuator_disk_model/__init__.py

@@ -1,4 +1,4 @@
-from .actuator_disk_uniform_thrust_ import ActuatorDiskUniformThrust
 from .actuator_disk_blade_element_ import ActuatorDiskBladeElement
-from .fan_curve_internal_ import FanCurveInternal
 from .actuator_disk_radial_distribution_ import ActuatorDiskRadialDistribution
+from .actuator_disk_uniform_thrust_ import ActuatorDiskUniformThrust
+from .fan_curve_internal_ import FanCurveInternal

luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/actuator_disk_model/actuator_disk_blade_element_.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.physical_behavior.physical_behavior_model.actuator_disk_model_ import (
     ActuatorDiskModel,

luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/actuator_disk_model/actuator_disk_radial_distribution_.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.physical_behavior.physical_behavior_model.actuator_disk_model_ import (
     ActuatorDiskModel,
@@ -28,10 +29,10 @@ class ActuatorDiskRadialDistribution(ActuatorDiskModel):
     """Thrust, torque, and radial force profiles"""
 
     thrust: float = 0.0
-    "Thrust provided by the actuator disk"
+    "Thrust provided by the actuator disk."
     torque: float = 0.0
-    "Torque of the actuator disk"
+    "Torque of the actuator disk."
     radial_force: float = 0.0
-    "Radial force of the actuator disk"
-    radial_distribution_table: Optional[RectilinearTable] = None
-    "Radially dependent axial, circumferential, and radial force distribution"
+    "Radial force of the actuator disk."
+    radial_distribution_table: RectilinearTable | None = None
+    "Radially dependent axial, circumferential, and radial force distribution."

luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/actuator_disk_model/actuator_disk_uniform_thrust_.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.physical_behavior.physical_behavior_model.actuator_disk_model_ import (
     ActuatorDiskModel,
@@ -28,4 +29,4 @@ class ActuatorDiskUniformThrust(ActuatorDiskModel):
     """Applies a uniform force at all locations on the disk"""
 
     thrust: float = 0.0
-    "Thrust provided by the actuator disk"
+    "Thrust provided by the actuator disk."

luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/actuator_disk_model/fan_curve_internal_.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.physical_behavior.physical_behavior_model.actuator_disk_model_ import (
     ActuatorDiskModel,
@@ -27,7 +28,7 @@ from luminarycloud.params.simulation.physics.fluid.physical_behavior.physical_be
 class FanCurveInternal(ActuatorDiskModel):
     """Specify the relation between the fan pressure rise and the volume flow rate."""
 
-    fan_curve_table: Optional[RectilinearTable] = None
-    "Correlation between fan pressure rise and volume flow rate"
+    fan_curve_table: RectilinearTable | None = None
+    "Correlation between fan pressure rise and volume flow rate."
     head_loss_coefficient: float = 0.0
     "Fraction of dynamic pressure lost through the fan."

luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/actuator_disk_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
 
 from luminarycloud.params.simulation.physics.fluid.physical_behavior.physical_behavior_model_ import (
     PhysicalBehaviorModel,

luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/actuator_line_model/actuator_line_blade_element_.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.physical_behavior.physical_behavior_model.actuator_line_model_ import (
     ActuatorLineModel,

luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/actuator_line_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
 
 from luminarycloud.params.simulation.physics.fluid.physical_behavior.physical_behavior_model_ import (
     PhysicalBehaviorModel,

luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/blade_element_params_.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)
@@ -23,14 +24,14 @@ class BladeElementParams(CodeRepr):
     """"""
 
     rotation_rate: float = 100.0
-    "Rotational speed of the fictitious blades represented by the actuator disk"
+    "Rotational speed of the fictitious blades represented by the actuator disk."
     bem_strategy: enum.ActuatorDiskBemStrategy = enum.ActuatorDiskBemStrategy.BEM_ROTATION_RATE
-    "Defines how the power of the propeller is specified in the blade element model"
+    "Defines how the power of the propeller is specified in the blade element model."
     blade_count: int = 2
-    "Number of blades in the propeller/rotor"
+    "Number of blades in the propeller/rotor."
     pitch_schedule: Vector3 = field(default_factory=lambda: Vector3(0.0, 0.0, 0.0))
-    "Constant, cosine, and sine Fourier series coefficients for pitch first harmonic"
-    blade_geometry_table: Optional[RectilinearTable] = None
-    "Blade twist, sweep, anhedral, and chord vs. radial station (r/R)"
+    "Constant, cosine, and sine Fourier series coefficients for pitch first harmonic."
+    blade_geometry_table: RectilinearTable | None = None
+    "Blade twist, sweep, anhedral, and chord vs. radial station (r/R)."
     reference_sound_speed: float = 340.0
     "Reference sound speed required for each blade element model in constant density flows. Sound speed of air at sea level conditions is 340 m/s."

luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/particle_source_model/general_acceleration_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.fluid.physical_behavior.physical_behavior_model.particle_source_model_ import (
     ParticleSourceModel,
@@ -28,4 +29,4 @@ class GeneralAccelerationSource(ParticleSourceModel):
     """Applies an acceleration at particle locations"""
 
     acceleration: Vector3 = field(default_factory=lambda: Vector3(0.0, 0.0, -9.81))
-    "Acceleration applied by generic source particles"
+    "Acceleration applied by generic source particles."

luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/particle_source_model/general_mass_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.fluid.physical_behavior.physical_behavior_model.particle_source_model_ import (
     ParticleSourceModel,
@@ -28,4 +29,4 @@ class GeneralMassSource(ParticleSourceModel):
     """Injects material into the solver at particle locations"""
 
     mass_injection_rate: float = 0.0
-    "Mass injection rate supplied by particle group"
+    "Mass injection rate supplied by particle group."

luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/particle_source_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
 
 from luminarycloud.params.simulation.physics.fluid.physical_behavior.physical_behavior_model_ import (
     PhysicalBehaviorModel,

luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_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/physical_behavior_.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.physical_behavior.physical_behavior_model.actuator_disk_model.actuator_disk_blade_element_ import (
     ActuatorDiskBladeElement,
@@ -76,9 +77,9 @@ class PhysicalBehavior(CodeRepr, ParamGroupWrapper[clientpb.PhysicalBehavior]):
     name: str = ""
     ""
     physical_behavior_model: PhysicalBehaviorModel = field(default_factory=ActuatorDiskModel)
-    "Defines the physical behavior type."
+    "Defines the physical behavior type. Possible types: ``ActuatorDiskModel``, ``ActuatorLineModel``, ``ParticleSourceModel`` from the ``physical_behavior_model`` module."
     blade_element_airfoil_data: list[BladeElementAirfoilData] = field(default_factory=list)
-    "Construct a blade by assigning airfoil profiles to different radial stations"
+    "Construct a blade by assigning airfoil profiles to different radial stations."
 
     def _to_proto(self) -> clientpb.PhysicalBehavior:
         _proto = clientpb.PhysicalBehavior()

luminarycloud/params/simulation/physics/fluid/porous_behavior_.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/solution_controls/__init__.py

@@ -1,4 +1,4 @@
 from . import fluid_relaxation_method
 from . import pseudo_time_step_method
-from .pseudo_time_step_method_ import PseudoTimeStepMethod
 from .fluid_relaxation_method_ import FluidRelaxationMethod
+from .pseudo_time_step_method_ import PseudoTimeStepMethod

luminarycloud/params/simulation/physics/fluid/solution_controls/fluid_relaxation_method/fluid_explicit_relaxation_.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.solution_controls.fluid_relaxation_method_ import (
     FluidRelaxationMethod,

luminarycloud/params/simulation/physics/fluid/solution_controls/fluid_relaxation_method/fluid_implicit_relaxation/robust_startup/robust_startup_off_.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.solution_controls.fluid_relaxation_method.fluid_implicit_relaxation.robust_startup_ import (
     RobustStartup,

luminarycloud/params/simulation/physics/fluid/solution_controls/fluid_relaxation_method/fluid_implicit_relaxation/robust_startup/robust_startup_on_.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.solution_controls.fluid_relaxation_method.fluid_implicit_relaxation.robust_startup_ import (
     RobustStartup,

luminarycloud/params/simulation/physics/fluid/solution_controls/fluid_relaxation_method/fluid_implicit_relaxation/robust_startup_.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/solution_controls/fluid_relaxation_method/fluid_implicit_relaxation_.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.solution_controls.fluid_relaxation_method_ import (
     FluidRelaxationMethod,
@@ -54,17 +55,17 @@ class FluidImplicitRelaxation(FluidRelaxationMethod):
     implicit_method: enum.ImplicitMethod = enum.ImplicitMethod.BACKWARD_EULER
     "Scheme for implicit relaxation of the governing equations."
     linear_solver_type: LinearSolverType = field(default_factory=GaussSeidel)
-    "Type of linear solver used for implicit relaxation."
+    "Type of linear solver used for implicit relaxation. Possible types: ``GaussSeidel``, ``GsAmgx``, ``KrylovAmg``, ``Amg`` from the ``linear_solver_type`` module."
     jacobian_update_method: enum.JacobianUpdateMethod = (
         enum.JacobianUpdateMethod.EXPLICIT_INTERVAL_AND_WARMUP
     )
-    "Method for determining how often to "
+    "Method for determining how often to ."
     jacobian_update_interval: float = 1.0
     "How many iterations in between updating the Jacobian values for implicit solving."
     jacobian_warmup_threshold: int = 300
-    "How many iterations to update Jacobians every iteration before switching to the specified 'Jacobian Update Interval'"
+    "How many iterations to update Jacobians every iteration before switching to the specified 'Jacobian Update Interval'."
     robust_startup: RobustStartup = field(default_factory=RobustStartupOn)
-    "Applies a robust startup process during the initial transients of a simulation. Applicable to steady problems only."
+    "Applies a robust startup process during the initial transients of a simulation. Applicable to steady problems only. Possible types: ``RobustStartupOn``, ``RobustStartupOff`` from the ``robust_startup`` module."
     relaxation_flow: float = 1.0
     "Under-relaxation factor in [0,1] applied to the mean flow solution update with each implicit nonlinear iteration. Default of 1.0."
     relaxation_turb: float = 0.5

luminarycloud/params/simulation/physics/fluid/solution_controls/fluid_relaxation_method_.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)