luminarycloud.params.enum¶

Classes¶

`ActuatorDiskBemStrategy`	Defines how the power of the propeller is specified in the blade element model
`AdjointSolutionMethod`	The method used to solve the discrete adjoint equations.
`AllTet`	Automatically inserts high aspect ratio mesh elements in the
`AngleUnit`	Unit used for angles.
`AngularVelocityUnit`	Unit used for angular velocity.
`ArtificialViscosityModel`	Artificial viscosity for shock and interface capturing.
`CavitationModel`	Cavitation models available for simulating flow with cavitation.
`ConductivityUnit`	Unit used for thermal conductivity.
`DebugOutput`	Output debug fields in solution files.
`DebugOutputInteriorSurfaceData`	Copy the interior volume data into the surface data.
`DirectionSpecification`	Method of defining the flow direction at the inlet.
`EnergyUnit`	Unit used for energy.
`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.
`FarfieldMomentum`	Method of defining the farfield momentum conditions.
`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.
`ForceUnit`	Unit used for force.
`GeometryFixes`	Strategies to cope with problematic mesh regions (e.g. high skewness angles).
`GradientMethod`	Method for computing the spatial gradients of fluid variables.
`HeatFluxConvention`	Convention for the direction of positive heat flux.
`ImplicitMethod`	Scheme for implicit relaxation of the governing equations.
`InletEnergy`	Method of defining the inlet energy conditions.
`InterfaceType`	Type of interface treatment
`JacobianUpdateMethod`	Method for determining how often to
`LengthUnit`	Unit used for length.
`Limiter`	Apply a slope limiter for second-order upwind schemes. This tends to increase
`LinsolAmgCycleType`	AMG cycle type
`LinsolAmgSmoother`	AMG cycle smoother
`LocalTimeStepping`	Compute local time steps in each control volume to accelerate convergence
`MassUnit`	Unit used for mass.
`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.
`MolecularWeightUnit`	Unit used for molecular weight.
`MomentUnit`	Unit used for moment.
`MotionFormulation`	Formulation used to model motion of volumes in transient simulations.
`MotionSpecification`	Choice between repositioning volumes at simulation start, or specifying motion velocities
`MpCouplingLinSolCoupling`	Turns on the use of enhanced coupling between the physics, which provides greater robustness at the cost of simulation speed.
`NonlinearControlMethod`	The method used to determine 'input' such that 'output'('input') = 'target'.
`OutletPressureConstraint`	Mode of imposing pressure at the outlet.
`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.
`PowerUnit`	Unit used for power.
`Preconditioning`	Apply low-speed preconditioning to obtain Mach number-independent solutions for ideal gases.
`PressureUnit`	Unit used for pressure.
`ProfileType`	Types of boundary condition profile.
`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.
`ReferenceType`	Method of specification for the reference values used in force and moment computations.
`ResidualNormalization`	Residual normalization type.
`ResidualQuantity`	Residual normalization type.
`RobustDissipation`	Use a form of dissipation that improves robustness but that may reduce accuracy.
`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).
`TemperatureUnit`	Unit used for temperature.
`TimeImplicitOrder`	Temporal order of accuracy of the dual time stepping scheme for time-accurate integration.
`TimeUnit`	Unit used for time.
`TransitionModel`	Laminar-turbulent transition models available for Reynolds-averaged Navier-Stokes (RANS).
`TransitionModelCrossFlow`	Crossflow instability treatment for transition model.
`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.
`UnitSystem`	Collection of units used for all quantities.
`VelocityUnit`	Unit used for velocity.
`VerificationSolutions`	Predefined verification problems built into the solver.
`ViscosityUnit`	Unit used for dynamic viscosity.
`ViscousModel`	Set the viscous model for the fluid solver.
`VolumeUnit`	Unit used for volume.
`VolumetricFlowUnit`	Unit used for volumetric flow.

Package Contents¶

class ActuatorDiskBemStrategy¶

Defines how the power of the propeller is specified in the blade element model

Attributes:

BEM_ROTATION_RATE: 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¶

BEM_TARGET_THRUST¶

INVALID¶

class AdjointSolutionMethod¶

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.

Examples

>>> from luminarycloud.params.enum import AdjointSolutionMethod
>>> AdjointSolutionMethod.ADJOINT_METHOD_GMRES
>>> AdjointSolutionMethod.ADJOINT_METHOD_RICHARDSON
>>> AdjointSolutionMethod.ADJOINT_METHOD_ALGORITHMIC

ADJOINT_METHOD_ALGORITHMIC¶

ADJOINT_METHOD_GMRES¶

ADJOINT_METHOD_RICHARDSON¶

INVALID¶

class AllTet¶

Automatically inserts high aspect ratio mesh elements in the: boundary layer and ignores all adaptation boundary layer settings

Attributes:

ALL_TET_UNSET
ALL_TET_OFF
ALL_TET_ON

Examples

>>> from luminarycloud.params.enum import AllTet
>>> AllTet.ALL_TET_UNSET
>>> AllTet.ALL_TET_OFF
>>> AllTet.ALL_TET_ON

ALL_TET_OFF¶

ALL_TET_ON¶

ALL_TET_UNSET¶

INVALID¶

class AngleUnit¶

Unit used for angles.

Attributes:

UNIT_DEGREE: Degree.
UNIT_RADIAN: Radian.

Examples

>>> from luminarycloud.params.enum import AngleUnit
>>> AngleUnit.UNIT_DEGREE
>>> AngleUnit.UNIT_RADIAN

INVALID¶

UNIT_DEGREE¶

UNIT_RADIAN¶

class AngularVelocityUnit¶

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

INVALID¶

UNIT_RADIAN_PER_SECOND¶

UNIT_RPM¶

class ArtificialViscosityModel¶

Artificial viscosity for shock and interface capturing.

Attributes:

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

Examples

>>> from luminarycloud.params.enum import ArtificialViscosityModel
>>> ArtificialViscosityModel.NO_MODEL
>>> ArtificialViscosityModel.LAD

INVALID¶

LAD¶

NO_MODEL¶

class CavitationModel¶

Cavitation models available for simulating flow with cavitation.

Attributes:

SAUER_SCHNERR: Sauer-Schnerr one equation cavitation model.

Examples

>>> from luminarycloud.params.enum import CavitationModel
>>> CavitationModel.SAUER_SCHNERR

INVALID¶

SAUER_SCHNERR¶

class ConductivityUnit¶

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

INVALID¶

UNIT_BTU_PER_HOUR_FOOT_FAHRENHEIT¶

UNIT_WATT_PER_METER_KELVIN¶

class DebugOutput¶

Output debug fields in solution files.

Attributes:

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

INVALID¶

SOLN_DEBUG_OUTPUT_OFF¶

SOLN_DEBUG_OUTPUT_ON¶

class DebugOutputInteriorSurfaceData¶

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.

Examples

>>> from luminarycloud.params.enum import DebugOutputInteriorSurfaceData
>>> DebugOutputInteriorSurfaceData.SOLN_DEBUG_OUTPUT_INT_SURF_DATA_OFF
>>> DebugOutputInteriorSurfaceData.SOLN_DEBUG_OUTPUT_INT_SURF_DATA_ON

INVALID¶

SOLN_DEBUG_OUTPUT_INT_SURF_DATA_OFF¶

SOLN_DEBUG_OUTPUT_INT_SURF_DATA_ON¶

class DirectionSpecification¶

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.

Examples

>>> from luminarycloud.params.enum import DirectionSpecification
>>> DirectionSpecification.NORMAL_TO_BOUNDARY
>>> DirectionSpecification.DIRECTION_VECTOR

DIRECTION_VECTOR¶

INVALID¶

NORMAL_TO_BOUNDARY¶

class EnergyUnit¶

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

INVALID¶

UNIT_BTU¶

UNIT_JOULE¶

class ExplicitMethod¶

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.

Examples

>>> from luminarycloud.params.enum import ExplicitMethod
>>> ExplicitMethod.RK_4
>>> ExplicitMethod.TVD_RK_3
>>> ExplicitMethod.FORWARD_EULER

FORWARD_EULER¶

INVALID¶

RK_4¶

TVD_RK_3¶

class FarFieldFlowDirectionSpecification¶

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.

Examples

>>> from luminarycloud.params.enum import FarFieldFlowDirectionSpecification
>>> FarFieldFlowDirectionSpecification.FARFIELD_DIRECTION
>>> FarFieldFlowDirectionSpecification.FARFIELD_ANGLES

FARFIELD_ANGLES¶

FARFIELD_DIRECTION¶

INVALID¶

class FarfieldMomentum¶

Method of defining the farfield momentum conditions.

Attributes:

FARFIELD_MACH_NUMBER: 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¶

FARFIELD_VELOCITY_MAGNITUDE¶

INVALID¶

class FloatType¶

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.

Examples

>>> from luminarycloud.params.enum import FloatType
>>> FloatType.DOUBLE
>>> FloatType.ADT1D
>>> FloatType.ADA1D

ADA1D¶

ADT1D¶

DOUBLE¶

INVALID¶

class FlowBehavior¶

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.

Examples

>>> from luminarycloud.params.enum import FlowBehavior
>>> FlowBehavior.STEADY
>>> FlowBehavior.TRANSIENT

INVALID¶

STEADY¶

TRANSIENT¶

class FluidType¶

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.

Examples

>>> from luminarycloud.params.enum import FluidType
>>> FluidType.SINGLE_PHASE
>>> FluidType.CAVITATING_FLUID
>>> FluidType.VOF_FLUID

CAVITATING_FLUID¶

INVALID¶

SINGLE_PHASE¶

VOF_FLUID¶

class ForceUnit¶

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

INVALID¶

UNIT_NEWTON¶

UNIT_POUND_FORCE¶

class GeometryFixes¶

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.

Examples

>>> from luminarycloud.params.enum import GeometryFixes
>>> GeometryFixes.GEOMETRY_FIXES_ON
>>> GeometryFixes.GEOMETRY_FIXES_OFF

GEOMETRY_FIXES_OFF¶

GEOMETRY_FIXES_ON¶

INVALID¶

class GradientMethod¶

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.

Examples

>>> from luminarycloud.params.enum import GradientMethod
>>> GradientMethod.HLSQ
>>> GradientMethod.WEIGHTED_LEAST_SQUARES
>>> GradientMethod.GREEN_GAUSS
>>> GradientMethod.LC_HLSQ
>>> GradientMethod.NODAL_GRADIENT

GREEN_GAUSS¶

HLSQ¶

INVALID¶

LC_HLSQ¶

NODAL_GRADIENT¶

WEIGHTED_LEAST_SQUARES¶

class HeatFluxConvention¶

Convention for the direction of positive heat flux.

Attributes:

CONVENTION_HEAT_FLUX_OUT: Heat leaving the domain is positive.
CONVENTION_HEAT_FLUX_IN: Heat entering the domain is positive

Examples

>>> from luminarycloud.params.enum import HeatFluxConvention
>>> HeatFluxConvention.CONVENTION_HEAT_FLUX_OUT
>>> HeatFluxConvention.CONVENTION_HEAT_FLUX_IN

CONVENTION_HEAT_FLUX_IN¶

CONVENTION_HEAT_FLUX_OUT¶

INVALID¶

class ImplicitMethod¶

Scheme for implicit relaxation of the governing equations.

Attributes:

BACKWARD_EULER: First-order backward Euler scheme.

Examples

>>> from luminarycloud.params.enum import ImplicitMethod
>>> ImplicitMethod.BACKWARD_EULER

BACKWARD_EULER¶

INVALID¶

class InletEnergy¶

Method of defining the inlet energy conditions.

Attributes:

TOTAL_TEMPERATURE_INLET: Specify total temperature.

Examples

>>> from luminarycloud.params.enum import InletEnergy
>>> InletEnergy.TOTAL_TEMPERATURE_INLET

INVALID¶

TOTAL_TEMPERATURE_INLET¶

class InterfaceType¶

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.

Examples

>>> from luminarycloud.params.enum import InterfaceType
>>> InterfaceType.GENERAL_INTERFACE
>>> InterfaceType.MIXING_PLANE_INTERFACE

GENERAL_INTERFACE¶

INVALID¶

MIXING_PLANE_INTERFACE¶

class JacobianUpdateMethod¶

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

Examples

>>> from luminarycloud.params.enum import JacobianUpdateMethod
>>> JacobianUpdateMethod.EXPLICIT_INTERVAL_AND_WARMUP

EXPLICIT_INTERVAL_AND_WARMUP¶

INVALID¶

class LengthUnit¶

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

INVALID¶

UNIT_FOOT¶

UNIT_INCH¶

UNIT_METER¶

UNIT_MILLIMETER¶

class Limiter¶

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.

Examples

>>> from luminarycloud.params.enum import Limiter
>>> Limiter.NO_LIMITER
>>> Limiter.INVARIANT_VENKATAKRISHNAN_CV
>>> Limiter.VAN_ALBADA_FACE
>>> Limiter.VENKATAKRISHNAN_CV

INVALID¶

INVARIANT_VENKATAKRISHNAN_CV¶

NO_LIMITER¶

VAN_ALBADA_FACE¶

VENKATAKRISHNAN_CV¶

class LinsolAmgCycleType¶

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

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

INVALID¶

LINSOL_AMG_CYCLE_TYPE_F¶

LINSOL_AMG_CYCLE_TYPE_V¶

LINSOL_AMG_CYCLE_TYPE_W¶

class LinsolAmgSmoother¶

AMG cycle smoother

Attributes:

LINSOL_AMG_SMOOTHER_JACOBI: Jacobi
LINSOL_AMG_SMOOTHER_GS: 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

INVALID¶

LINSOL_AMG_SMOOTHER_GS¶

LINSOL_AMG_SMOOTHER_JACOBI¶

LINSOL_AMG_SMOOTHER_SYM_GS¶

class LocalTimeStepping¶

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.

Examples

>>> from luminarycloud.params.enum import LocalTimeStepping
>>> LocalTimeStepping.LOCAL_TIME_STEPPING_ON
>>> LocalTimeStepping.LOCAL_TIME_STEPPING_OFF

INVALID¶

LOCAL_TIME_STEPPING_OFF¶

LOCAL_TIME_STEPPING_ON¶

class MassUnit¶

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

INVALID¶

UNIT_GRAM¶

UNIT_KILOGRAM¶

UNIT_POUND¶

class MaterialFluidPreset¶

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.

Examples

>>> from luminarycloud.params.enum import MaterialFluidPreset
>>> MaterialFluidPreset.UNSET_MATERIAL_FLUID_PRESET
>>> MaterialFluidPreset.STANDARD_AIR
>>> MaterialFluidPreset.WATER_NTP
>>> MaterialFluidPreset.CUSTOM_MATERIAL_FLUID

CUSTOM_MATERIAL_FLUID¶

INVALID¶

STANDARD_AIR¶

UNSET_MATERIAL_FLUID_PRESET¶

WATER_NTP¶

class MaterialSolidPreset¶

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.

Examples

>>> from luminarycloud.params.enum import MaterialSolidPreset
>>> MaterialSolidPreset.ALUMINUM
>>> MaterialSolidPreset.COPPER
>>> MaterialSolidPreset.IRON
>>> MaterialSolidPreset.NICKEL
>>> MaterialSolidPreset.TITANIUM
>>> MaterialSolidPreset.CUSTOM_MATERIAL_SOLID

ALUMINUM¶

COPPER¶

CUSTOM_MATERIAL_SOLID¶

INVALID¶

IRON¶

NICKEL¶

TITANIUM¶

class MeshingMethod¶

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.

Examples

>>> from luminarycloud.params.enum import MeshingMethod
>>> MeshingMethod.MESH_METHOD_MANUAL
>>> MeshingMethod.MESH_METHOD_AUTO

INVALID¶

MESH_METHOD_AUTO¶

MESH_METHOD_MANUAL¶

class MolecularWeightUnit¶

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

INVALID¶

UNIT_GRAM_PER_MOLE¶

UNIT_POUND_PER_POUND_MOLE¶

class MomentUnit¶

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

INVALID¶

UNIT_NEWTON_METER¶

UNIT_POUND_FOOT¶

class MotionFormulation¶

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.

Examples

>>> from luminarycloud.params.enum import MotionFormulation
>>> MotionFormulation.AUTOMATIC_MOTION_FORMULATION
>>> MotionFormulation.MRF_MOTION_FORMULATION

AUTOMATIC_MOTION_FORMULATION¶

INVALID¶

MRF_MOTION_FORMULATION¶

class MotionSpecification¶

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

Examples

>>> from luminarycloud.params.enum import MotionSpecification
>>> MotionSpecification.MOTION_SPECIFICATION_REPOSITION
>>> MotionSpecification.MOTION_SPECIFICATION_NORMAL

INVALID¶

MOTION_SPECIFICATION_NORMAL¶

MOTION_SPECIFICATION_REPOSITION¶

class MpCouplingLinSolCoupling¶

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.

Examples

>>> from luminarycloud.params.enum import MpCouplingLinSolCoupling
>>> MpCouplingLinSolCoupling.MP_COUPLING_LIN_SOL_COUPLING_ON
>>> MpCouplingLinSolCoupling.MP_COUPLING_LIN_SOL_COUPLING_OFF

INVALID¶

MP_COUPLING_LIN_SOL_COUPLING_OFF¶

MP_COUPLING_LIN_SOL_COUPLING_ON¶

class NonlinearControlMethod¶

The method used to determine ‘input’ such that ‘output’(‘input’) = ‘target’.

Attributes:

CONTROL_METHOD_SECANT: Use the secant method to solve the equations.

Examples

>>> from luminarycloud.params.enum import NonlinearControlMethod
>>> NonlinearControlMethod.CONTROL_METHOD_SECANT

CONTROL_METHOD_SECANT¶

INVALID¶

class OutletPressureConstraint¶

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.

Examples

>>> from luminarycloud.params.enum import OutletPressureConstraint
>>> OutletPressureConstraint.OUTLET_LOCAL_CONSTRAINT
>>> OutletPressureConstraint.OUTLET_AVERAGE_CONSTRAINT

INVALID¶

OUTLET_AVERAGE_CONSTRAINT¶

OUTLET_LOCAL_CONSTRAINT¶

class PhysicalTimeStepMethod¶

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

Attributes:

FIXED_TIME_STEP: Apply a fixed physical time step.

Examples

>>> from luminarycloud.params.enum import PhysicalTimeStepMethod
>>> PhysicalTimeStepMethod.FIXED_TIME_STEP

FIXED_TIME_STEP¶

INVALID¶

class PorousModelType¶

Type of porous model.

Attributes:

DARCY_FORCHHEIMER: Darcy Forchheimer model.

Examples

>>> from luminarycloud.params.enum import PorousModelType
>>> PorousModelType.DARCY_FORCHHEIMER

DARCY_FORCHHEIMER¶

INVALID¶

class PotentialFlowPressureInitialization¶

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.

Examples

>>> from luminarycloud.params.enum import PotentialFlowPressureInitialization
>>> PotentialFlowPressureInitialization.INITIALIZATION_POTENTIAL_FLOW_PRESSURE_OFF
>>> PotentialFlowPressureInitialization.INITIALIZATION_POTENTIAL_FLOW_PRESSURE_ON

INITIALIZATION_POTENTIAL_FLOW_PRESSURE_OFF¶

INITIALIZATION_POTENTIAL_FLOW_PRESSURE_ON¶

INVALID¶

class PowerUnit¶

Unit used for power.

Attributes:

UNIT_WATT: Watt.
UNIT_HORSEPOWER: Horsepower.

Examples

>>> from luminarycloud.params.enum import PowerUnit
>>> PowerUnit.UNIT_WATT
>>> PowerUnit.UNIT_HORSEPOWER

INVALID¶

UNIT_HORSEPOWER¶

UNIT_WATT¶

class Preconditioning¶

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.

Examples

>>> from luminarycloud.params.enum import Preconditioning
>>> Preconditioning.PRECONDITIONING_ON
>>> Preconditioning.PRECONDITIONING_OFF

INVALID¶

PRECONDITIONING_OFF¶

PRECONDITIONING_ON¶

class PressureUnit¶

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

INVALID¶

UNIT_BAR¶

UNIT_PASCAL¶

UNIT_PSI¶

class ProfileType¶

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_XY: 2D profile in X and Y direction.

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
>>> ProfileType.CARTESIAN_XY

CARTESIAN_X¶

CARTESIAN_XY¶

CARTESIAN_Y¶

CARTESIAN_Z¶

INVALID¶

RADIAL_X¶

RADIAL_Y¶

RADIAL_Z¶

TIME¶

class QcrSa¶

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).

Examples

>>> from luminarycloud.params.enum import QcrSa
>>> QcrSa.QCR_OFF
>>> QcrSa.QCR2000

INVALID¶

QCR2000¶

QCR_OFF¶

class QcrSst¶

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).

Examples

>>> from luminarycloud.params.enum import QcrSst
>>> QcrSst.SST_QCR_OFF
>>> QcrSst.SST_QCR2000

INVALID¶

SST_QCR2000¶

SST_QCR_OFF¶

class RansRegion¶

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.

Examples

>>> from luminarycloud.params.enum import RansRegion
>>> RansRegion.INSIDE
>>> RansRegion.OUTSIDE

INSIDE¶

INVALID¶

OUTSIDE¶

class ReferenceType¶

Method of specification for the reference values used in force and moment computations.

Attributes:

PRESCRIBE_VALUES: User-defined force reference values.
REFERENCE_FARFIELD_VALUES: Force reference values from the farfield conditions.

Examples

>>> from luminarycloud.params.enum import ReferenceType
>>> ReferenceType.PRESCRIBE_VALUES
>>> ReferenceType.REFERENCE_FARFIELD_VALUES

INVALID¶

PRESCRIBE_VALUES¶

REFERENCE_FARFIELD_VALUES¶

class ResidualNormalization¶

Residual normalization type.

Attributes:

ABSOLUTE
RELATIVE
MAX
MIN

ABSOLUTE¶

MAX¶

MIN¶

RELATIVE¶

class ResidualQuantity¶

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 RobustDissipation¶

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.

Examples

>>> from luminarycloud.params.enum import RobustDissipation
>>> RobustDissipation.ROBUST_DISS_OFF
>>> RobustDissipation.ROBUST_DISS_ON

INVALID¶

ROBUST_DISS_OFF¶

ROBUST_DISS_ON¶

class RotationCorrectionSa¶

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.

Examples

>>> from luminarycloud.params.enum import RotationCorrectionSa
>>> RotationCorrectionSa.ROTATION_CORRECTION_OFF
>>> RotationCorrectionSa.ROTATION_CORRECTION_ON

INVALID¶

ROTATION_CORRECTION_OFF¶

ROTATION_CORRECTION_ON¶

class SkewSymmetricFormulation¶

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.

Examples

>>> from luminarycloud.params.enum import SkewSymmetricFormulation
>>> SkewSymmetricFormulation.CHANDRASEKHAR_EC2
>>> SkewSymmetricFormulation.CHANDRASEKHAR_EC1
>>> SkewSymmetricFormulation.KUYA

CHANDRASEKHAR_EC1¶

CHANDRASEKHAR_EC2¶

INVALID¶

KUYA¶

class 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).

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.

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

AGGRESSIVE_SOLUTION_CONTROLS_FLUID¶

CUSTOM_SOLUTION_CONTROLS_FLUID¶

DEFAULT_SOLUTION_CONTROLS_FLUID¶

INTERMEDIATE_SOLUTION_CONTROLS_FLUID¶

INVALID¶

UNSET_SOLUTION_CONTROLS_FLUID_PRESET¶

class 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).

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.

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

AGGRESSIVE_SOLUTION_CONTROLS_HEAT¶

CUSTOM_SOLUTION_CONTROLS_HEAT¶

DEFAULT_SOLUTION_CONTROLS_HEAT¶

INTERMEDIATE_SOLUTION_CONTROLS_HEAT¶

INVALID¶

UNSET_SOLUTION_CONTROLS_HEAT_PRESET¶

class 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).

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.

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

CONSERVATIVE_SPATIAL_DISCRETIZATION_FLUID¶

CUSTOM_SPATIAL_DISCRETIZATION_FLUID¶

DEFAULT_SPATIAL_DISCRETIZATION_FLUID¶

HIGH_ACCURACY_SPATIAL_DISCRETIZATION_FLUID¶

INVALID¶

UNSET_SPATIAL_DISCRETIZATION_FLUID_PRESET¶

class 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).

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.

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

CONSERVATIVE_SPATIAL_DISCRETIZATION_HEAT¶

CUSTOM_SPATIAL_DISCRETIZATION_HEAT¶

DEFAULT_SPATIAL_DISCRETIZATION_HEAT¶

HIGH_ACCURACY_SPATIAL_DISCRETIZATION_HEAT¶

INVALID¶

UNSET_SPATIAL_DISCRETIZATION_HEAT_PRESET¶

class TemperatureUnit¶

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

INVALID¶

UNIT_CELSIUS¶

UNIT_FAHRENHEIT¶

UNIT_KELVIN¶

UNIT_RANKINE¶

class TimeImplicitOrder¶

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.

Examples

>>> from luminarycloud.params.enum import TimeImplicitOrder
>>> TimeImplicitOrder.TIME_SECOND
>>> TimeImplicitOrder.TIME_FIRST

INVALID¶

TIME_FIRST¶

TIME_SECOND¶

class TimeUnit¶

Unit used for time.

Attributes:

UNIT_SECOND: Second.

Examples

>>> from luminarycloud.params.enum import TimeUnit
>>> TimeUnit.UNIT_SECOND

INVALID¶

UNIT_SECOND¶

class TransitionModel¶

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.

Examples

>>> from luminarycloud.params.enum import TransitionModel
>>> TransitionModel.NO_TRANSITION
>>> TransitionModel.GAMMA_2015
>>> TransitionModel.GAMMA_RE_THETA_2009
>>> TransitionModel.AFT_2019

AFT_2019¶

GAMMA_2015¶

GAMMA_RE_THETA_2009¶

INVALID¶

NO_TRANSITION¶

class TransitionModelCrossFlow¶

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.

Examples

>>> from luminarycloud.params.enum import TransitionModelCrossFlow
>>> TransitionModelCrossFlow.TRANSITION_MODEL_CROSS_FLOW_OFF
>>> TransitionModelCrossFlow.TRANSITION_MODEL_CROSS_FLOW_ON

INVALID¶

TRANSITION_MODEL_CROSS_FLOW_OFF¶

TRANSITION_MODEL_CROSS_FLOW_ON¶

class TurbulenceSpecificationKomega¶

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.

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_KOMEGA_VARIABLES¶

BC_TURBULENT_VISCOSITY_AND_INTENSITY_KOMEGA¶

BC_TURBULENT_VISCOSITY_RATIO_AND_INTENSITY_KOMEGA¶

INVALID¶

class TurbulenceSpecificationSpalartAllmaras¶

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.

Examples

>>> from luminarycloud.params.enum import TurbulenceSpecificationSpalartAllmaras
>>> TurbulenceSpecificationSpalartAllmaras.TURBULENT_VISCOSITY_RATIO_SA
>>> TurbulenceSpecificationSpalartAllmaras.TURBULENT_VISCOSITY_SA
>>> TurbulenceSpecificationSpalartAllmaras.BC_SA_VARIABLE

BC_SA_VARIABLE¶

INVALID¶

TURBULENT_VISCOSITY_RATIO_SA¶

TURBULENT_VISCOSITY_SA¶

class TurbulentVariableInitializationTypeKomega¶

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.

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_FARFIELD_VALUES_KOMEGA¶

INIT_KOMEGA_VARIABLES¶

INIT_TURBULENT_VISCOSITY_AND_INTENSITY_KOMEGA¶

INIT_TURBULENT_VISCOSITY_RATIO_AND_INTENSITY_KOMEGA¶

INVALID¶

class TurbulentVariableInitializationTypeSa¶

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.

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_FARFIELD_VALUES_SA¶

INIT_SA_VARIABLE¶

INIT_TURBULENT_VISCOSITY_RATIO_SA¶

INIT_TURBULENT_VISCOSITY_SA¶

INVALID¶

class UnitSystem¶

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

INVALID¶

UNIT_SYSTEM_CUSTOM¶

UNIT_SYSTEM_SI¶

UNIT_SYSTEM_US¶

class VelocityUnit¶

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

INVALID¶

UNIT_FEET_PER_SECOND¶

UNIT_KM_PER_HOUR¶

UNIT_METER_PER_SECOND¶

UNIT_MILES_PER_HOUR¶

class VerificationSolutions¶

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.

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

CHECK_FLUX_SYMMETRY¶

DISTURBANCE_WAVE¶

EULER_MMS¶

INS_2D_LATTICE¶

INVALID¶

INVISCID_VORTEX¶

NORMAL_SHOCK¶

NS_MMS¶

SHOCK_TUBE¶

SHOCK_VORTEX¶

SHU_OSHER¶

TAYLOR_GREEN_VORTEX¶

class ViscosityUnit¶

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

INVALID¶

UNIT_CENTIPOISE¶

UNIT_PASCAL_SECOND¶

UNIT_POUND_SECOND_PER_SQUARE_FOOT¶

class ViscousModel¶

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.

Examples

>>> from luminarycloud.params.enum import ViscousModel
>>> ViscousModel.RANS
>>> ViscousModel.DES
>>> ViscousModel.LES
>>> ViscousModel.LAMINAR
>>> ViscousModel.INVISCID

DES¶

INVALID¶

INVISCID¶

LAMINAR¶

LES¶

RANS¶

class VolumeUnit¶

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

INVALID¶

UNIT_CUBIC_FOOT¶

UNIT_CUBIC_INCH¶

UNIT_CUBIC_METER¶

UNIT_GALLON¶

UNIT_LITER¶

class VolumetricFlowUnit¶

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

INVALID¶

UNIT_CFM¶

UNIT_CUBIC_METER_PER_SECOND¶