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

luminarycloud/params/enum/_enum_wrappers.py

@@ -5,6 +5,468 @@ from enum import IntEnum as _IntEnum
 from luminarycloud._proto.client import simulation_pb2 as _clientpb
 
 
+class UnitSystem(_IntEnum):
+    """
+    Collection of units used for all quantities.
+
+    Attributes
+    ----------
+    UNIT_SYSTEM_CUSTOM
+        Customize the units used for the main types of quantities.
+    UNIT_SYSTEM_SI
+        International System of Units (SI).
+    UNIT_SYSTEM_US
+        US Customary Units.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import UnitSystem
+    >>> UnitSystem.UNIT_SYSTEM_CUSTOM
+    >>> UnitSystem.UNIT_SYSTEM_SI
+    >>> UnitSystem.UNIT_SYSTEM_US
+    """
+
+    UNIT_SYSTEM_CUSTOM = _clientpb.UNIT_SYSTEM_CUSTOM
+    UNIT_SYSTEM_SI = _clientpb.UNIT_SYSTEM_SI
+    UNIT_SYSTEM_US = _clientpb.UNIT_SYSTEM_US
+
+
+class TemperatureUnit(_IntEnum):
+    """
+    Unit used for temperature.
+
+    Attributes
+    ----------
+    UNIT_KELVIN
+        Kelvin scale.
+    UNIT_CELSIUS
+        Degree Celsius.
+    UNIT_RANKINE
+        Degree Rankine.
+    UNIT_FAHRENHEIT
+        Degree Fahrenheit.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import TemperatureUnit
+    >>> TemperatureUnit.UNIT_KELVIN
+    >>> TemperatureUnit.UNIT_CELSIUS
+    >>> TemperatureUnit.UNIT_RANKINE
+    >>> TemperatureUnit.UNIT_FAHRENHEIT
+    """
+
+    UNIT_KELVIN = _clientpb.UNIT_KELVIN
+    UNIT_CELSIUS = _clientpb.UNIT_CELSIUS
+    UNIT_RANKINE = _clientpb.UNIT_RANKINE
+    UNIT_FAHRENHEIT = _clientpb.UNIT_FAHRENHEIT
+
+
+class MassUnit(_IntEnum):
+    """
+    Unit used for mass.
+
+    Attributes
+    ----------
+    UNIT_KILOGRAM
+        Kilogram.
+    UNIT_GRAM
+        Gram.
+    UNIT_POUND
+        Pound.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import MassUnit
+    >>> MassUnit.UNIT_KILOGRAM
+    >>> MassUnit.UNIT_GRAM
+    >>> MassUnit.UNIT_POUND
+    """
+
+    UNIT_KILOGRAM = _clientpb.UNIT_KILOGRAM
+    UNIT_GRAM = _clientpb.UNIT_GRAM
+    UNIT_POUND = _clientpb.UNIT_POUND
+
+
+class LengthUnit(_IntEnum):
+    """
+    Unit used for length.
+
+    Attributes
+    ----------
+    UNIT_METER
+        Meter.
+    UNIT_MILLIMETER
+        Millimeter.
+    UNIT_FOOT
+        Foot.
+    UNIT_INCH
+        Inch.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import LengthUnit
+    >>> LengthUnit.UNIT_METER
+    >>> LengthUnit.UNIT_MILLIMETER
+    >>> LengthUnit.UNIT_FOOT
+    >>> LengthUnit.UNIT_INCH
+    """
+
+    UNIT_METER = _clientpb.UNIT_METER
+    UNIT_MILLIMETER = _clientpb.UNIT_MILLIMETER
+    UNIT_FOOT = _clientpb.UNIT_FOOT
+    UNIT_INCH = _clientpb.UNIT_INCH
+
+
+class AngleUnit(_IntEnum):
+    """
+    Unit used for angles.
+
+    Attributes
+    ----------
+    UNIT_DEGREE
+        Degree.
+    UNIT_RADIAN
+        Radian.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import AngleUnit
+    >>> AngleUnit.UNIT_DEGREE
+    >>> AngleUnit.UNIT_RADIAN
+    """
+
+    UNIT_DEGREE = _clientpb.UNIT_DEGREE
+    UNIT_RADIAN = _clientpb.UNIT_RADIAN
+
+
+class TimeUnit(_IntEnum):
+    """
+    Unit used for time.
+
+    Attributes
+    ----------
+    UNIT_SECOND
+        Second.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import TimeUnit
+    >>> TimeUnit.UNIT_SECOND
+    """
+
+    UNIT_SECOND = _clientpb.UNIT_SECOND
+
+
+class VelocityUnit(_IntEnum):
+    """
+    Unit used for velocity.
+
+    Attributes
+    ----------
+    UNIT_METER_PER_SECOND
+        Meters per second.
+    UNIT_KM_PER_HOUR
+        Kilometers per hour.
+    UNIT_FEET_PER_SECOND
+        Feet per second.
+    UNIT_MILES_PER_HOUR
+        Miles per hour.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import VelocityUnit
+    >>> VelocityUnit.UNIT_METER_PER_SECOND
+    >>> VelocityUnit.UNIT_KM_PER_HOUR
+    >>> VelocityUnit.UNIT_FEET_PER_SECOND
+    >>> VelocityUnit.UNIT_MILES_PER_HOUR
+    """
+
+    UNIT_METER_PER_SECOND = _clientpb.UNIT_METER_PER_SECOND
+    UNIT_KM_PER_HOUR = _clientpb.UNIT_KM_PER_HOUR
+    UNIT_FEET_PER_SECOND = _clientpb.UNIT_FEET_PER_SECOND
+    UNIT_MILES_PER_HOUR = _clientpb.UNIT_MILES_PER_HOUR
+
+
+class AngularVelocityUnit(_IntEnum):
+    """
+    Unit used for angular velocity.
+
+    Attributes
+    ----------
+    UNIT_RADIAN_PER_SECOND
+        Radian per second.
+    UNIT_RPM
+        Revolutions per minute.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import AngularVelocityUnit
+    >>> AngularVelocityUnit.UNIT_RADIAN_PER_SECOND
+    >>> AngularVelocityUnit.UNIT_RPM
+    """
+
+    UNIT_RADIAN_PER_SECOND = _clientpb.UNIT_RADIAN_PER_SECOND
+    UNIT_RPM = _clientpb.UNIT_RPM
+
+
+class ForceUnit(_IntEnum):
+    """
+    Unit used for force.
+
+    Attributes
+    ----------
+    UNIT_NEWTON
+        Newton.
+    UNIT_POUND_FORCE
+        Pound-force.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import ForceUnit
+    >>> ForceUnit.UNIT_NEWTON
+    >>> ForceUnit.UNIT_POUND_FORCE
+    """
+
+    UNIT_NEWTON = _clientpb.UNIT_NEWTON
+    UNIT_POUND_FORCE = _clientpb.UNIT_POUND_FORCE
+
+
+class MomentUnit(_IntEnum):
+    """
+    Unit used for moment.
+
+    Attributes
+    ----------
+    UNIT_NEWTON_METER
+        Newton-meter.
+    UNIT_POUND_FOOT
+        Pound-foot.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import MomentUnit
+    >>> MomentUnit.UNIT_NEWTON_METER
+    >>> MomentUnit.UNIT_POUND_FOOT
+    """
+
+    UNIT_NEWTON_METER = _clientpb.UNIT_NEWTON_METER
+    UNIT_POUND_FOOT = _clientpb.UNIT_POUND_FOOT
+
+
+class PressureUnit(_IntEnum):
+    """
+    Unit used for pressure.
+
+    Attributes
+    ----------
+    UNIT_PASCAL
+        Pascal.
+    UNIT_BAR
+        Bar.
+    UNIT_PSI
+        Pound per square inch.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import PressureUnit
+    >>> PressureUnit.UNIT_PASCAL
+    >>> PressureUnit.UNIT_BAR
+    >>> PressureUnit.UNIT_PSI
+    """
+
+    UNIT_PASCAL = _clientpb.UNIT_PASCAL
+    UNIT_BAR = _clientpb.UNIT_BAR
+    UNIT_PSI = _clientpb.UNIT_PSI
+
+
+class EnergyUnit(_IntEnum):
+    """
+    Unit used for energy.
+
+    Attributes
+    ----------
+    UNIT_JOULE
+        Joule.
+    UNIT_BTU
+        British thermal unit.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import EnergyUnit
+    >>> EnergyUnit.UNIT_JOULE
+    >>> EnergyUnit.UNIT_BTU
+    """
+
+    UNIT_JOULE = _clientpb.UNIT_JOULE
+    UNIT_BTU = _clientpb.UNIT_BTU
+
+
+class PowerUnit(_IntEnum):
+    """
+    Unit used for power.
+
+    Attributes
+    ----------
+    UNIT_WATT
+        Watt.
+    UNIT_HORSEPOWER
+        Horsepower.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import PowerUnit
+    >>> PowerUnit.UNIT_WATT
+    >>> PowerUnit.UNIT_HORSEPOWER
+    """
+
+    UNIT_WATT = _clientpb.UNIT_WATT
+    UNIT_HORSEPOWER = _clientpb.UNIT_HORSEPOWER
+
+
+class VolumeUnit(_IntEnum):
+    """
+    Unit used for volume.
+
+    Attributes
+    ----------
+    UNIT_CUBIC_METER
+        Cubic meter.
+    UNIT_LITER
+        Liter.
+    UNIT_GALLON
+        US gallon.
+    UNIT_CUBIC_INCH
+        Cubic inch.
+    UNIT_CUBIC_FOOT
+        Cubic foot.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import VolumeUnit
+    >>> VolumeUnit.UNIT_CUBIC_METER
+    >>> VolumeUnit.UNIT_LITER
+    >>> VolumeUnit.UNIT_GALLON
+    >>> VolumeUnit.UNIT_CUBIC_INCH
+    >>> VolumeUnit.UNIT_CUBIC_FOOT
+    """
+
+    UNIT_CUBIC_METER = _clientpb.UNIT_CUBIC_METER
+    UNIT_LITER = _clientpb.UNIT_LITER
+    UNIT_GALLON = _clientpb.UNIT_GALLON
+    UNIT_CUBIC_INCH = _clientpb.UNIT_CUBIC_INCH
+    UNIT_CUBIC_FOOT = _clientpb.UNIT_CUBIC_FOOT
+
+
+class VolumetricFlowUnit(_IntEnum):
+    """
+    Unit used for volumetric flow.
+
+    Attributes
+    ----------
+    UNIT_CUBIC_METER_PER_SECOND
+        Cubic meter per second.
+    UNIT_CFM
+        Cubic feet per minute.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import VolumetricFlowUnit
+    >>> VolumetricFlowUnit.UNIT_CUBIC_METER_PER_SECOND
+    >>> VolumetricFlowUnit.UNIT_CFM
+    """
+
+    UNIT_CUBIC_METER_PER_SECOND = _clientpb.UNIT_CUBIC_METER_PER_SECOND
+    UNIT_CFM = _clientpb.UNIT_CFM
+
+
+class ViscosityUnit(_IntEnum):
+    """
+    Unit used for dynamic viscosity.
+
+    Attributes
+    ----------
+    UNIT_PASCAL_SECOND
+        Pascal-second.
+    UNIT_CENTIPOISE
+        Centipoise.
+    UNIT_POUND_SECOND_PER_SQUARE_FOOT
+        Pound-seconds per square foot.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import ViscosityUnit
+    >>> ViscosityUnit.UNIT_PASCAL_SECOND
+    >>> ViscosityUnit.UNIT_CENTIPOISE
+    >>> ViscosityUnit.UNIT_POUND_SECOND_PER_SQUARE_FOOT
+    """
+
+    UNIT_PASCAL_SECOND = _clientpb.UNIT_PASCAL_SECOND
+    UNIT_CENTIPOISE = _clientpb.UNIT_CENTIPOISE
+    UNIT_POUND_SECOND_PER_SQUARE_FOOT = _clientpb.UNIT_POUND_SECOND_PER_SQUARE_FOOT
+
+
+class ConductivityUnit(_IntEnum):
+    """
+    Unit used for thermal conductivity.
+
+    Attributes
+    ----------
+    UNIT_WATT_PER_METER_KELVIN
+        Watt per meter-Kelvin.
+    UNIT_BTU_PER_HOUR_FOOT_FAHRENHEIT
+        BTU per hour-foot-Fahrenheit.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import ConductivityUnit
+    >>> ConductivityUnit.UNIT_WATT_PER_METER_KELVIN
+    >>> ConductivityUnit.UNIT_BTU_PER_HOUR_FOOT_FAHRENHEIT
+    """
+
+    UNIT_WATT_PER_METER_KELVIN = _clientpb.UNIT_WATT_PER_METER_KELVIN
+    UNIT_BTU_PER_HOUR_FOOT_FAHRENHEIT = _clientpb.UNIT_BTU_PER_HOUR_FOOT_FAHRENHEIT
+
+
+class MolecularWeightUnit(_IntEnum):
+    """
+    Unit used for molecular weight.
+
+    Attributes
+    ----------
+    UNIT_GRAM_PER_MOLE
+        Grams per mole.
+    UNIT_POUND_PER_POUND_MOLE
+        Pounds per pound-mole.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import MolecularWeightUnit
+    >>> MolecularWeightUnit.UNIT_GRAM_PER_MOLE
+    >>> MolecularWeightUnit.UNIT_POUND_PER_POUND_MOLE
+    """
+
+    UNIT_GRAM_PER_MOLE = _clientpb.UNIT_GRAM_PER_MOLE
+    UNIT_POUND_PER_POUND_MOLE = _clientpb.UNIT_POUND_PER_POUND_MOLE
+
+
 class DensityRelationship(_IntEnum):
     """
     Relationship for computing the density of the fluid.
@@ -17,6 +479,14 @@ class DensityRelationship(_IntEnum):
         Constant density fluid (heat transfer is not simulated).
     CONSTANT_DENSITY_ENERGY
         Constant density fluid with energy equation.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import DensityRelationship
+    >>> DensityRelationship.IDEAL_GAS
+    >>> DensityRelationship.CONSTANT_DENSITY
+    >>> DensityRelationship.CONSTANT_DENSITY_ENERGY
     """
 
     IDEAL_GAS = _clientpb.IDEAL_GAS
@@ -36,6 +506,14 @@ class LaminarThermalConductivity(_IntEnum):
         Constant laminar thermal conductivity or tabulated values vs temperature.
     TEMPERATURE_DEPENDENT_THERMAL_CONDUCTIVITY
         Tabulated thermal conductivity values vs temperature.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import LaminarThermalConductivity
+    >>> LaminarThermalConductivity.LAMINAR_CONSTANT_THERMAL_PRANDTL
+    >>> LaminarThermalConductivity.LAMINAR_CONSTANT_THERMAL_CONDUCTIVITY
+    >>> LaminarThermalConductivity.TEMPERATURE_DEPENDENT_THERMAL_CONDUCTIVITY
     """
 
     LAMINAR_CONSTANT_THERMAL_PRANDTL = _clientpb.LAMINAR_CONSTANT_THERMAL_PRANDTL
@@ -55,6 +533,13 @@ class BoussinesqApproximation(_IntEnum):
         Disable Boussinesq approximation.
     BOUSSINESQ_ON
         Enable Boussinesq approximation.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import BoussinesqApproximation
+    >>> BoussinesqApproximation.BOUSSINESQ_OFF
+    >>> BoussinesqApproximation.BOUSSINESQ_ON
     """
 
     BOUSSINESQ_OFF = _clientpb.BOUSSINESQ_OFF
@@ -75,6 +560,15 @@ class MaterialFluidPreset(_IntEnum):
         Properties of water at 1 atmosphere and 20° Celsius
     CUSTOM_MATERIAL_FLUID
         A custom set of material properties.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import MaterialFluidPreset
+    >>> MaterialFluidPreset.UNSET_MATERIAL_FLUID_PRESET
+    >>> MaterialFluidPreset.STANDARD_AIR
+    >>> MaterialFluidPreset.WATER_NTP
+    >>> MaterialFluidPreset.CUSTOM_MATERIAL_FLUID
     """
 
     UNSET_MATERIAL_FLUID_PRESET = _clientpb.UNSET_MATERIAL_FLUID_PRESET
@@ -95,6 +589,14 @@ class LaminarViscosityModelNewtonian(_IntEnum):
         Constant dynamic viscosity or tabulated values vs temperature.
     TEMPERATURE_DEPENDENT_LAMINAR_VISCOSITY
         Tabulated dynamic viscosity values vs temperature.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import LaminarViscosityModelNewtonian
+    >>> LaminarViscosityModelNewtonian.SUTHERLAND
+    >>> LaminarViscosityModelNewtonian.LAMINAR_CONSTANT_VISCOSITY
+    >>> LaminarViscosityModelNewtonian.TEMPERATURE_DEPENDENT_LAMINAR_VISCOSITY
     """
 
     SUTHERLAND = _clientpb.SUTHERLAND
@@ -120,6 +622,17 @@ class MaterialSolidPreset(_IntEnum):
         Properties of pure titanium.
     CUSTOM_MATERIAL_SOLID
         A custom set of material properties.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import MaterialSolidPreset
+    >>> MaterialSolidPreset.ALUMINUM
+    >>> MaterialSolidPreset.COPPER
+    >>> MaterialSolidPreset.IRON
+    >>> MaterialSolidPreset.NICKEL
+    >>> MaterialSolidPreset.TITANIUM
+    >>> MaterialSolidPreset.CUSTOM_MATERIAL_SOLID
     """
 
     ALUMINUM = _clientpb.ALUMINUM
@@ -143,6 +656,14 @@ class FloatType(_IntEnum):
     ADA1D
         Solve the discrete adjoint equations to obtain geometric
                         sensitivities with respect to an output of interest.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import FloatType
+    >>> FloatType.DOUBLE
+    >>> FloatType.ADT1D
+    >>> FloatType.ADA1D
     """
 
     DOUBLE = _clientpb.DOUBLE
@@ -160,6 +681,13 @@ class Gravity(_IntEnum):
         Disable gravity or other body force.
     GRAVITY_ON
         Enable gravity or other body force.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import Gravity
+    >>> Gravity.GRAVITY_OFF
+    >>> Gravity.GRAVITY_ON
     """
 
     GRAVITY_OFF = _clientpb.GRAVITY_OFF
@@ -176,6 +704,13 @@ class FlowBehavior(_IntEnum):
         Solve for a steady-state solution of the governing equations.
     TRANSIENT
         Solve for a time-accurate solution of the governing equations.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import FlowBehavior
+    >>> FlowBehavior.STEADY
+    >>> FlowBehavior.TRANSIENT
     """
 
     STEADY = _clientpb.STEADY
@@ -192,6 +727,13 @@ class TimeMarching(_IntEnum):
         Implicit scheme (dual time stepping) for time-accurate integration.
     TIME_EXPLICIT
         Explicit scheme for time-accurate integration.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import TimeMarching
+    >>> TimeMarching.TIME_IMPLICIT
+    >>> TimeMarching.TIME_EXPLICIT
     """
 
     TIME_IMPLICIT = _clientpb.TIME_IMPLICIT
@@ -208,6 +750,13 @@ class TimeImplicitOrder(_IntEnum):
         Second-order backward Euler integration.
     TIME_FIRST
         First-order backward Euler integration.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import TimeImplicitOrder
+    >>> TimeImplicitOrder.TIME_SECOND
+    >>> TimeImplicitOrder.TIME_FIRST
     """
 
     TIME_SECOND = _clientpb.TIME_SECOND
@@ -222,6 +771,12 @@ class PhysicalTimeStepMethod(_IntEnum):
     ----------
     FIXED_TIME_STEP
         Apply a fixed physical time step.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import PhysicalTimeStepMethod
+    >>> PhysicalTimeStepMethod.FIXED_TIME_STEP
     """
 
     FIXED_TIME_STEP = _clientpb.FIXED_TIME_STEP
@@ -239,6 +794,13 @@ class TimeStepRamp(_IntEnum):
         Disable physical time step ramping.
     TIME_STEP_RAMP_ON
         Enable physical time step ramping.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import TimeStepRamp
+    >>> TimeStepRamp.TIME_STEP_RAMP_OFF
+    >>> TimeStepRamp.TIME_STEP_RAMP_ON
     """
 
     TIME_STEP_RAMP_OFF = _clientpb.TIME_STEP_RAMP_OFF
@@ -255,6 +817,13 @@ class ComputeStatistics(_IntEnum):
         Disable computation of transient statistics.
     COMPUTE_STATISTICS_ON
         Enable computation of transient statistics.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import ComputeStatistics
+    >>> ComputeStatistics.COMPUTE_STATISTICS_OFF
+    >>> ComputeStatistics.COMPUTE_STATISTICS_ON
     """
 
     COMPUTE_STATISTICS_OFF = _clientpb.COMPUTE_STATISTICS_OFF
@@ -275,6 +844,15 @@ class MotionType(_IntEnum):
         Motion is defined by specifying an initial rotation and constant angular velocity.
     CONSTANT_VELOCITY_MOTION
         Motion is defined by specifying constant translational and angular velocities.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import MotionType
+    >>> MotionType.NO_MOTION
+    >>> MotionType.CONSTANT_TRANSLATION_MOTION
+    >>> MotionType.CONSTANT_ANGULAR_MOTION
+    >>> MotionType.CONSTANT_VELOCITY_MOTION
     """
 
     NO_MOTION = _clientpb.NO_MOTION
@@ -294,6 +872,13 @@ class MotionFormulation(_IntEnum):
     MRF_MOTION_FORMULATION
         The equations are solved in a moving reference frame without
                         moving the mesh. This choice affects the child frames of this frame.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import MotionFormulation
+    >>> MotionFormulation.AUTOMATIC_MOTION_FORMULATION
+    >>> MotionFormulation.MRF_MOTION_FORMULATION
     """
 
     AUTOMATIC_MOTION_FORMULATION = _clientpb.AUTOMATIC_MOTION_FORMULATION
@@ -310,6 +895,13 @@ class MotionSpecification(_IntEnum):
         The mesh is repositioned at simulation start time using the initial displacement or rotation
     MOTION_SPECIFICATION_NORMAL
         Specify both initial translation or rotation and angular or translational velocities
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import MotionSpecification
+    >>> MotionSpecification.MOTION_SPECIFICATION_REPOSITION
+    >>> MotionSpecification.MOTION_SPECIFICATION_NORMAL
     """
 
     MOTION_SPECIFICATION_REPOSITION = _clientpb.MOTION_SPECIFICATION_REPOSITION
@@ -328,6 +920,14 @@ class TransformType(_IntEnum):
         Rotational Transformation
     TRANSLATIONAL_TRANSFORM
         Translational Transformation
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import TransformType
+    >>> TransformType.NO_TRANSFORM
+    >>> TransformType.ROTATIONAL_TRANSFORM
+    >>> TransformType.TRANSLATIONAL_TRANSFORM
     """
 
     NO_TRANSFORM = _clientpb.NO_TRANSFORM
@@ -349,6 +949,15 @@ class ParticleGroupType(_IntEnum):
         Injects material into the solver at particle locations
     PROBE_POINTS
         Reports solver variables at probe locations.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import ParticleGroupType
+    >>> ParticleGroupType.ACTUATOR_DISK
+    >>> ParticleGroupType.ACTUATOR_LINE
+    >>> ParticleGroupType.SOURCE_POINTS
+    >>> ParticleGroupType.PROBE_POINTS
     """
 
     ACTUATOR_DISK = _clientpb.ACTUATOR_DISK
@@ -367,6 +976,13 @@ class ActuatorDiskOrientationSelection(_IntEnum):
         Specify rotation about x-, y-, and z- axes
     ACTUATOR_DISK_SPECIFY_NORMAL_VECTOR
         Specify the normal direction to the plane of the actuator disk.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import ActuatorDiskOrientationSelection
+    >>> ActuatorDiskOrientationSelection.ACTUATOR_DISK_SPECIFY_ROTATION_ANGLES
+    >>> ActuatorDiskOrientationSelection.ACTUATOR_DISK_SPECIFY_NORMAL_VECTOR
     """
 
     ACTUATOR_DISK_SPECIFY_ROTATION_ANGLES = _clientpb.ACTUATOR_DISK_SPECIFY_ROTATION_ANGLES
@@ -383,6 +999,13 @@ class DebugOutput(_IntEnum):
         Disable debug output.
     SOLN_DEBUG_OUTPUT_ON
         Enable debug output.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import DebugOutput
+    >>> DebugOutput.SOLN_DEBUG_OUTPUT_OFF
+    >>> DebugOutput.SOLN_DEBUG_OUTPUT_ON
     """
 
     SOLN_DEBUG_OUTPUT_OFF = _clientpb.SOLN_DEBUG_OUTPUT_OFF
@@ -399,6 +1022,13 @@ class DebugOutputInteriorSurfaceData(_IntEnum):
         Disable debug output.
     SOLN_DEBUG_OUTPUT_INT_SURF_DATA_ON
         Enable debug output.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import DebugOutputInteriorSurfaceData
+    >>> DebugOutputInteriorSurfaceData.SOLN_DEBUG_OUTPUT_INT_SURF_DATA_OFF
+    >>> DebugOutputInteriorSurfaceData.SOLN_DEBUG_OUTPUT_INT_SURF_DATA_ON
     """
 
     SOLN_DEBUG_OUTPUT_INT_SURF_DATA_OFF = _clientpb.SOLN_DEBUG_OUTPUT_INT_SURF_DATA_OFF
@@ -415,6 +1045,13 @@ class MeshingMethod(_IntEnum):
         Using user inputs to guide single, manual mesh generation.
     MESH_METHOD_AUTO
         Using solution-based adaptive mesh refinement.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import MeshingMethod
+    >>> MeshingMethod.MESH_METHOD_MANUAL
+    >>> MeshingMethod.MESH_METHOD_AUTO
     """
 
     MESH_METHOD_MANUAL = _clientpb.MESH_METHOD_MANUAL
@@ -434,6 +1071,14 @@ class AllTet(_IntEnum):
 
     ALL_TET_ON
 
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import AllTet
+    >>> AllTet.ALL_TET_UNSET
+    >>> AllTet.ALL_TET_OFF
+    >>> AllTet.ALL_TET_ON
     """
 
     ALL_TET_UNSET = _clientpb.ALL_TET_UNSET
@@ -451,6 +1096,13 @@ class RelaxationMethod(_IntEnum):
         Apply an implicit relaxation scheme.
     EXPLICIT
         Apply an explicit relaxation scheme.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import RelaxationMethod
+    >>> RelaxationMethod.IMPLICIT
+    >>> RelaxationMethod.EXPLICIT
     """
 
     IMPLICIT = _clientpb.IMPLICIT
@@ -465,6 +1117,12 @@ class ImplicitMethod(_IntEnum):
     ----------
     BACKWARD_EULER
         First-order backward Euler scheme.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import ImplicitMethod
+    >>> ImplicitMethod.BACKWARD_EULER
     """
 
     BACKWARD_EULER = _clientpb.BACKWARD_EULER
@@ -484,6 +1142,15 @@ class LinearSolverType(_IntEnum):
         AMG + Krylov iterative method.
     AMG_AMGX
         AMG iterative method.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import LinearSolverType
+    >>> LinearSolverType.GS
+    >>> LinearSolverType.GS_AMGX
+    >>> LinearSolverType.AMG_KRYLOV_AMGX
+    >>> LinearSolverType.AMG_AMGX
     """
 
     GS = _clientpb.GS
@@ -504,6 +1171,14 @@ class LinsolAmgCycleType(_IntEnum):
         W cycle
     LINSOL_AMG_CYCLE_TYPE_F
         F cycle
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import LinsolAmgCycleType
+    >>> LinsolAmgCycleType.LINSOL_AMG_CYCLE_TYPE_V
+    >>> LinsolAmgCycleType.LINSOL_AMG_CYCLE_TYPE_W
+    >>> LinsolAmgCycleType.LINSOL_AMG_CYCLE_TYPE_F
     """
 
     LINSOL_AMG_CYCLE_TYPE_V = _clientpb.LINSOL_AMG_CYCLE_TYPE_V
@@ -523,6 +1198,14 @@ class LinsolAmgSmoother(_IntEnum):
         Gauss-Seidel
     LINSOL_AMG_SMOOTHER_SYM_GS
         Symmetric Gauss-Seidel
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import LinsolAmgSmoother
+    >>> LinsolAmgSmoother.LINSOL_AMG_SMOOTHER_JACOBI
+    >>> LinsolAmgSmoother.LINSOL_AMG_SMOOTHER_GS
+    >>> LinsolAmgSmoother.LINSOL_AMG_SMOOTHER_SYM_GS
     """
 
     LINSOL_AMG_SMOOTHER_JACOBI = _clientpb.LINSOL_AMG_SMOOTHER_JACOBI
@@ -542,6 +1225,14 @@ class ExplicitMethod(_IntEnum):
         Total Variation Diminishing Runge-Kutta third-order scheme.
     FORWARD_EULER
         First-order forward Euler scheme.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import ExplicitMethod
+    >>> ExplicitMethod.RK_4
+    >>> ExplicitMethod.TVD_RK_3
+    >>> ExplicitMethod.FORWARD_EULER
     """
 
     RK_4 = _clientpb.RK_4
@@ -565,6 +1256,16 @@ class SolutionControlsHeatPreset(_IntEnum):
         Aggressive settings further biased towards speed.
     CUSTOM_SOLUTION_CONTROLS_HEAT
         Custom solution controls.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import SolutionControlsHeatPreset
+    >>> SolutionControlsHeatPreset.UNSET_SOLUTION_CONTROLS_HEAT_PRESET
+    >>> SolutionControlsHeatPreset.DEFAULT_SOLUTION_CONTROLS_HEAT
+    >>> SolutionControlsHeatPreset.INTERMEDIATE_SOLUTION_CONTROLS_HEAT
+    >>> SolutionControlsHeatPreset.AGGRESSIVE_SOLUTION_CONTROLS_HEAT
+    >>> SolutionControlsHeatPreset.CUSTOM_SOLUTION_CONTROLS_HEAT
     """
 
     UNSET_SOLUTION_CONTROLS_HEAT_PRESET = _clientpb.UNSET_SOLUTION_CONTROLS_HEAT_PRESET
@@ -586,6 +1287,14 @@ class AdjointSolutionMethod(_IntEnum):
         Use a preconditioned Richardson iteration to solve the equations.
     ADJOINT_METHOD_ALGORITHMIC
         Use a fully consistent algorithmic differentiation approach.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import AdjointSolutionMethod
+    >>> AdjointSolutionMethod.ADJOINT_METHOD_GMRES
+    >>> AdjointSolutionMethod.ADJOINT_METHOD_RICHARDSON
+    >>> AdjointSolutionMethod.ADJOINT_METHOD_ALGORITHMIC
     """
 
     ADJOINT_METHOD_GMRES = _clientpb.ADJOINT_METHOD_GMRES
@@ -610,6 +1319,16 @@ class GradientMethod(_IntEnum):
     NODAL_GRADIENT
         Gradients computed using nodal values interpolated from the
                         cell-centered solution.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import GradientMethod
+    >>> GradientMethod.HLSQ
+    >>> GradientMethod.WEIGHTED_LEAST_SQUARES
+    >>> GradientMethod.GREEN_GAUSS
+    >>> GradientMethod.LC_HLSQ
+    >>> GradientMethod.NODAL_GRADIENT
     """
 
     HLSQ = _clientpb.HLSQ
@@ -629,6 +1348,13 @@ class GeometryFixes(_IntEnum):
         Enable geometry fixes.
     GEOMETRY_FIXES_OFF
         Disable geometry fixes.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import GeometryFixes
+    >>> GeometryFixes.GEOMETRY_FIXES_ON
+    >>> GeometryFixes.GEOMETRY_FIXES_OFF
     """
 
     GEOMETRY_FIXES_ON = _clientpb.GEOMETRY_FIXES_ON
@@ -651,6 +1377,16 @@ class SpatialDiscretizationHeatPreset(_IntEnum):
         Settings that emphasize accuracy (relative to default).
     CUSTOM_SPATIAL_DISCRETIZATION_HEAT
         Custom discretization settings.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import SpatialDiscretizationHeatPreset
+    >>> SpatialDiscretizationHeatPreset.UNSET_SPATIAL_DISCRETIZATION_HEAT_PRESET
+    >>> SpatialDiscretizationHeatPreset.DEFAULT_SPATIAL_DISCRETIZATION_HEAT
+    >>> SpatialDiscretizationHeatPreset.CONSERVATIVE_SPATIAL_DISCRETIZATION_HEAT
+    >>> SpatialDiscretizationHeatPreset.HIGH_ACCURACY_SPATIAL_DISCRETIZATION_HEAT
+    >>> SpatialDiscretizationHeatPreset.CUSTOM_SPATIAL_DISCRETIZATION_HEAT
     """
 
     UNSET_SPATIAL_DISCRETIZATION_HEAT_PRESET = _clientpb.UNSET_SPATIAL_DISCRETIZATION_HEAT_PRESET
@@ -680,6 +1416,18 @@ class ProfileType(_IntEnum):
         1D radial profile normal to the Z direction.
     TIME
         Time varying profile.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import ProfileType
+    >>> ProfileType.CARTESIAN_X
+    >>> ProfileType.CARTESIAN_Y
+    >>> ProfileType.CARTESIAN_Z
+    >>> ProfileType.RADIAL_X
+    >>> ProfileType.RADIAL_Y
+    >>> ProfileType.RADIAL_Z
+    >>> ProfileType.TIME
     """
 
     CARTESIAN_X = _clientpb.CARTESIAN_X
@@ -707,6 +1455,16 @@ class HeatPhysicalBoundary(_IntEnum):
         Symmetry.
     HEAT_BC_CONVECTION
         Convective heat transfer.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import HeatPhysicalBoundary
+    >>> HeatPhysicalBoundary.HEAT_BC_ISOTHERMAL
+    >>> HeatPhysicalBoundary.HEAT_BC_HEAT_FLUX
+    >>> HeatPhysicalBoundary.HEAT_BC_INTEGRATED_HEAT_FLUX
+    >>> HeatPhysicalBoundary.HEAT_BC_SYMMETRY
+    >>> HeatPhysicalBoundary.HEAT_BC_CONVECTION
     """
 
     HEAT_BC_ISOTHERMAL = _clientpb.HEAT_BC_ISOTHERMAL
@@ -732,6 +1490,16 @@ class InitializationType(_IntEnum):
         Apply an initial condition corresponding to a predefined problem.
     EXISTING_SOLUTION
         Apply the starting values from an existing solution for the same mesh.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import InitializationType
+    >>> InitializationType.UNIFORM_VALUES
+    >>> InitializationType.FARFIELD_VALUES
+    >>> InitializationType.INITIALIZATION_POTENTIAL_FLOW
+    >>> InitializationType.VERIFICATION_SOLUTION
+    >>> InitializationType.EXISTING_SOLUTION
     """
 
     UNIFORM_VALUES = _clientpb.UNIFORM_VALUES
@@ -751,6 +1519,13 @@ class HeatSourceType(_IntEnum):
         Specify heat source power in Watts.
     HEAT_SOURCE_TYPE_POWER_PER_UNIT_OF_VOLUME
         Specify heat source power in Watts per unit volume.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import HeatSourceType
+    >>> HeatSourceType.HEAT_SOURCE_TYPE_POWER
+    >>> HeatSourceType.HEAT_SOURCE_TYPE_POWER_PER_UNIT_OF_VOLUME
     """
 
     HEAT_SOURCE_TYPE_POWER = _clientpb.HEAT_SOURCE_TYPE_POWER
@@ -768,6 +1543,13 @@ class InterfaceType(_IntEnum):
                         interface, or frozen rotor, or sliding interface).
     MIXING_PLANE_INTERFACE
         Imposes a pitchwise average of the variables on either side of the interface.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import InterfaceType
+    >>> InterfaceType.GENERAL_INTERFACE
+    >>> InterfaceType.MIXING_PLANE_INTERFACE
     """
 
     GENERAL_INTERFACE = _clientpb.GENERAL_INTERFACE
@@ -784,6 +1566,13 @@ class PeriodicBcType(_IntEnum):
 
     ROTATIONAL
 
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import PeriodicBcType
+    >>> PeriodicBcType.TRANSLATIONAL
+    >>> PeriodicBcType.ROTATIONAL
     """
 
     TRANSLATIONAL = _clientpb.TRANSLATIONAL
@@ -802,6 +1591,14 @@ class FluidType(_IntEnum):
         Single phase approximation for cavitation with a cavitation model
     VOF_FLUID
         VOF multiphase model for simulating flows with multiple fluids and immiscible interfaces.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import FluidType
+    >>> FluidType.SINGLE_PHASE
+    >>> FluidType.CAVITATING_FLUID
+    >>> FluidType.VOF_FLUID
     """
 
     SINGLE_PHASE = _clientpb.SINGLE_PHASE
@@ -825,6 +1622,16 @@ class ViscousModel(_IntEnum):
         Laminar flow governed by the Navier-Stokes equations.
     INVISCID
         Inviscid flow governed by the Euler equations.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import ViscousModel
+    >>> ViscousModel.RANS
+    >>> ViscousModel.DES
+    >>> ViscousModel.LES
+    >>> ViscousModel.LAMINAR
+    >>> ViscousModel.INVISCID
     """
 
     RANS = _clientpb.RANS
@@ -852,6 +1659,17 @@ class DesFormulation(_IntEnum):
         Use the original Detached Eddy Simulation (DES) formulation.
     ZDES
         Use the Zonal Detached Eddy Simulation (ZDES) formulation.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import DesFormulation
+    >>> DesFormulation.DDES_VTM
+    >>> DesFormulation.DDES_VTM_SIGMA
+    >>> DesFormulation.IDDES
+    >>> DesFormulation.DDES
+    >>> DesFormulation.DES97
+    >>> DesFormulation.ZDES
     """
 
     DDES_VTM = _clientpb.DDES_VTM
@@ -872,6 +1690,13 @@ class RansRegion(_IntEnum):
         Force RANS behavior inside a prescribed bounding box.
     OUTSIDE
         Force RANS behavior outside a prescribed bounding box.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import RansRegion
+    >>> RansRegion.INSIDE
+    >>> RansRegion.OUTSIDE
     """
 
     INSIDE = _clientpb.INSIDE
@@ -896,6 +1721,17 @@ class SubGridScaleModel(_IntEnum):
         Sigma eddy viscosity model.
     AMD
         AMD eddy viscosity model.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import SubGridScaleModel
+    >>> SubGridScaleModel.NONE
+    >>> SubGridScaleModel.SMAGORINSKY
+    >>> SubGridScaleModel.VREMAN
+    >>> SubGridScaleModel.WALE
+    >>> SubGridScaleModel.SIGMA
+    >>> SubGridScaleModel.AMD
     """
 
     NONE = _clientpb.NONE
@@ -923,6 +1759,15 @@ class TransitionModel(_IntEnum):
     AFT_2019
         Two-equation amplification factor transport, AFT-2019,
                         transition model.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import TransitionModel
+    >>> TransitionModel.NO_TRANSITION
+    >>> TransitionModel.GAMMA_2015
+    >>> TransitionModel.GAMMA_RE_THETA_2009
+    >>> TransitionModel.AFT_2019
     """
 
     NO_TRANSITION = _clientpb.NO_TRANSITION
@@ -941,6 +1786,13 @@ class TransitionModelCrossFlow(_IntEnum):
         Crossflow instability is not considered in transition modelling.
     TRANSITION_MODEL_CROSS_FLOW_ON
         Crossflow treatment is active in transition modelling.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import TransitionModelCrossFlow
+    >>> TransitionModelCrossFlow.TRANSITION_MODEL_CROSS_FLOW_OFF
+    >>> TransitionModelCrossFlow.TRANSITION_MODEL_CROSS_FLOW_ON
     """
 
     TRANSITION_MODEL_CROSS_FLOW_OFF = _clientpb.TRANSITION_MODEL_CROSS_FLOW_OFF
@@ -957,6 +1809,13 @@ class TurbulenceModel(_IntEnum):
         'Standard' Spalart-Allmaras one-equation turbulence model.
     KOMEGA_SST
         SST 2003m model.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import TurbulenceModel
+    >>> TurbulenceModel.SPALART_ALLMARAS
+    >>> TurbulenceModel.KOMEGA_SST
     """
 
     SPALART_ALLMARAS = _clientpb.SPALART_ALLMARAS
@@ -973,6 +1832,13 @@ class QcrSa(_IntEnum):
         A QCR modification is not applied.
     QCR2000
         The 2000 version of the QCR modification is applied (QCR2000).
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import QcrSa
+    >>> QcrSa.QCR_OFF
+    >>> QcrSa.QCR2000
     """
 
     QCR_OFF = _clientpb.QCR_OFF
@@ -989,6 +1855,13 @@ class RotationCorrectionSa(_IntEnum):
         A rotation correction is not applied to the Spalart-Allmaras turbulence model.
     ROTATION_CORRECTION_ON
         The SA-R form of the rotation correction is applied to the Spalart-Allmaras turbulence model.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import RotationCorrectionSa
+    >>> RotationCorrectionSa.ROTATION_CORRECTION_OFF
+    >>> RotationCorrectionSa.ROTATION_CORRECTION_ON
     """
 
     ROTATION_CORRECTION_OFF = _clientpb.ROTATION_CORRECTION_OFF
@@ -1005,6 +1878,13 @@ class TurbulenceModelConstants(_IntEnum):
         Use default turbulence model constants.
     CUSTOM_TURB_CONSTANTS
         Enter custom turbulence model constants.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import TurbulenceModelConstants
+    >>> TurbulenceModelConstants.DEFAULT_TURB_CONSTANTS
+    >>> TurbulenceModelConstants.CUSTOM_TURB_CONSTANTS
     """
 
     DEFAULT_TURB_CONSTANTS = _clientpb.DEFAULT_TURB_CONSTANTS
@@ -1021,6 +1901,13 @@ class QcrSst(_IntEnum):
         A QCR modification is not applied.
     SST_QCR2000
         The 2000 version of the QCR modification is applied (QCR2000).
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import QcrSst
+    >>> QcrSst.SST_QCR_OFF
+    >>> QcrSst.SST_QCR2000
     """
 
     SST_QCR_OFF = _clientpb.SST_QCR_OFF
@@ -1037,6 +1924,13 @@ class PseudoTimeStepMethod(_IntEnum):
         Compute a pseudo time step from a Courant-Friedrichs-Lewy (CFL) number.
     FIXED_PSEUDO_TIME_STEP
         Apply a fixed pseudo time step.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import PseudoTimeStepMethod
+    >>> PseudoTimeStepMethod.CFL_BASED
+    >>> PseudoTimeStepMethod.FIXED_PSEUDO_TIME_STEP
     """
 
     CFL_BASED = _clientpb.CFL_BASED
@@ -1055,6 +1949,13 @@ class LocalTimeStepping(_IntEnum):
         Enable local time stepping.
     LOCAL_TIME_STEPPING_OFF
         Disable local time stepping.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import LocalTimeStepping
+    >>> LocalTimeStepping.LOCAL_TIME_STEPPING_ON
+    >>> LocalTimeStepping.LOCAL_TIME_STEPPING_OFF
     """
 
     LOCAL_TIME_STEPPING_ON = _clientpb.LOCAL_TIME_STEPPING_ON
@@ -1069,6 +1970,12 @@ class JacobianUpdateMethod(_IntEnum):
     ----------
     EXPLICIT_INTERVAL_AND_WARMUP
         Compute the jacobian every iteration for 'Jacobian Warmup Threshold' iterations, then compute every 'Jacobian Update Interval' iterations
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import JacobianUpdateMethod
+    >>> JacobianUpdateMethod.EXPLICIT_INTERVAL_AND_WARMUP
     """
 
     EXPLICIT_INTERVAL_AND_WARMUP = _clientpb.EXPLICIT_INTERVAL_AND_WARMUP
@@ -1084,6 +1991,13 @@ class RobustStartup(_IntEnum):
         Enable robust startup mode.
     ROBUST_STARTUP_OFF
         Disable robust startup mode.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import RobustStartup
+    >>> RobustStartup.ROBUST_STARTUP_ON
+    >>> RobustStartup.ROBUST_STARTUP_OFF
     """
 
     ROBUST_STARTUP_ON = _clientpb.ROBUST_STARTUP_ON
@@ -1106,6 +2020,16 @@ class SolutionControlsFluidPreset(_IntEnum):
         Aggressive settings further biased towards speed, up to 3 times faster than the default settings (these may not be suitable for all problems).
     CUSTOM_SOLUTION_CONTROLS_FLUID
         Custom solution controls.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import SolutionControlsFluidPreset
+    >>> SolutionControlsFluidPreset.UNSET_SOLUTION_CONTROLS_FLUID_PRESET
+    >>> SolutionControlsFluidPreset.DEFAULT_SOLUTION_CONTROLS_FLUID
+    >>> SolutionControlsFluidPreset.INTERMEDIATE_SOLUTION_CONTROLS_FLUID
+    >>> SolutionControlsFluidPreset.AGGRESSIVE_SOLUTION_CONTROLS_FLUID
+    >>> SolutionControlsFluidPreset.CUSTOM_SOLUTION_CONTROLS_FLUID
     """
 
     UNSET_SOLUTION_CONTROLS_FLUID_PRESET = _clientpb.UNSET_SOLUTION_CONTROLS_FLUID_PRESET
@@ -1129,6 +2053,15 @@ class ConvectiveSchemesDensityBased(_IntEnum):
         Entropy-Stable discretization.
     RHIE_CHOW
         Rhie-Chow method.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import ConvectiveSchemesDensityBased
+    >>> ConvectiveSchemesDensityBased.ROE
+    >>> ConvectiveSchemesDensityBased.LD2
+    >>> ConvectiveSchemesDensityBased.EC2
+    >>> ConvectiveSchemesDensityBased.RHIE_CHOW
     """
 
     ROE = _clientpb.ROE
@@ -1147,6 +2080,13 @@ class Preconditioning(_IntEnum):
         Enable low-speed preconditioning.
     PRECONDITIONING_OFF
         Disable low-speed preconditioning.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import Preconditioning
+    >>> Preconditioning.PRECONDITIONING_ON
+    >>> Preconditioning.PRECONDITIONING_OFF
     """
 
     PRECONDITIONING_ON = _clientpb.PRECONDITIONING_ON
@@ -1163,6 +2103,13 @@ class ArtificialViscosityModel(_IntEnum):
         No artificial viscosity model.
     LAD
         Localized artificial diffusivity (LAD) model.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import ArtificialViscosityModel
+    >>> ArtificialViscosityModel.NO_MODEL
+    >>> ArtificialViscosityModel.LAD
     """
 
     NO_MODEL = _clientpb.NO_MODEL
@@ -1181,6 +2128,14 @@ class SkewSymmetricFormulation(_IntEnum):
         Praveen Chandrasekhar's EC1 formulation.
     KUYA
         Kuya et al's formulation.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import SkewSymmetricFormulation
+    >>> SkewSymmetricFormulation.CHANDRASEKHAR_EC2
+    >>> SkewSymmetricFormulation.CHANDRASEKHAR_EC1
+    >>> SkewSymmetricFormulation.KUYA
     """
 
     CHANDRASEKHAR_EC2 = _clientpb.CHANDRASEKHAR_EC2
@@ -1198,6 +2153,13 @@ class UpwindSchemeOrder(_IntEnum):
         Second-order accuracy.
     FIRST
         First-order accuracy.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import UpwindSchemeOrder
+    >>> UpwindSchemeOrder.SECOND
+    >>> UpwindSchemeOrder.FIRST
     """
 
     SECOND = _clientpb.SECOND
@@ -1214,6 +2176,13 @@ class RobustDissipation(_IntEnum):
         Disable robust dissipation.
     ROBUST_DISS_ON
         Enable robust dissipation.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import RobustDissipation
+    >>> RobustDissipation.ROBUST_DISS_OFF
+    >>> RobustDissipation.ROBUST_DISS_ON
     """
 
     ROBUST_DISS_OFF = _clientpb.ROBUST_DISS_OFF
@@ -1239,6 +2208,15 @@ class Limiter(_IntEnum):
     VENKATAKRISHNAN_CV
         This option was deprecated in favor of an implementation of the
                         same method that guarantees coordinate-system invariance.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import Limiter
+    >>> Limiter.NO_LIMITER
+    >>> Limiter.INVARIANT_VENKATAKRISHNAN_CV
+    >>> Limiter.VAN_ALBADA_FACE
+    >>> Limiter.VENKATAKRISHNAN_CV
     """
 
     NO_LIMITER = _clientpb.NO_LIMITER
@@ -1263,6 +2241,16 @@ class SpatialDiscretizationFluidPreset(_IntEnum):
         Settings that emphasize accuracy (relative to default).
     CUSTOM_SPATIAL_DISCRETIZATION_FLUID
         Custom discretization settings.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import SpatialDiscretizationFluidPreset
+    >>> SpatialDiscretizationFluidPreset.UNSET_SPATIAL_DISCRETIZATION_FLUID_PRESET
+    >>> SpatialDiscretizationFluidPreset.DEFAULT_SPATIAL_DISCRETIZATION_FLUID
+    >>> SpatialDiscretizationFluidPreset.CONSERVATIVE_SPATIAL_DISCRETIZATION_FLUID
+    >>> SpatialDiscretizationFluidPreset.HIGH_ACCURACY_SPATIAL_DISCRETIZATION_FLUID
+    >>> SpatialDiscretizationFluidPreset.CUSTOM_SPATIAL_DISCRETIZATION_FLUID
     """
 
     UNSET_SPATIAL_DISCRETIZATION_FLUID_PRESET = _clientpb.UNSET_SPATIAL_DISCRETIZATION_FLUID_PRESET
@@ -1292,6 +2280,17 @@ class PhysicalBoundary(_IntEnum):
         Far-field boundary condition.
     OVERSET
         Overset boundary condition.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import PhysicalBoundary
+    >>> PhysicalBoundary.WALL
+    >>> PhysicalBoundary.INLET
+    >>> PhysicalBoundary.OUTLET
+    >>> PhysicalBoundary.SYMMETRY
+    >>> PhysicalBoundary.FARFIELD
+    >>> PhysicalBoundary.OVERSET
     """
 
     WALL = _clientpb.WALL
@@ -1314,6 +2313,14 @@ class WallMomentum(_IntEnum):
         Apply a slip (flow tangency) condition at the wall surface.
     WALL_MODEL
         Apply a wall model at the wall surface.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import WallMomentum
+    >>> WallMomentum.NO_SLIP
+    >>> WallMomentum.SLIP
+    >>> WallMomentum.WALL_MODEL
     """
 
     NO_SLIP = _clientpb.NO_SLIP
@@ -1331,6 +2338,13 @@ class WallEnergy(_IntEnum):
         Apply a fixed heat flux at the wall surface.
     FIXED_TEMPERATURE
         Apply a fixed temperature at the wall surface.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import WallEnergy
+    >>> WallEnergy.FIXED_HEAT_FLUX
+    >>> WallEnergy.FIXED_TEMPERATURE
     """
 
     FIXED_HEAT_FLUX = _clientpb.FIXED_HEAT_FLUX
@@ -1345,6 +2359,12 @@ class InletEnergy(_IntEnum):
     ----------
     TOTAL_TEMPERATURE_INLET
         Specify total temperature.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import InletEnergy
+    >>> InletEnergy.TOTAL_TEMPERATURE_INLET
     """
 
     TOTAL_TEMPERATURE_INLET = _clientpb.TOTAL_TEMPERATURE_INLET
@@ -1362,6 +2382,14 @@ class TurbulenceSpecificationSpalartAllmaras(_IntEnum):
         Set the turbulent viscosity at the boundary.
     BC_SA_VARIABLE
         Set the Spalart-Allmaras variable value at the boundary condition.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import TurbulenceSpecificationSpalartAllmaras
+    >>> TurbulenceSpecificationSpalartAllmaras.TURBULENT_VISCOSITY_RATIO_SA
+    >>> TurbulenceSpecificationSpalartAllmaras.TURBULENT_VISCOSITY_SA
+    >>> TurbulenceSpecificationSpalartAllmaras.BC_SA_VARIABLE
     """
 
     TURBULENT_VISCOSITY_RATIO_SA = _clientpb.TURBULENT_VISCOSITY_RATIO_SA
@@ -1381,6 +2409,14 @@ class TurbulenceSpecificationKomega(_IntEnum):
         Set a uniform turbulent viscosity and turbulence intensity in the domain.
     BC_KOMEGA_VARIABLES
         Set the k-ω variables at the boundary condition.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import TurbulenceSpecificationKomega
+    >>> TurbulenceSpecificationKomega.BC_TURBULENT_VISCOSITY_RATIO_AND_INTENSITY_KOMEGA
+    >>> TurbulenceSpecificationKomega.BC_TURBULENT_VISCOSITY_AND_INTENSITY_KOMEGA
+    >>> TurbulenceSpecificationKomega.BC_KOMEGA_VARIABLES
     """
 
     BC_TURBULENT_VISCOSITY_RATIO_AND_INTENSITY_KOMEGA = (
@@ -1406,18 +2442,29 @@ class InletMomentum(_IntEnum):
         Specify the velocity magnitude.
     VELOCITY_COMPONENTS_INLET
         Specify the components of the velocity vector.
+    MACH_INLET
+        Specify the inlet Mach number and static conditions. Note that for subsonic flow the static pressure is not used.
     FAN_CURVE_INLET
         Specify the relation between the fan pressure rise and the volume flow rate.
-    MACH_INLET
-        Specify the mach number and state at inlet.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import InletMomentum
+    >>> InletMomentum.TOTAL_PRESSURE_INLET
+    >>> InletMomentum.MASS_FLOW_INLET
+    >>> InletMomentum.VELOCITY_INLET
+    >>> InletMomentum.VELOCITY_COMPONENTS_INLET
+    >>> InletMomentum.MACH_INLET
+    >>> InletMomentum.FAN_CURVE_INLET
     """
 
     TOTAL_PRESSURE_INLET = _clientpb.TOTAL_PRESSURE_INLET
     MASS_FLOW_INLET = _clientpb.MASS_FLOW_INLET
     VELOCITY_INLET = _clientpb.VELOCITY_INLET
     VELOCITY_COMPONENTS_INLET = _clientpb.VELOCITY_COMPONENTS_INLET
-    FAN_CURVE_INLET = _clientpb.FAN_CURVE_INLET
     MACH_INLET = _clientpb.MACH_INLET
+    FAN_CURVE_INLET = _clientpb.FAN_CURVE_INLET
 
 
 class DirectionSpecification(_IntEnum):
@@ -1430,6 +2477,13 @@ class DirectionSpecification(_IntEnum):
         Impose a flow direction normal to the inlet boundary toward the interior of the domain.
     DIRECTION_VECTOR
         Specify a vector for the inlet flow direction.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import DirectionSpecification
+    >>> DirectionSpecification.NORMAL_TO_BOUNDARY
+    >>> DirectionSpecification.DIRECTION_VECTOR
     """
 
     NORMAL_TO_BOUNDARY = _clientpb.NORMAL_TO_BOUNDARY
@@ -1453,6 +2507,15 @@ class OutletStrategy(_IntEnum):
                         <sup>P<sub>ref</sub></sup> &frasl; <sub>P<sub>0</sub></sub>).
     FAN_CURVE_OUTLET
         Specify the relation between the fan pressure rise and the volume flow rate.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import OutletStrategy
+    >>> OutletStrategy.OUTLET_PRESSURE
+    >>> OutletStrategy.OUTLET_TARGET_MASS_FLOW_RATE
+    >>> OutletStrategy.OUTLET_TARGET_CORRECTED_MASS_FLOW_RATE
+    >>> OutletStrategy.FAN_CURVE_OUTLET
     """
 
     OUTLET_PRESSURE = _clientpb.OUTLET_PRESSURE
@@ -1474,6 +2537,13 @@ class OutletPressureConstraint(_IntEnum):
         The area-averaged pressure is imposed while local values can deviate.
                         This allows a pressure profile to develop naturally, but can be less numerically
                         stable than the Local constraint mode.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import OutletPressureConstraint
+    >>> OutletPressureConstraint.OUTLET_LOCAL_CONSTRAINT
+    >>> OutletPressureConstraint.OUTLET_AVERAGE_CONSTRAINT
     """
 
     OUTLET_LOCAL_CONSTRAINT = _clientpb.OUTLET_LOCAL_CONSTRAINT
@@ -1490,6 +2560,13 @@ class FarfieldMomentum(_IntEnum):
         Specify the freestream Mach number.
     FARFIELD_VELOCITY_MAGNITUDE
         Specify the freestream velocity magnitude.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import FarfieldMomentum
+    >>> FarfieldMomentum.FARFIELD_MACH_NUMBER
+    >>> FarfieldMomentum.FARFIELD_VELOCITY_MAGNITUDE
     """
 
     FARFIELD_MACH_NUMBER = _clientpb.FARFIELD_MACH_NUMBER
@@ -1506,6 +2583,13 @@ class FarFieldFlowDirectionSpecification(_IntEnum):
         Specify a vector for the far-field flow direction.
     FARFIELD_ANGLES
         Specify body axes, angle of attack, and angle of sideslip to define the far-field flow direction.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import FarFieldFlowDirectionSpecification
+    >>> FarFieldFlowDirectionSpecification.FARFIELD_DIRECTION
+    >>> FarFieldFlowDirectionSpecification.FARFIELD_ANGLES
     """
 
     FARFIELD_DIRECTION = _clientpb.FARFIELD_DIRECTION
@@ -1526,6 +2610,15 @@ class TurbulentVariableInitializationTypeSa(_IntEnum):
         Uniform initial condition for the Spalart-Allmaras turbulence variable.
     INIT_FARFIELD_VALUES_SA
         Uniform initial condition for the Spalart-Allmaras turbulence variable from the far-field boundary.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import TurbulentVariableInitializationTypeSa
+    >>> TurbulentVariableInitializationTypeSa.INIT_TURBULENT_VISCOSITY_RATIO_SA
+    >>> TurbulentVariableInitializationTypeSa.INIT_TURBULENT_VISCOSITY_SA
+    >>> TurbulentVariableInitializationTypeSa.INIT_SA_VARIABLE
+    >>> TurbulentVariableInitializationTypeSa.INIT_FARFIELD_VALUES_SA
     """
 
     INIT_TURBULENT_VISCOSITY_RATIO_SA = _clientpb.INIT_TURBULENT_VISCOSITY_RATIO_SA
@@ -1548,6 +2641,15 @@ class TurbulentVariableInitializationTypeKomega(_IntEnum):
         Uniform initial conditions.
     INIT_FARFIELD_VALUES_KOMEGA
         Uniform initial condition from the far-field boundary.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import TurbulentVariableInitializationTypeKomega
+    >>> TurbulentVariableInitializationTypeKomega.INIT_TURBULENT_VISCOSITY_RATIO_AND_INTENSITY_KOMEGA
+    >>> TurbulentVariableInitializationTypeKomega.INIT_TURBULENT_VISCOSITY_AND_INTENSITY_KOMEGA
+    >>> TurbulentVariableInitializationTypeKomega.INIT_KOMEGA_VARIABLES
+    >>> TurbulentVariableInitializationTypeKomega.INIT_FARFIELD_VALUES_KOMEGA
     """
 
     INIT_TURBULENT_VISCOSITY_RATIO_AND_INTENSITY_KOMEGA = (
@@ -1570,6 +2672,13 @@ class PotentialFlowPressureInitialization(_IntEnum):
         Do not initialize the pressure using the potential flow method
     INITIALIZATION_POTENTIAL_FLOW_PRESSURE_ON
         Initialize the pressure using Bernouilli's equation.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import PotentialFlowPressureInitialization
+    >>> PotentialFlowPressureInitialization.INITIALIZATION_POTENTIAL_FLOW_PRESSURE_OFF
+    >>> PotentialFlowPressureInitialization.INITIALIZATION_POTENTIAL_FLOW_PRESSURE_ON
     """
 
     INITIALIZATION_POTENTIAL_FLOW_PRESSURE_OFF = (
@@ -1606,6 +2715,22 @@ class VerificationSolutions(_IntEnum):
         2D planar lattice flow for incompressible NS.
     CHECK_FLUX_SYMMETRY
         Run a debug check on the left/right symmetry of fluxes.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import VerificationSolutions
+    >>> VerificationSolutions.TAYLOR_GREEN_VORTEX
+    >>> VerificationSolutions.NS_MMS
+    >>> VerificationSolutions.EULER_MMS
+    >>> VerificationSolutions.SHOCK_TUBE
+    >>> VerificationSolutions.NORMAL_SHOCK
+    >>> VerificationSolutions.SHOCK_VORTEX
+    >>> VerificationSolutions.SHU_OSHER
+    >>> VerificationSolutions.DISTURBANCE_WAVE
+    >>> VerificationSolutions.INVISCID_VORTEX
+    >>> VerificationSolutions.INS_2D_LATTICE
+    >>> VerificationSolutions.CHECK_FLUX_SYMMETRY
     """
 
     TAYLOR_GREEN_VORTEX = _clientpb.TAYLOR_GREEN_VORTEX
@@ -1633,6 +2758,14 @@ class PhysicalBehaviorModel(_IntEnum):
         Behavior inputs associated with actuator lines
     SOURCE_POINTS_MODEL
         Behavior inputs associated with source points
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import PhysicalBehaviorModel
+    >>> PhysicalBehaviorModel.ACTUATOR_DISK_MODEL
+    >>> PhysicalBehaviorModel.ACTUATOR_LINE_MODEL
+    >>> PhysicalBehaviorModel.SOURCE_POINTS_MODEL
     """
 
     ACTUATOR_DISK_MODEL = _clientpb.ACTUATOR_DISK_MODEL
@@ -1654,6 +2787,15 @@ class ActuatorDiskModel(_IntEnum):
         Uses tables of airfoil aerodynamic data to model the effect of rotors and propellers
     FAN_CURVE_INTERNAL
         Specify the relation between the fan pressure rise and the volume flow rate.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import ActuatorDiskModel
+    >>> ActuatorDiskModel.ACTUATOR_DISK_UNIFORM_THRUST
+    >>> ActuatorDiskModel.ACTUATOR_DISK_RADIAL_DISTRIBUTION
+    >>> ActuatorDiskModel.ACTUATOR_DISK_BLADE_ELEMENT
+    >>> ActuatorDiskModel.FAN_CURVE_INTERNAL
     """
 
     ACTUATOR_DISK_UNIFORM_THRUST = _clientpb.ACTUATOR_DISK_UNIFORM_THRUST
@@ -1672,6 +2814,13 @@ class ActuatorDiskBemStrategy(_IntEnum):
         Prescribes a rotation rate for the fictitious blades.
     BEM_TARGET_THRUST
         The rotation rate specified initially is adjusted to achieve a prescribed target thrust. The final rotation rate is available as a surface output
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import ActuatorDiskBemStrategy
+    >>> ActuatorDiskBemStrategy.BEM_ROTATION_RATE
+    >>> ActuatorDiskBemStrategy.BEM_TARGET_THRUST
     """
 
     BEM_ROTATION_RATE = _clientpb.BEM_ROTATION_RATE
@@ -1686,6 +2835,12 @@ class ActuatorLineModel(_IntEnum):
     ----------
     ACTUATOR_LINE_BLADE_ELEMENT
         Uses tables of airfoil aerodynamic data to model the effect of rotors and propellers
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import ActuatorLineModel
+    >>> ActuatorLineModel.ACTUATOR_LINE_BLADE_ELEMENT
     """
 
     ACTUATOR_LINE_BLADE_ELEMENT = _clientpb.ACTUATOR_LINE_BLADE_ELEMENT
@@ -1701,6 +2856,13 @@ class ParticleSourceModel(_IntEnum):
         Injects material into the solver at particle locations
     GENERAL_ACCELERATION_SOURCE
         Applies an acceleration at particle locations
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import ParticleSourceModel
+    >>> ParticleSourceModel.GENERAL_MASS_SOURCE
+    >>> ParticleSourceModel.GENERAL_ACCELERATION_SOURCE
     """
 
     GENERAL_MASS_SOURCE = _clientpb.GENERAL_MASS_SOURCE
@@ -1715,6 +2877,12 @@ class CavitationModel(_IntEnum):
     ----------
     SAUER_SCHNERR
         Sauer-Schnerr one equation cavitation model.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import CavitationModel
+    >>> CavitationModel.SAUER_SCHNERR
     """
 
     SAUER_SCHNERR = _clientpb.SAUER_SCHNERR
@@ -1728,6 +2896,12 @@ class PorousModelType(_IntEnum):
     ----------
     DARCY_FORCHHEIMER
         Darcy Forchheimer model.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import PorousModelType
+    >>> PorousModelType.DARCY_FORCHHEIMER
     """
 
     DARCY_FORCHHEIMER = _clientpb.DARCY_FORCHHEIMER
@@ -1743,6 +2917,13 @@ class MpCouplingLinSolCoupling(_IntEnum):
         Enable enhanced coupling.
     MP_COUPLING_LIN_SOL_COUPLING_OFF
         Disable enhanced coupling.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import MpCouplingLinSolCoupling
+    >>> MpCouplingLinSolCoupling.MP_COUPLING_LIN_SOL_COUPLING_ON
+    >>> MpCouplingLinSolCoupling.MP_COUPLING_LIN_SOL_COUPLING_OFF
     """
 
     MP_COUPLING_LIN_SOL_COUPLING_ON = _clientpb.MP_COUPLING_LIN_SOL_COUPLING_ON