luminarycloud.params.enum¶

Classes¶

`ActuatorDiskModel`	Defines the physics behavior of the actuator disk.
`ActuatorDiskOrientationSelection`	Specify orientation via normal vector, or a series of x-, y-, z-rotational transformations
`ActuatorLineModel`	Defines the physics behavior of the actuator line.
`AdjointSolutionMethod`	The method used to solve the discrete adjoint equations.
`ArtificialViscosityModel`	Artificial viscosity for shock and interface capturing.
`BoussinesqApproximation`	Introduce a body force due to thermal expansion without modifying the material density.
`CavitationModel`	Cavitation models available for simulating flow with cavitation.
`ComputeStatistics`	Compute time-averaged values of flow variables (e.g. Velocity).
`ConvectiveSchemesDensityBased`	Type of scheme for discretizing the convective terms of the fluid equations.
`DebugOutput`	Output debug fields in solution files.
`DebugOutputInteriorSurfaceData`	Copy the interior volume data into the surface data.
`DensityRelationship`	Relationship for computing the density of the fluid.
`DesFormulation`	Select a Detached Eddy Simulation (DES) formulation.
`DirectionSpecification`	Method of defining the flow direction at the inlet.
`ExplicitMethod`	Scheme for explicit relaxation or explicit time-accurate integration of the governing equations.
`FarFieldFlowDirectionSpecification`	Method of defining the flow direction at the far-field.
`FloatType`	Type of equations solved for the physics.
`FlowBehavior`	Importance of physical time for the current simulation.
`FluidType`	Fluid types available for use with the solver.
`GeometryFixes`	Strategies to cope with problematic mesh regions (e.g. high skewness angles).
`GradientMethod`	Method for computing the spatial gradients of fluid variables.
`Gravity`	Apply an acceleration due to gravity or other body force.
`HeatPhysicalBoundary`
`HeatSourceType`	Heat source specification.
`ImplicitMethod`	Scheme for implicit relaxation of the governing equations.
`InitializationType`	Type of initial condition for the field variables.
`InletEnergy`	Method of defining the inlet energy conditions.
`InletMomentum`	Method of defining the inlet momentum conditions.
`InterfaceType`	Type of interface treatment
`JacobianUpdateMethod`	Method for determining how often to
`LaminarThermalConductivity`	Model for the laminar thermal conductivity of a fluid.
`LaminarViscosityModelNewtonian`	Models available for the dynamic viscosity of the fluid.
`Limiter`	Apply a slope limiter for second-order upwind schemes. This tends to increase
`LinearSolverType`	Type of linear solver used for implicit relaxation.
`LinsolAmgCycleType`	AMG cycle type
`LinsolAmgSmoother`	AMG cycle smoother
`LocalTimeStepping`	Compute local time steps in each control volume to accelerate convergence
`MaterialFluidPreset`	Select a predefined set of material properties or allow a custom set of properties.
`MaterialSolidPreset`	Select a predefined set of material properties or allow a custom set of properties.
`MeshingMethod`	The method to generate the computational mesh.
`MotionFormulation`	Formulation used to model motion of volumes in transient simulations.
`MotionSpecification`	Choice between repositioning volumes at simulation start, or specifying motion velocities
`MotionType`	Type of the Motion.
`MpCouplingLinSolCoupling`	Turns on the use of enhanced coupling between the physics, which provides greater robustness at the cost of simulation speed.
`OutletPressureConstraint`	Mode of imposing pressure at the outlet.
`OutletStrategy`	Outlet strategy.
`ParticleGroupType`	Defines the behavior of the particles.
`ParticleSourceModel`	Defines the behavior of the general source particles.
`PeriodicBcType`
`PhysicalBehaviorModel`	Defines the physical behavior type.
`PhysicalBoundary`
`PhysicalTimeStepMethod`	Method for obtaining the physical time step in a time-accurate simulation.
`PorousModelType`	Type of porous model.
`PotentialFlowPressureInitialization`	Pressure initialization options when using potential flow initialization.
`Preconditioning`	Apply low-speed preconditioning to obtain Mach number-independent solutions for ideal gases.
`ProfileType`	Types of boundary condition profile.
`PseudoTimeStepMethod`	Method for obtaining the pseudo time step in a steady-state simulation or for the inner iterations of the dual time stepping method.
`QcrSa`	Modification of the traditional linear Boussinesq relation for the Spalart-Allmaras turbulence model via the quadratic constitutive relation (QCR).
`QcrSst`	Modification of the traditional linear Boussinesq relation for the SST turbulence model via the quadratic constitutive relation (QCR).
`RansRegion`	Select a region where RANS behavior should be enforced.
`RelaxationMethod`	Relaxation scheme for steady-state simulations or time implicit transient simulations.
`ResidualNormalization`	Residual normalization type.
`ResidualQuantity`	Residual normalization type.
`RobustDissipation`	Use a form of dissipation that improves robustness but that may reduce accuracy.
`RobustStartup`	Applies a robust startup process during the initial transients of a simulation. Applicable to steady problems only.
`RotationCorrectionSa`	Apply a rotation correction to the Spalart-Allmaras turbulence model.
`SkewSymmetricFormulation`	Choice among skew-symmetric formulations.
`SolutionControlsFluidPreset`	Select suggested control settings or allow a custom choice. In general, assume a trade-off between speed and robustness (i.e. the ability to converge).
`SolutionControlsHeatPreset`	Select suggested control settings or allow a custom choice. In general, assume a trade-off between speed and robustness (i.e. the ability to converge).
`SpatialDiscretizationFluidPreset`	Select suggested control settings or allow a custom choice. In general, assume a trade-off between accuracy and robustness (i.e. the ability to converge).
`SpatialDiscretizationHeatPreset`	Select suggested control settings or allow a custom choice. In general, assume a trade-off between accuracy and robustness (i.e. the ability to converge).
`SubGridScaleModel`	Sub-grid scale models available for Large Eddy Simulation (LES).
`TimeImplicitOrder`	Temporal order of accuracy of the dual time stepping scheme for time-accurate integration.
`TimeMarching`	Scheme for time-accurate integration.
`TimeStepRamp`	Use a larger time step value during the initial transients of a simulation and then ramp
`TransformType`	Type of the Transformation.
`TransitionModel`	Laminar-turbulent transition models available for Reynolds-averaged Navier-Stokes (RANS).
`TransitionModelCrossFlow`	Crossflow instability treatment for transition model.
`TurbulenceModel`	Turbulence models available for Reynolds-averaged Navier-Stokes (RANS) or Detached Eddy Simulation (DES).
`TurbulenceModelConstants`	Apply default constants for the RANS turbulence model or choose to customize.
`TurbulenceSpecificationKomega`	Condition applied to the k-ω turbulence variables at the boundary.
`TurbulenceSpecificationSpalartAllmaras`	Condition applied to the Spalart-Allmaras turbulence equation at the boundary.
`TurbulentVariableInitializationTypeKomega`	Type of initial condition for the turbulent variables.
`TurbulentVariableInitializationTypeSa`	Type of initial condition for the turbulent variables.
`UpwindSchemeOrder`	Spatial order of accuracy of the convective scheme used for the fluid equations.
`VerificationSolutions`	Predefined verification problems built into the solver.
`ViscousModel`	Set the viscous model for the fluid solver.
`WallEnergy`	Condition applied to the energy equation at a solid wall boundary.
`WallMomentum`	Condition applied to the momentum equations at a solid wall boundary.

Package Contents¶

class luminarycloud.params.enum.ActuatorDiskModel¶

Bases: enum.IntEnum

Defines the physics behavior of the actuator disk.

Attributes:

ACTUATOR_DISK_UNIFORM_THRUST: Applies a uniform force at all locations on the disk
ACTUATOR_DISK_RADIAL_DISTRIBUTION: Thrust, torque, and radial force profiles
ACTUATOR_DISK_BLADE_ELEMENT: 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.

ACTUATOR_DISK_BLADE_ELEMENT¶

ACTUATOR_DISK_RADIAL_DISTRIBUTION¶

ACTUATOR_DISK_UNIFORM_THRUST¶

FAN_CURVE_INTERNAL¶

class luminarycloud.params.enum.ActuatorDiskOrientationSelection¶

Bases: enum.IntEnum

Specify orientation via normal vector, or a series of x-, y-, z-rotational transformations

Attributes:

ACTUATOR_DISK_SPECIFY_ROTATION_ANGLES: Specify rotation about x-, y-, and z- axes
ACTUATOR_DISK_SPECIFY_NORMAL_VECTOR: Specify the normal direction to the plane of the actuator disk.

ACTUATOR_DISK_SPECIFY_NORMAL_VECTOR¶

ACTUATOR_DISK_SPECIFY_ROTATION_ANGLES¶

class luminarycloud.params.enum.ActuatorLineModel¶

Bases: enum.IntEnum

Defines the physics behavior of the actuator line.

Attributes:

ACTUATOR_LINE_BLADE_ELEMENT: Uses tables of airfoil aerodynamic data to model the effect of rotors and propellers

ACTUATOR_LINE_BLADE_ELEMENT¶

class luminarycloud.params.enum.AdjointSolutionMethod¶

Bases: enum.IntEnum

The method used to solve the discrete adjoint equations.

Attributes:

ADJOINT_METHOD_GMRES: Use the GMRES linear solver to solve the equations.
ADJOINT_METHOD_RICHARDSON: Use a preconditioned Richardson iteration to solve the equations.
ADJOINT_METHOD_ALGORITHMIC: Use a fully consistent algorithmic differentiation approach.

ADJOINT_METHOD_ALGORITHMIC¶

ADJOINT_METHOD_GMRES¶

ADJOINT_METHOD_RICHARDSON¶

class luminarycloud.params.enum.ArtificialViscosityModel¶

Bases: enum.IntEnum

Artificial viscosity for shock and interface capturing.

Attributes:

NO_MODEL: No artificial viscosity model.
LAD: Localized artificial diffusivity (LAD) model.

LAD¶

NO_MODEL¶

class luminarycloud.params.enum.BoussinesqApproximation¶

Bases: enum.IntEnum

Introduce a body force due to thermal expansion without modifying the material density.

Attributes:

BOUSSINESQ_OFF: Disable Boussinesq approximation.
BOUSSINESQ_ON: Enable Boussinesq approximation.

BOUSSINESQ_OFF¶

BOUSSINESQ_ON¶

class luminarycloud.params.enum.CavitationModel¶

Bases: enum.IntEnum

Cavitation models available for simulating flow with cavitation.

Attributes:

SAUER_SCHNERR: Sauer-Schnerr one equation cavitation model.

SAUER_SCHNERR¶

class luminarycloud.params.enum.ComputeStatistics¶

Bases: enum.IntEnum

Compute time-averaged values of flow variables (e.g. Velocity).

Attributes:

COMPUTE_STATISTICS_OFF: Disable computation of transient statistics.
COMPUTE_STATISTICS_ON: Enable computation of transient statistics.

COMPUTE_STATISTICS_OFF¶

COMPUTE_STATISTICS_ON¶

class luminarycloud.params.enum.ConvectiveSchemesDensityBased¶

Bases: enum.IntEnum

Type of scheme for discretizing the convective terms of the fluid equations.

Attributes:

ROE: Flux Difference Splitting scheme.
LD2: Low-Dissipation Low-Dispersion (LD2) scheme.
EC2: Entropy-Stable discretization.
RHIE_CHOW: Rhie-Chow method.

EC2¶

LD2¶

RHIE_CHOW¶

ROE¶

class luminarycloud.params.enum.DebugOutput¶

Bases: enum.IntEnum

Output debug fields in solution files.

Attributes:

SOLN_DEBUG_OUTPUT_OFF: Disable debug output.
SOLN_DEBUG_OUTPUT_ON: Enable debug output.

SOLN_DEBUG_OUTPUT_OFF¶

SOLN_DEBUG_OUTPUT_ON¶

class luminarycloud.params.enum.DebugOutputInteriorSurfaceData¶

Bases: enum.IntEnum

Copy the interior volume data into the surface data.

Attributes:

SOLN_DEBUG_OUTPUT_INT_SURF_DATA_OFF: Disable debug output.
SOLN_DEBUG_OUTPUT_INT_SURF_DATA_ON: Enable debug output.

SOLN_DEBUG_OUTPUT_INT_SURF_DATA_OFF¶

SOLN_DEBUG_OUTPUT_INT_SURF_DATA_ON¶

class luminarycloud.params.enum.DensityRelationship¶

Bases: enum.IntEnum

Relationship for computing the density of the fluid.

Attributes:

IDEAL_GAS: Compute density using the ideal gas law.
CONSTANT_DENSITY: Constant density fluid (heat transfer is not simulated).
CONSTANT_DENSITY_ENERGY: Constant density fluid with energy equation.

CONSTANT_DENSITY¶

CONSTANT_DENSITY_ENERGY¶

IDEAL_GAS¶

class luminarycloud.params.enum.DesFormulation¶

Bases: enum.IntEnum

Select a Detached Eddy Simulation (DES) formulation.

Attributes:

DDES_VTM: Use the DDES formulation with the shear-layer-adapted LES length-scale.
DDES_VTM_SIGMA: DDES with shear-layer-adapted LES length-scale and Sigma LES model.
IDDES: Use the Improved Delayed Detached Eddy Simulation (DDES) formulation.
DDES: Use the delayed Detached Eddy Simulation (DDES) formulation.
DES97: Use the original Detached Eddy Simulation (DES) formulation.
ZDES: Use the Zonal Detached Eddy Simulation (ZDES) formulation.

DDES¶

DDES_VTM¶

DDES_VTM_SIGMA¶

DES97¶

IDDES¶

ZDES¶

class luminarycloud.params.enum.DirectionSpecification¶

Bases: enum.IntEnum

Method of defining the flow direction at the inlet.

Attributes:

NORMAL_TO_BOUNDARY: 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.

DIRECTION_VECTOR¶

NORMAL_TO_BOUNDARY¶

class luminarycloud.params.enum.ExplicitMethod¶

Bases: enum.IntEnum

Scheme for explicit relaxation or explicit time-accurate integration of the governing equations.

Attributes:

RK_4: Classical Runge-Kutta fourth-order scheme.
TVD_RK_3: Total Variation Diminishing Runge-Kutta third-order scheme.
FORWARD_EULER: First-order forward Euler scheme.

FORWARD_EULER¶

RK_4¶

TVD_RK_3¶

class luminarycloud.params.enum.FarFieldFlowDirectionSpecification¶

Bases: enum.IntEnum

Method of defining the flow direction at the far-field.

Attributes:

FARFIELD_DIRECTION: 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.

FARFIELD_ANGLES¶

FARFIELD_DIRECTION¶

class luminarycloud.params.enum.FloatType¶

Bases: enum.IntEnum

Type of equations solved for the physics.

Attributes:

DOUBLE

Solve the normal set of governing equations.

ADT1D

First order, scalar tangent.

ADA1D

Solve the discrete adjoint equations to obtain geometric: sensitivities with respect to an output of interest.

ADA1D¶

ADT1D¶

DOUBLE¶

class luminarycloud.params.enum.FlowBehavior¶

Bases: enum.IntEnum

Importance of physical time for the current simulation.

Attributes:

STEADY: Solve for a steady-state solution of the governing equations.
TRANSIENT: Solve for a time-accurate solution of the governing equations.

STEADY¶

TRANSIENT¶

class luminarycloud.params.enum.FluidType¶

Bases: enum.IntEnum

Fluid types available for use with the solver.

Attributes:

SINGLE_PHASE: Standard single phase fluid
CAVITATING_FLUID: Single phase approximation for cavitation with a cavitation model
VOF_FLUID: VOF multiphase model for simulating flows with multiple fluids and immiscible interfaces.

CAVITATING_FLUID¶

SINGLE_PHASE¶

VOF_FLUID¶

class luminarycloud.params.enum.GeometryFixes¶

Bases: enum.IntEnum

Strategies to cope with problematic mesh regions (e.g. high skewness angles).

Attributes:

GEOMETRY_FIXES_ON: Enable geometry fixes.
GEOMETRY_FIXES_OFF: Disable geometry fixes.

GEOMETRY_FIXES_OFF¶

GEOMETRY_FIXES_ON¶

class luminarycloud.params.enum.GradientMethod¶

Bases: enum.IntEnum

Method for computing the spatial gradients of fluid variables.

Attributes:

HLSQ

Standard hybrid least squares method with custom weighting.

WEIGHTED_LEAST_SQUARES

Least squares method with inverse distance weighting.

GREEN_GAUSS

Green-Gauss method.

LC_HLSQ

Luminary Cloud’s custom hybrid least squares method.

NODAL_GRADIENT

Gradients computed using nodal values interpolated from the: cell-centered solution.

GREEN_GAUSS¶

HLSQ¶

LC_HLSQ¶

NODAL_GRADIENT¶

WEIGHTED_LEAST_SQUARES¶

class luminarycloud.params.enum.Gravity¶

Bases: enum.IntEnum

Apply an acceleration due to gravity or other body force.

Attributes:

GRAVITY_OFF: Disable gravity or other body force.
GRAVITY_ON: Enable gravity or other body force.

GRAVITY_OFF¶

GRAVITY_ON¶

class luminarycloud.params.enum.HeatPhysicalBoundary¶

Bases: enum.IntEnum

Attributes:

HEAT_BC_ISOTHERMAL: Fixed temperature.
HEAT_BC_HEAT_FLUX: Heat flux.
HEAT_BC_INTEGRATED_HEAT_FLUX: Integrated heat flux.
HEAT_BC_SYMMETRY: Symmetry.
HEAT_BC_CONVECTION: Convective heat transfer.

HEAT_BC_CONVECTION¶

HEAT_BC_HEAT_FLUX¶

HEAT_BC_INTEGRATED_HEAT_FLUX¶

HEAT_BC_ISOTHERMAL¶

HEAT_BC_SYMMETRY¶

class luminarycloud.params.enum.HeatSourceType¶

Bases: enum.IntEnum

Heat source specification.

Attributes:

HEAT_SOURCE_TYPE_POWER: Specify heat source power in Watts.
HEAT_SOURCE_TYPE_POWER_PER_UNIT_OF_VOLUME: Specify heat source power in Watts per unit volume.

HEAT_SOURCE_TYPE_POWER¶

HEAT_SOURCE_TYPE_POWER_PER_UNIT_OF_VOLUME¶

class luminarycloud.params.enum.ImplicitMethod¶

Bases: enum.IntEnum

Scheme for implicit relaxation of the governing equations.

Attributes:

BACKWARD_EULER: First-order backward Euler scheme.

BACKWARD_EULER¶

class luminarycloud.params.enum.InitializationType¶

Bases: enum.IntEnum

Type of initial condition for the field variables.

Attributes:

UNIFORM_VALUES: Apply a uniform initial condition for all fields in space.
FARFIELD_VALUES: Initialize all fields uniformly in space using the values at the far-field boundary.
INITIALIZATION_POTENTIAL_FLOW: Initialize the velocity from an irrotational incompressible potential flow solution.
VERIFICATION_SOLUTION: Apply an initial condition corresponding to a predefined problem.
EXISTING_SOLUTION: Apply the starting values from an existing solution for the same mesh.

EXISTING_SOLUTION¶

FARFIELD_VALUES¶

INITIALIZATION_POTENTIAL_FLOW¶

UNIFORM_VALUES¶

VERIFICATION_SOLUTION¶

class luminarycloud.params.enum.InletEnergy¶

Bases: enum.IntEnum

Method of defining the inlet energy conditions.

Attributes:

TOTAL_TEMPERATURE_INLET: Specify total temperature.

TOTAL_TEMPERATURE_INLET¶

class luminarycloud.params.enum.InletMomentum¶

Bases: enum.IntEnum

Method of defining the inlet momentum conditions.

Attributes:

TOTAL_PRESSURE_INLET: Specify total pressure.
MASS_FLOW_INLET: Specify mass flow rate.
VELOCITY_INLET: Specify the velocity magnitude.
VELOCITY_COMPONENTS_INLET: Specify the components of the velocity vector.
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.

FAN_CURVE_INLET¶

MACH_INLET¶

MASS_FLOW_INLET¶

TOTAL_PRESSURE_INLET¶

VELOCITY_COMPONENTS_INLET¶

VELOCITY_INLET¶

class luminarycloud.params.enum.InterfaceType¶

Bases: enum.IntEnum

Type of interface treatment

Attributes:

GENERAL_INTERFACE

Automatic treatment based on geometry and settings (general: interface, or frozen rotor, or sliding interface).

MIXING_PLANE_INTERFACE

Imposes a pitchwise average of the variables on either side of the interface.

GENERAL_INTERFACE¶

MIXING_PLANE_INTERFACE¶

class luminarycloud.params.enum.JacobianUpdateMethod¶

Bases: enum.IntEnum

Method for determining how often to

Attributes:

EXPLICIT_INTERVAL_AND_WARMUP: Compute the jacobian every iteration for ‘Jacobian Warmup Threshold’ iterations, then compute every ‘Jacobian Update Interval’ iterations

EXPLICIT_INTERVAL_AND_WARMUP¶

class luminarycloud.params.enum.LaminarThermalConductivity¶

Bases: enum.IntEnum

Model for the laminar thermal conductivity of a fluid.

Attributes:

LAMINAR_CONSTANT_THERMAL_PRANDTL: Laminar thermal conductivity as function of local specific heat, laminar viscosity, and the specified laminar Prandtl number.
LAMINAR_CONSTANT_THERMAL_CONDUCTIVITY: Constant laminar thermal conductivity or tabulated values vs temperature.
TEMPERATURE_DEPENDENT_THERMAL_CONDUCTIVITY: Tabulated thermal conductivity values vs temperature.

LAMINAR_CONSTANT_THERMAL_CONDUCTIVITY¶

LAMINAR_CONSTANT_THERMAL_PRANDTL¶

TEMPERATURE_DEPENDENT_THERMAL_CONDUCTIVITY¶

class luminarycloud.params.enum.LaminarViscosityModelNewtonian¶

Bases: enum.IntEnum

Models available for the dynamic viscosity of the fluid.

Attributes:

SUTHERLAND: Dynamic viscosity as a function of local temperature using Sutherland’s Law.
LAMINAR_CONSTANT_VISCOSITY: Constant dynamic viscosity or tabulated values vs temperature.
TEMPERATURE_DEPENDENT_LAMINAR_VISCOSITY: Tabulated dynamic viscosity values vs temperature.

LAMINAR_CONSTANT_VISCOSITY¶

SUTHERLAND¶

TEMPERATURE_DEPENDENT_LAMINAR_VISCOSITY¶

class luminarycloud.params.enum.Limiter¶

Bases: enum.IntEnum

Apply a slope limiter for second-order upwind schemes. This tends to increase: robustness at the expense of solution time and higher dissipation in regions of the flow with sharp gradients. For this reason, it may be helpful to increase gradient blending parameters when using limiters.

Attributes:

NO_LIMITER

Do not apply a slope limiter.

INVARIANT_VENKATAKRISHNAN_CV

Apply cell-based limiting with the limiter function of Venkatakrishnan.

VAN_ALBADA_FACE

Apply face-based limiting with the limiter function of Van Albada.: This limiter is more conservative than Venkatakrishnan-Wang.

VENKATAKRISHNAN_CV

This option was deprecated in favor of an implementation of the: same method that guarantees coordinate-system invariance.

INVARIANT_VENKATAKRISHNAN_CV¶

NO_LIMITER¶

VAN_ALBADA_FACE¶

VENKATAKRISHNAN_CV¶

class luminarycloud.params.enum.LinearSolverType¶

Bases: enum.IntEnum

Type of linear solver used for implicit relaxation.

Attributes:

GS: Gauss-Seidel iterative method.
GS_AMGX: Gauss-Seidel iterative method.
AMG_KRYLOV_AMGX: AMG + Krylov iterative method.
AMG_AMGX: AMG iterative method.

AMG_AMGX¶

AMG_KRYLOV_AMGX¶

GS¶

GS_AMGX¶

class luminarycloud.params.enum.LinsolAmgCycleType¶

Bases: enum.IntEnum

AMG cycle type

Attributes:

LINSOL_AMG_CYCLE_TYPE_V: V cycle
LINSOL_AMG_CYCLE_TYPE_W: W cycle
LINSOL_AMG_CYCLE_TYPE_F: F cycle

LINSOL_AMG_CYCLE_TYPE_F¶

LINSOL_AMG_CYCLE_TYPE_V¶

LINSOL_AMG_CYCLE_TYPE_W¶

class luminarycloud.params.enum.LinsolAmgSmoother¶

Bases: enum.IntEnum

AMG cycle smoother

Attributes:

LINSOL_AMG_SMOOTHER_JACOBI: Jacobi
LINSOL_AMG_SMOOTHER_GS: Gauss-Seidel
LINSOL_AMG_SMOOTHER_SYM_GS: Symmetric Gauss-Seidel

LINSOL_AMG_SMOOTHER_GS¶

LINSOL_AMG_SMOOTHER_JACOBI¶

LINSOL_AMG_SMOOTHER_SYM_GS¶

class luminarycloud.params.enum.LocalTimeStepping¶

Bases: enum.IntEnum

Compute local time steps in each control volume to accelerate convergence: of steady-state simulations or the inner iterations of time-accurate simulations with dual time stepping.

Attributes:

LOCAL_TIME_STEPPING_ON: Enable local time stepping.
LOCAL_TIME_STEPPING_OFF: Disable local time stepping.

LOCAL_TIME_STEPPING_OFF¶

LOCAL_TIME_STEPPING_ON¶

class luminarycloud.params.enum.MaterialFluidPreset¶

Bases: enum.IntEnum

Select a predefined set of material properties or allow a custom set of properties.

Attributes:

UNSET_MATERIAL_FLUID_PRESET: Fluid material preset is not set.
STANDARD_AIR: Standard air material properties
WATER_NTP: Properties of water at 1 atmosphere and 20° Celsius
CUSTOM_MATERIAL_FLUID: A custom set of material properties.

CUSTOM_MATERIAL_FLUID¶

STANDARD_AIR¶

UNSET_MATERIAL_FLUID_PRESET¶

WATER_NTP¶

class luminarycloud.params.enum.MaterialSolidPreset¶

Bases: enum.IntEnum

Select a predefined set of material properties or allow a custom set of properties.

Attributes:

ALUMINUM: Properties of pure aluminum.
COPPER: Properties of pure copper.
IRON: Properties of pure iron.
NICKEL: Properties of pure nickel.
TITANIUM: Properties of pure titanium.
CUSTOM_MATERIAL_SOLID: A custom set of material properties.

ALUMINUM¶

COPPER¶

CUSTOM_MATERIAL_SOLID¶

IRON¶

NICKEL¶

TITANIUM¶

class luminarycloud.params.enum.MeshingMethod¶

Bases: enum.IntEnum

The method to generate the computational mesh.

Attributes:

MESH_METHOD_MANUAL: Using user inputs to guide single, manual mesh generation.
MESH_METHOD_AUTO: Using solution-based adaptive mesh refinement.

MESH_METHOD_AUTO¶

MESH_METHOD_MANUAL¶

class luminarycloud.params.enum.MotionFormulation¶

Bases: enum.IntEnum

Formulation used to model motion of volumes in transient simulations.

Attributes:

AUTOMATIC_MOTION_FORMULATION

The mesh position is updated each time step.

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.

AUTOMATIC_MOTION_FORMULATION¶

MRF_MOTION_FORMULATION¶

class luminarycloud.params.enum.MotionSpecification¶

Bases: enum.IntEnum

Choice between repositioning volumes at simulation start, or specifying motion velocities

Attributes:

MOTION_SPECIFICATION_REPOSITION: 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

MOTION_SPECIFICATION_NORMAL¶

MOTION_SPECIFICATION_REPOSITION¶

class luminarycloud.params.enum.MotionType¶

Bases: enum.IntEnum

Type of the Motion.

Attributes:

NO_MOTION: No relative motion.
CONSTANT_TRANSLATION_MOTION: Motion is defined by specifying an initial translation and constant translational velocity.
CONSTANT_ANGULAR_MOTION: 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.

CONSTANT_ANGULAR_MOTION¶

CONSTANT_TRANSLATION_MOTION¶

CONSTANT_VELOCITY_MOTION¶

NO_MOTION¶

class luminarycloud.params.enum.MpCouplingLinSolCoupling¶

Bases: enum.IntEnum

Turns on the use of enhanced coupling between the physics, which provides greater robustness at the cost of simulation speed.

Attributes:

MP_COUPLING_LIN_SOL_COUPLING_ON: Enable enhanced coupling.
MP_COUPLING_LIN_SOL_COUPLING_OFF: Disable enhanced coupling.

MP_COUPLING_LIN_SOL_COUPLING_OFF¶

MP_COUPLING_LIN_SOL_COUPLING_ON¶

class luminarycloud.params.enum.OutletPressureConstraint¶

Bases: enum.IntEnum

Mode of imposing pressure at the outlet.

Attributes:

OUTLET_LOCAL_CONSTRAINT

Pressure values are imposed locally at each mesh face,: thereby imposing a fixed pressure profile (e.g. uniform).

OUTLET_AVERAGE_CONSTRAINT

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.

OUTLET_AVERAGE_CONSTRAINT¶

OUTLET_LOCAL_CONSTRAINT¶

class luminarycloud.params.enum.OutletStrategy¶

Bases: enum.IntEnum

Outlet strategy.

Attributes:

OUTLET_PRESSURE

Specify an outlet static pressure.

OUTLET_TARGET_MASS_FLOW_RATE

Specify a target mass flow rate. Warning: this strategy will not work if: the flow becomes choked or if it is fixed by any other flow constraint (e.g. a velocity inlet).

OUTLET_TARGET_CORRECTED_MASS_FLOW_RATE

Specify a target mass flow rate corrected for given reference temperature and pressure: (͘mcorr = ͘m √ T0 &frasl; √Tref Pref &frasl; P0).

FAN_CURVE_OUTLET

Specify the relation between the fan pressure rise and the volume flow rate.

FAN_CURVE_OUTLET¶

OUTLET_PRESSURE¶

OUTLET_TARGET_CORRECTED_MASS_FLOW_RATE¶

OUTLET_TARGET_MASS_FLOW_RATE¶

class luminarycloud.params.enum.ParticleGroupType¶

Bases: enum.IntEnum

Defines the behavior of the particles.

Attributes:

ACTUATOR_DISK: Applies a uniform force at all locations on the disk
ACTUATOR_LINE: Applies thrust, azimuthal, and radial forces via a table of user-specified coefficients
SOURCE_POINTS: Injects material into the solver at particle locations
PROBE_POINTS: Reports solver variables at probe locations.

ACTUATOR_DISK¶

ACTUATOR_LINE¶

PROBE_POINTS¶

SOURCE_POINTS¶

class luminarycloud.params.enum.ParticleSourceModel¶

Bases: enum.IntEnum

Defines the behavior of the general source particles.

Attributes:

GENERAL_MASS_SOURCE: Injects material into the solver at particle locations
GENERAL_ACCELERATION_SOURCE: Applies an acceleration at particle locations

GENERAL_ACCELERATION_SOURCE¶

GENERAL_MASS_SOURCE¶

class luminarycloud.params.enum.PeriodicBcType¶

Bases: enum.IntEnum

Attributes:

TRANSLATIONAL
ROTATIONAL

ROTATIONAL¶

TRANSLATIONAL¶

class luminarycloud.params.enum.PhysicalBehaviorModel¶

Bases: enum.IntEnum

Defines the physical behavior type.

Attributes:

ACTUATOR_DISK_MODEL: Behavior inputs associated with actuator disks
ACTUATOR_LINE_MODEL: Behavior inputs associated with actuator lines
SOURCE_POINTS_MODEL: Behavior inputs associated with source points

ACTUATOR_DISK_MODEL¶

ACTUATOR_LINE_MODEL¶

SOURCE_POINTS_MODEL¶

class luminarycloud.params.enum.PhysicalBoundary¶

Bases: enum.IntEnum

Attributes:

WALL: Solid wall boundary condition.
INLET: Inlet boundary condition.
OUTLET: Outlet boundary condition.
SYMMETRY: Symmetry boundary condition.
FARFIELD: Far-field boundary condition.
OVERSET: Overset boundary condition.

FARFIELD¶

INLET¶

OUTLET¶

OVERSET¶

SYMMETRY¶

WALL¶

class luminarycloud.params.enum.PhysicalTimeStepMethod¶

Bases: enum.IntEnum

Method for obtaining the physical time step in a time-accurate simulation.

Attributes:

FIXED_TIME_STEP: Apply a fixed physical time step.

FIXED_TIME_STEP¶

class luminarycloud.params.enum.PorousModelType¶

Bases: enum.IntEnum

Type of porous model.

Attributes:

DARCY_FORCHHEIMER: Darcy Forchheimer model.

DARCY_FORCHHEIMER¶

class luminarycloud.params.enum.PotentialFlowPressureInitialization¶

Bases: enum.IntEnum

Pressure initialization options when using potential flow initialization.

Attributes:

INITIALIZATION_POTENTIAL_FLOW_PRESSURE_OFF: Do not initialize the pressure using the potential flow method
INITIALIZATION_POTENTIAL_FLOW_PRESSURE_ON: Initialize the pressure using Bernouilli’s equation.

INITIALIZATION_POTENTIAL_FLOW_PRESSURE_OFF¶

INITIALIZATION_POTENTIAL_FLOW_PRESSURE_ON¶

class luminarycloud.params.enum.Preconditioning¶

Bases: enum.IntEnum

Apply low-speed preconditioning to obtain Mach number-independent solutions for ideal gases.

Attributes:

PRECONDITIONING_ON: Enable low-speed preconditioning.
PRECONDITIONING_OFF: Disable low-speed preconditioning.

PRECONDITIONING_OFF¶

PRECONDITIONING_ON¶

class luminarycloud.params.enum.ProfileType¶

Bases: enum.IntEnum

Types of boundary condition profile.

Attributes:

CARTESIAN_X: 1D profile in X direction.
CARTESIAN_Y: 1D profile in Y direction.
CARTESIAN_Z: 1D profile in Z direction.
RADIAL_X: 1D radial profile normal to the X direction.
RADIAL_Y: 1D radial profile normal to the Y direction.
RADIAL_Z: 1D radial profile normal to the Z direction.
TIME: Time varying profile.

CARTESIAN_X¶

CARTESIAN_Y¶

CARTESIAN_Z¶

RADIAL_X¶

RADIAL_Y¶

RADIAL_Z¶

TIME¶

class luminarycloud.params.enum.PseudoTimeStepMethod¶

Bases: enum.IntEnum

Method for obtaining the pseudo time step in a steady-state simulation or for the inner iterations of the dual time stepping method.

Attributes:

CFL_BASED: Compute a pseudo time step from a Courant-Friedrichs-Lewy (CFL) number.
FIXED_PSEUDO_TIME_STEP: Apply a fixed pseudo time step.

CFL_BASED¶

FIXED_PSEUDO_TIME_STEP¶

class luminarycloud.params.enum.QcrSa¶

Bases: enum.IntEnum

Modification of the traditional linear Boussinesq relation for the Spalart-Allmaras turbulence model via the quadratic constitutive relation (QCR).

Attributes:

QCR_OFF: A QCR modification is not applied.
QCR2000: The 2000 version of the QCR modification is applied (QCR2000).

QCR2000¶

QCR_OFF¶

class luminarycloud.params.enum.QcrSst¶

Bases: enum.IntEnum

Modification of the traditional linear Boussinesq relation for the SST turbulence model via the quadratic constitutive relation (QCR).

Attributes:

SST_QCR_OFF: A QCR modification is not applied.
SST_QCR2000: The 2000 version of the QCR modification is applied (QCR2000).

SST_QCR2000¶

SST_QCR_OFF¶

class luminarycloud.params.enum.RansRegion¶

Bases: enum.IntEnum

Select a region where RANS behavior should be enforced.

Attributes:

INSIDE: Force RANS behavior inside a prescribed bounding box.
OUTSIDE: Force RANS behavior outside a prescribed bounding box.

INSIDE¶

OUTSIDE¶

class luminarycloud.params.enum.RelaxationMethod¶

Bases: enum.IntEnum

Relaxation scheme for steady-state simulations or time implicit transient simulations.

Attributes:

IMPLICIT: Apply an implicit relaxation scheme.
EXPLICIT: Apply an explicit relaxation scheme.

EXPLICIT¶

IMPLICIT¶

class luminarycloud.params.enum.ResidualNormalization¶

Bases: enum.IntEnum

Residual normalization type.

Attributes:

ABSOLUTE
RELATIVE
MAX
MIN

ABSOLUTE¶

MAX¶

MIN¶

RELATIVE¶

class luminarycloud.params.enum.ResidualQuantity¶

Bases: enum.IntEnum

Residual normalization type.

Attributes:

DENSITY: Mass
X_MOMENTUM: X-Momentum
Y_MOMENTUM: Y-Momentum
Z_MOMENTUM: Z-Momentum
ENERGY: Energy
SA_VARIABLE: Spalart-Allmaras Variable
TKE: Turbulent Kinetic Energy
OMEGA: Specific Dissipation Rate
GAMMA: Turbulence Intermittency
RE_THETA: Momentum-Thickness Reynolds Number
N_TILDE: Amplification Factor

DENSITY¶

ENERGY¶

GAMMA¶

N_TILDE¶

OMEGA¶

RE_THETA¶

SA_VARIABLE¶

TKE¶

X_MOMENTUM¶

Y_MOMENTUM¶

Z_MOMENTUM¶

class luminarycloud.params.enum.RobustDissipation¶

Bases: enum.IntEnum

Use a form of dissipation that improves robustness but that may reduce accuracy.

Attributes:

ROBUST_DISS_OFF: Disable robust dissipation.
ROBUST_DISS_ON: Enable robust dissipation.

ROBUST_DISS_OFF¶

ROBUST_DISS_ON¶

class luminarycloud.params.enum.RobustStartup¶

Bases: enum.IntEnum

Applies a robust startup process during the initial transients of a simulation. Applicable to steady problems only.

Attributes:

ROBUST_STARTUP_ON: Enable robust startup mode.
ROBUST_STARTUP_OFF: Disable robust startup mode.

ROBUST_STARTUP_OFF¶

ROBUST_STARTUP_ON¶

class luminarycloud.params.enum.RotationCorrectionSa¶

Bases: enum.IntEnum

Apply a rotation correction to the Spalart-Allmaras turbulence model.

Attributes:

ROTATION_CORRECTION_OFF: 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.

ROTATION_CORRECTION_OFF¶

ROTATION_CORRECTION_ON¶

class luminarycloud.params.enum.SkewSymmetricFormulation¶

Bases: enum.IntEnum

Choice among skew-symmetric formulations.

Attributes:

CHANDRASEKHAR_EC2: Praveen Chandrasekhar’s EC2 formulation.
CHANDRASEKHAR_EC1: Praveen Chandrasekhar’s EC1 formulation.
KUYA: Kuya et al’s formulation.

CHANDRASEKHAR_EC1¶

CHANDRASEKHAR_EC2¶

KUYA¶

class luminarycloud.params.enum.SolutionControlsFluidPreset¶

Bases: enum.IntEnum

Select suggested control settings or allow a custom choice. In general, assume a trade-off between speed and robustness (i.e. the ability to converge).

Attributes:

UNSET_SOLUTION_CONTROLS_FLUID_PRESET: Solution controls preset is not set.
DEFAULT_SOLUTION_CONTROLS_FLUID: Conservative performance settings that emphasize robustness (ability to converge).
INTERMEDIATE_SOLUTION_CONTROLS_FLUID: Reasonable compromise between speed and robustness, up to 2 times faster than the default settings.
AGGRESSIVE_SOLUTION_CONTROLS_FLUID: 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.

AGGRESSIVE_SOLUTION_CONTROLS_FLUID¶

CUSTOM_SOLUTION_CONTROLS_FLUID¶

DEFAULT_SOLUTION_CONTROLS_FLUID¶

INTERMEDIATE_SOLUTION_CONTROLS_FLUID¶

UNSET_SOLUTION_CONTROLS_FLUID_PRESET¶

class luminarycloud.params.enum.SolutionControlsHeatPreset¶

Bases: enum.IntEnum

Select suggested control settings or allow a custom choice. In general, assume a trade-off between speed and robustness (i.e. the ability to converge).

Attributes:

UNSET_SOLUTION_CONTROLS_HEAT_PRESET: Solution controls preset is not set.
DEFAULT_SOLUTION_CONTROLS_HEAT: Conservative performance settings that emphasize robustness (ability to converge).
INTERMEDIATE_SOLUTION_CONTROLS_HEAT: Reasonable compromise between speed and robustness.
AGGRESSIVE_SOLUTION_CONTROLS_HEAT: Aggressive settings further biased towards speed.
CUSTOM_SOLUTION_CONTROLS_HEAT: Custom solution controls.

AGGRESSIVE_SOLUTION_CONTROLS_HEAT¶

CUSTOM_SOLUTION_CONTROLS_HEAT¶

DEFAULT_SOLUTION_CONTROLS_HEAT¶

INTERMEDIATE_SOLUTION_CONTROLS_HEAT¶

UNSET_SOLUTION_CONTROLS_HEAT_PRESET¶

class luminarycloud.params.enum.SpatialDiscretizationFluidPreset¶

Bases: enum.IntEnum

Select suggested control settings or allow a custom choice. In general, assume a trade-off between accuracy and robustness (i.e. the ability to converge).

Attributes:

UNSET_SPATIAL_DISCRETIZATION_FLUID_PRESET: Spatial discretization preset is not set.
DEFAULT_SPATIAL_DISCRETIZATION_FLUID: Default settings, good compromise between accuracy and robustness (ability to converge).
CONSERVATIVE_SPATIAL_DISCRETIZATION_FLUID: Settings biased towards robustness over maximum accuracy (relative to default).
HIGH_ACCURACY_SPATIAL_DISCRETIZATION_FLUID: Settings that emphasize accuracy (relative to default).
CUSTOM_SPATIAL_DISCRETIZATION_FLUID: Custom discretization settings.

CONSERVATIVE_SPATIAL_DISCRETIZATION_FLUID¶

CUSTOM_SPATIAL_DISCRETIZATION_FLUID¶

DEFAULT_SPATIAL_DISCRETIZATION_FLUID¶

HIGH_ACCURACY_SPATIAL_DISCRETIZATION_FLUID¶

UNSET_SPATIAL_DISCRETIZATION_FLUID_PRESET¶

class luminarycloud.params.enum.SpatialDiscretizationHeatPreset¶

Bases: enum.IntEnum

Select suggested control settings or allow a custom choice. In general, assume a trade-off between accuracy and robustness (i.e. the ability to converge).

Attributes:

UNSET_SPATIAL_DISCRETIZATION_HEAT_PRESET: Spatial discretization preset is not set.
DEFAULT_SPATIAL_DISCRETIZATION_HEAT: Default settings, good compromise between accuracy and robustness (ability to converge).
CONSERVATIVE_SPATIAL_DISCRETIZATION_HEAT: Settings biased towards robustness over maximum accuracy (relative to default).
HIGH_ACCURACY_SPATIAL_DISCRETIZATION_HEAT: Settings that emphasize accuracy (relative to default).
CUSTOM_SPATIAL_DISCRETIZATION_HEAT: Custom discretization settings.

CONSERVATIVE_SPATIAL_DISCRETIZATION_HEAT¶

CUSTOM_SPATIAL_DISCRETIZATION_HEAT¶

DEFAULT_SPATIAL_DISCRETIZATION_HEAT¶

HIGH_ACCURACY_SPATIAL_DISCRETIZATION_HEAT¶

UNSET_SPATIAL_DISCRETIZATION_HEAT_PRESET¶

class luminarycloud.params.enum.SubGridScaleModel¶

Bases: enum.IntEnum

Sub-grid scale models available for Large Eddy Simulation (LES).

Attributes:

NONE: No sub-grid scale model.
SMAGORINSKY: Smagorinsky eddy viscosity model.
VREMAN: Vreman eddy viscosity model.
WALE: Wall adapting local eddy (WALE) viscosity model.
SIGMA: Sigma eddy viscosity model.
AMD: AMD eddy viscosity model.

AMD¶

NONE¶

SIGMA¶

SMAGORINSKY¶

VREMAN¶

WALE¶

class luminarycloud.params.enum.TimeImplicitOrder¶

Bases: enum.IntEnum

Temporal order of accuracy of the dual time stepping scheme for time-accurate integration.

Attributes:

TIME_SECOND: Second-order backward Euler integration.
TIME_FIRST: First-order backward Euler integration.

TIME_FIRST¶

TIME_SECOND¶

class luminarycloud.params.enum.TimeMarching¶

Bases: enum.IntEnum

Scheme for time-accurate integration.

Attributes:

TIME_IMPLICIT: Implicit scheme (dual time stepping) for time-accurate integration.
TIME_EXPLICIT: Explicit scheme for time-accurate integration.

TIME_EXPLICIT¶

TIME_IMPLICIT¶

class luminarycloud.params.enum.TimeStepRamp¶

Bases: enum.IntEnum

Use a larger time step value during the initial transients of a simulation and then ramp: linearly towards the target value, to accelerate statistical convergence. Only applicable to transient problems with time implicit integration (dual time stepping).

Attributes:

TIME_STEP_RAMP_OFF: Disable physical time step ramping.
TIME_STEP_RAMP_ON: Enable physical time step ramping.

TIME_STEP_RAMP_OFF¶

TIME_STEP_RAMP_ON¶

class luminarycloud.params.enum.TransformType¶

Bases: enum.IntEnum

Type of the Transformation.

Attributes:

NO_TRANSFORM: No Transform
ROTATIONAL_TRANSFORM: Rotational Transformation
TRANSLATIONAL_TRANSFORM: Translational Transformation

NO_TRANSFORM¶

ROTATIONAL_TRANSFORM¶

TRANSLATIONAL_TRANSFORM¶

class luminarycloud.params.enum.TransitionModel¶

Bases: enum.IntEnum

Laminar-turbulent transition models available for Reynolds-averaged Navier-Stokes (RANS).

Attributes:

NO_TRANSITION

No transition modelling, the flow is fully turbulent.

GAMMA_2015

One-equation local correlation-based, γ-2015,: transition model (simplified γ-Reθt).

GAMMA_RE_THETA_2009

Two-equation local correlation-based, γ-Reθt-2009,: transition model.

AFT_2019

Two-equation amplification factor transport, AFT-2019,: transition model.

AFT_2019¶

GAMMA_2015¶

GAMMA_RE_THETA_2009¶

NO_TRANSITION¶

class luminarycloud.params.enum.TransitionModelCrossFlow¶

Bases: enum.IntEnum

Crossflow instability treatment for transition model.

Attributes:

TRANSITION_MODEL_CROSS_FLOW_OFF: Crossflow instability is not considered in transition modelling.
TRANSITION_MODEL_CROSS_FLOW_ON: Crossflow treatment is active in transition modelling.

TRANSITION_MODEL_CROSS_FLOW_OFF¶

TRANSITION_MODEL_CROSS_FLOW_ON¶

class luminarycloud.params.enum.TurbulenceModel¶

Bases: enum.IntEnum

Turbulence models available for Reynolds-averaged Navier-Stokes (RANS) or Detached Eddy Simulation (DES).

Attributes:

SPALART_ALLMARAS: ‘Standard’ Spalart-Allmaras one-equation turbulence model.
KOMEGA_SST: SST 2003m model.

KOMEGA_SST¶

SPALART_ALLMARAS¶

class luminarycloud.params.enum.TurbulenceModelConstants¶

Bases: enum.IntEnum

Apply default constants for the RANS turbulence model or choose to customize.

Attributes:

DEFAULT_TURB_CONSTANTS: Use default turbulence model constants.
CUSTOM_TURB_CONSTANTS: Enter custom turbulence model constants.

CUSTOM_TURB_CONSTANTS¶

DEFAULT_TURB_CONSTANTS¶

class luminarycloud.params.enum.TurbulenceSpecificationKomega¶

Bases: enum.IntEnum

Condition applied to the k-ω turbulence variables at the boundary.

Attributes:

BC_TURBULENT_VISCOSITY_RATIO_AND_INTENSITY_KOMEGA: Apply a uniform ratio of turbulent viscosity to laminar viscosity and turbulence intensity at the boundary.
BC_TURBULENT_VISCOSITY_AND_INTENSITY_KOMEGA: Set a uniform turbulent viscosity and turbulence intensity in the domain.
BC_KOMEGA_VARIABLES: Set the k-ω variables at the boundary condition.

BC_KOMEGA_VARIABLES¶

BC_TURBULENT_VISCOSITY_AND_INTENSITY_KOMEGA¶

BC_TURBULENT_VISCOSITY_RATIO_AND_INTENSITY_KOMEGA¶

class luminarycloud.params.enum.TurbulenceSpecificationSpalartAllmaras¶

Bases: enum.IntEnum

Condition applied to the Spalart-Allmaras turbulence equation at the boundary.

Attributes:

TURBULENT_VISCOSITY_RATIO_SA: Apply a ratio of turbulent viscosity to laminar viscosity at the boundary.
TURBULENT_VISCOSITY_SA: Set the turbulent viscosity at the boundary.
BC_SA_VARIABLE: Set the Spalart-Allmaras variable value at the boundary condition.

BC_SA_VARIABLE¶

TURBULENT_VISCOSITY_RATIO_SA¶

TURBULENT_VISCOSITY_SA¶

class luminarycloud.params.enum.TurbulentVariableInitializationTypeKomega¶

Bases: enum.IntEnum

Type of initial condition for the turbulent variables.

Attributes:

INIT_TURBULENT_VISCOSITY_RATIO_AND_INTENSITY_KOMEGA: Apply a uniform ratio of turbulent viscosity to laminar viscosity and turbulence intensity in the domain.
INIT_TURBULENT_VISCOSITY_AND_INTENSITY_KOMEGA: Set a uniform turbulent viscosity and turbulence intensity in the domain.
INIT_KOMEGA_VARIABLES: Uniform initial conditions.
INIT_FARFIELD_VALUES_KOMEGA: Uniform initial condition from the far-field boundary.

INIT_FARFIELD_VALUES_KOMEGA¶

INIT_KOMEGA_VARIABLES¶

INIT_TURBULENT_VISCOSITY_AND_INTENSITY_KOMEGA¶

INIT_TURBULENT_VISCOSITY_RATIO_AND_INTENSITY_KOMEGA¶

class luminarycloud.params.enum.TurbulentVariableInitializationTypeSa¶

Bases: enum.IntEnum

Type of initial condition for the turbulent variables.

Attributes:

INIT_TURBULENT_VISCOSITY_RATIO_SA: Apply a uniform ratio of turbulent viscosity to laminar viscosity in the domain.
INIT_TURBULENT_VISCOSITY_SA: Set a uniform turbulent viscosity in the domain.
INIT_SA_VARIABLE: 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.

INIT_FARFIELD_VALUES_SA¶

INIT_SA_VARIABLE¶

INIT_TURBULENT_VISCOSITY_RATIO_SA¶

INIT_TURBULENT_VISCOSITY_SA¶

class luminarycloud.params.enum.UpwindSchemeOrder¶

Bases: enum.IntEnum

Spatial order of accuracy of the convective scheme used for the fluid equations.

Attributes:

SECOND: Second-order accuracy.
FIRST: First-order accuracy.

FIRST¶

SECOND¶

class luminarycloud.params.enum.VerificationSolutions¶

Bases: enum.IntEnum

Predefined verification problems built into the solver.

Attributes:

TAYLOR_GREEN_VORTEX: Taylor-Green vortex problem.
NS_MMS: Method of manufactured solutions (MMS) for the Navier-Stokes equations.
EULER_MMS: Method of manufactured solutions (MMS) for the Euler equations.
SHOCK_TUBE: Shock tube problem.
NORMAL_SHOCK: Normal shock problem.
SHOCK_VORTEX: Shock vortex problem.
SHU_OSHER: Shu Osher problem.
DISTURBANCE_WAVE: Disturbance wave problem.
INVISCID_VORTEX: Invisvid vortex transport by uniform flow.
INS_2D_LATTICE: 2D planar lattice flow for incompressible NS.
CHECK_FLUX_SYMMETRY: Run a debug check on the left/right symmetry of fluxes.

CHECK_FLUX_SYMMETRY¶

DISTURBANCE_WAVE¶

EULER_MMS¶

INS_2D_LATTICE¶

INVISCID_VORTEX¶

NORMAL_SHOCK¶

NS_MMS¶

SHOCK_TUBE¶

SHOCK_VORTEX¶

SHU_OSHER¶

TAYLOR_GREEN_VORTEX¶

class luminarycloud.params.enum.ViscousModel¶

Bases: enum.IntEnum

Set the viscous model for the fluid solver.

Attributes:

RANS: Reynolds-averaged Navier-Stokes.
DES: Detached Eddy Simulation.
LES: Large Eddy Simulation.
LAMINAR: Laminar flow governed by the Navier-Stokes equations.
INVISCID: Inviscid flow governed by the Euler equations.

DES¶

INVISCID¶

LAMINAR¶

LES¶

RANS¶

class luminarycloud.params.enum.WallEnergy¶

Bases: enum.IntEnum

Condition applied to the energy equation at a solid wall boundary.

Attributes:

FIXED_HEAT_FLUX: Apply a fixed heat flux at the wall surface.
FIXED_TEMPERATURE: Apply a fixed temperature at the wall surface.

FIXED_HEAT_FLUX¶

FIXED_TEMPERATURE¶

class luminarycloud.params.enum.WallMomentum¶

Bases: enum.IntEnum

Condition applied to the momentum equations at a solid wall boundary.

Attributes:

NO_SLIP: Apply a no-slip condition at the wall surface.
SLIP: Apply a slip (flow tangency) condition at the wall surface.
WALL_MODEL: Apply a wall model at the wall surface.

NO_SLIP¶

SLIP¶

WALL_MODEL¶