luminarycloud.enum¶

Attributes¶

ExtractStatusType

Classes¶

`AveragingType`	Represents an averaging method used to compute average surface quantities.
`CalculationType`	Represents a calculation type when calculating surface outputs or defining OutputNodes.
`CameraDirection`	Directional camera options
`CameraProjection`	The type of projection used in the camera.
`ColorMapPreset`	Predefined color map presets.
`EntityType`	An enum for specifying the source of an image. When listing extracts,
`FieldComponent`	Specifies which component of a vector field is used for visualization.
`ForceDirectionType`	Whether a force output's direction is explicit ("custom") or implicit (based on "body
`GPUType`	Represents a GPU type.
`GeometryStatus`	Represents the status of a geometry.
`MeshStatus`	Represents the status of a mesh.
`MeshType`	Represents the file format for a mesh file.
`OutputDefinitionIncludes`	Values that can be included in an output definition.
`OutputNodeIncludes`	Values that can be included in an output node.
`PhysicsAiLifecycleState`	Represents the lifecycle state of a Physics AI resource (architecture or model version).
`QuantityType`	Represents a quantity type.
`ReferenceValuesType`	Method of specification for the reference values used in force and moment computations.
`RenderStatusType`	Represents the status of a rendering request.
`Representation`	The representation defines how objects will appear in the scene.
`ResidualNormalization`	Represents a normalization method for residuals.
`ResidualType`	Represents a Residual type.
`SceneMode`	An enum for specifying how a scene should be rendered in the UI.
`SimulationStatus`	Represents the status of a simulation.
`SpaceAveragingType`	How to average a spatial quantity over a surface.
`StreamlineDirection`	An enum for specifying the integration direction for streamlines filters.
`SurfaceStreamlineMode`	An enum for specifying the streamline behavior for SurfaceStreamlines.
`TableType`	Types of tables.
`Vector3Component`	Components of a 3-D vector.
`VisQuantity`	The visualization quantity. This is a subset of all quantities.
`VolumeReductionType`	How to reduce a volume output quantity over the domain.

Package Contents¶

class AveragingType¶

Represents an averaging method used to compute average surface quantities.

Attributes:

UNSPECIFIED
AREA: Average using the area of each face divided by the total area.
MASS_FLOW: Average using the mass flow at each face divided by the total mass flow.

AREA¶

MASS_FLOW¶

UNSPECIFIED¶

class CalculationType¶

Represents a calculation type when calculating surface outputs or defining OutputNodes.

Attributes:

UNSPECIFIED
AGGREGATE: Calculate a single value for the surfaces altogether.
PER_SURFACE: Calculate a separate value for each surface.
DIFFERENCE: Output the difference between the aggregate of all the IN surfaces and the aggregate of all the OUT surfaces. Not valid for a GetSimulationSurfaceQuantityOutputRequest, only for use in OutputNodes.

AGGREGATE¶

DIFFERENCE¶

PER_SURFACE¶

UNSPECIFIED¶

class CameraDirection¶

Directional camera options

Attributes:

X_POSITIVE: Look down the positive x-axis
Y_POSITIVE: Look down the positive y-axis
Z_POSITIVE: Look down the positive z-axis
X_NEGATIVE: Look down the negative x-axis
Y_NEGATIVE: Look down the negative y-axis
Z_NEGATIVE: Look down the negative z-axis

X_NEGATIVE¶

X_POSITIVE¶

Y_NEGATIVE¶

Y_POSITIVE¶

Z_NEGATIVE¶

Z_POSITIVE¶

class CameraProjection¶

The type of projection used in the camera.

Attributes:

ORTHOGRAPHIC: A orthographic (i.e., parallel) projection.
PERSPECTIVE: A perspective projection.

ORTHOGRAPHIC¶

PERSPECTIVE¶

class ColorMapPreset¶

Predefined color map presets.

COOL_TO_WARM¶

JET¶

TURBO¶

VIRIDIS¶

WAVE¶

XRAY¶

class EntityType¶

An enum for specifying the source of an image. When listing extracts, the user must specify what type of extract they are interested in. This enum is only used by the visualization code.

Warning

This feature is experimental and may change or be removed in the future.

Attributes:

SIMULATION: Specifies a similuation entity (i.e., a result).
MESH: Specifies a mesh entity.
GEOMETRY: Specifies a geometry entity.

GEOMETRY = 2¶

MESH = 1¶

SIMULATION = 0¶

class FieldComponent¶

Specifies which component of a vector field is used for visualization. When using scalars, the component is ignored.

Warning

This feature is experimental and may change or be removed in the future.

MAGNITUDE¶

X¶

Y¶

Z¶

class ForceDirectionType¶

Whether a force output’s direction is explicit (“custom”) or implicit (based on “body orientation and flow direction”)

Attributes:

CUSTOM
BODY_ORIENTATION_AND_FLOW_DIR

BODY_ORIENTATION_AND_FLOW_DIR¶

CUSTOM¶

UNSPECIFIED¶

class GPUType¶

Represents a GPU type.

A100¶

UNSPECIFIED¶

V100¶

class GeometryStatus¶

Represents the status of a geometry.

Attributes:

UNKNOWN: Status is unknown.
IMPORTING: Geometry is still being processed.
NEEDS_CHECK: Geometry was created but has not yet been checked.
FAILED_CHECK: Geometry is not well-formed and cannot be used.
READY: Geometry is ready to use.

FAILED_CHECK¶

IMPORTING¶

NEEDS_CHECK¶

READY¶

UNKNOWN¶

class MeshStatus¶

Represents the status of a mesh.

Attributes:

UNSPECIFIED: A well-formed mesh resource will never have this value.
CREATING: Mesh is being created.
COMPLETED: Mesh was created successfully and can be used to create simulations.
FAILED: Mesh was not created successfully and is unusable.

COMPLETED¶

CREATING¶

FAILED¶

UNSPECIFIED¶

class MeshType¶

Represents the file format for a mesh file.

Attributes:

UNSPECIFIED: Null value
ANSYS: ANSYS mesh file (.ansys)
CGNS: CFD General Notation System (.cgns)
OPENFOAM: OpenFOAM mesh

ANSYS¶

CGNS¶

OPENFOAM¶

UNSPECIFIED¶

class OutputDefinitionIncludes¶

Values that can be included in an output definition.

Attributes:

BASE: The output value itself.
TIME_AVERAGE: A moving average of the output value.
COEFFICIENT: The coefficient of the output value (only valid for forces and moments).
COEFFICIENT_TIME_AVERAGE: A moving average of the coefficient of the output value (only valid for forces and moments).
MAX_DEV: The moving average of the output value that is used for convergence monitoring.

BASE¶

COEFFICIENT¶

COEFFICIENT_TIME_AVERAGE¶

MAX_DEV¶

TIME_AVERAGE¶

UNSPECIFIED¶

class OutputNodeIncludes¶

Values that can be included in an output node.

Attributes:

BASE
TIME_AVERAGE
COEFFICIENT
COEFFICIENT_TIME_AVERAGE
RESIDUAL
MAX_DEV
INNER

BASE¶

COEFFICIENT¶

COEFFICIENT_TIME_AVERAGE¶

INNER¶

MAX_DEV¶

RESIDUAL¶

TIME_AVERAGE¶

UNSPECIFIED¶

class PhysicsAiLifecycleState¶

Represents the lifecycle state of a Physics AI resource (architecture or model version).

Attributes:

UNSPECIFIED: Default value, should not be used in practice.
DEVELOPMENT: Not ready for general use.
ACTIVE: Available for new training jobs.
DEPRECATED: Can still serve inference, but not used for new training.
RETIRED: Archived; no training or inference support.

ACTIVE¶

DEPRECATED¶

DEVELOPMENT¶

RETIRED¶

UNSPECIFIED¶

class QuantityType¶

Represents a quantity type.

Attributes:

ABS_MASS_FLOW
AREA
DENSITY
DISK_ROTATION_RATE
DISK_THRUST
DISK_TORQUE
DOWNFORCE
DOWNFORCE_COEFFICIENT
DRAG
DRAG_COEFFICIENT
ENERGY_FLUX
FRICTION_FORCE
FRICTION_FORCE_COEFFICIENT
INNER_ITERATION_COUNT
LIFT
LIFT_COEFFICIENT
MACH
MASS_FLOW
PITCHING_MOMENT
PITCHING_MOMENT_COEFFICIENT
PRESSURE
PRESSURE_DRAG
PRESSURE_DRAG_COEFFICIENT
PRESSURE_FORCE
PRESSURE_FORCE_COEFFICIENT
RESIDUAL_DENSITY
RESIDUAL_X_MOMENTUM
RESIDUAL_Y_MOMENTUM
RESIDUAL_Z_MOMENTUM
RESIDUAL_ENERGY
RESIDUAL_SA_VARIABLE
RESIDUAL_TKE
RESIDUAL_OMEGA
RESIDUAL_GAMMA
RESIDUAL_RE_THETA
RESIDUAL_N_TILDE
ROLLING_MOMENT
ROLLING_MOMENT_COEFFICIENT
SIDEFORCE
SIDEFORCE_COEFFICIENT
TEMPERATURE
TOTAL_FORCE
TOTAL_FORCE_COEFFICIENT
TOTAL_MOMENT
TOTAL_MOMENT_COEFFICIENT
TOTAL_PRESSURE
TOTAL_TEMPERATURE
VELOCITY
VELOCITY_MAGNITUDE
VISCOUS_DRAG
VISCOUS_DRAG_COEFFICIENT
Y_PLUS
YAWING_MOMENT
YAWING_MOMENT_COEFFICIENT

ABSOLUTE_PRESSURE¶

ABS_MASS_FLOW¶

ADJOINT_N_TILDE¶

ADJOINT_RE_THETA¶

AREA¶

DENSITY¶

DISK_ROTATION_RATE¶

DISK_THRUST¶

DISK_TORQUE¶

DOWNFORCE¶

DOWNFORCE_COEFFICIENT¶

DRAG¶

DRAG_COEFFICIENT¶

EDDY_VISCOSITY¶

ENERGY_FLUX¶

FRICTION_FORCE¶

FRICTION_FORCE_COEFFICIENT¶

GAMMA¶

GRID_VELOCITY¶

HEAT_FLUX¶

HEAT_TRANSFER_COEFFICIENT¶

INNER_ITERATION_COUNT¶

LIFT¶

LIFT_COEFFICIENT¶

MACH¶

MASS_FLOW¶

MASS_FLUX¶

NORMAL_SENSITIVITY¶

N_TILDE¶

OMEGA¶

PITCHING_MOMENT¶

PITCHING_MOMENT_COEFFICIENT¶

PRESSURE¶

PRESSURE_COEFFICIENT¶

PRESSURE_DRAG¶

PRESSURE_DRAG_COEFFICIENT¶

PRESSURE_FORCE¶

PRESSURE_FORCE_COEFFICIENT¶

Q_CRITERION¶

RELATIVE_MACH¶

RELATIVE_VELOCITY¶

RESIDUAL_DENSITY¶

RESIDUAL_ENERGY¶

RESIDUAL_GAMMA¶

RESIDUAL_N_TILDE¶

RESIDUAL_OMEGA¶

RESIDUAL_RE_THETA¶

RESIDUAL_SA_VARIABLE¶

RESIDUAL_TKE¶

RESIDUAL_X_MOMENTUM¶

RESIDUAL_Y_MOMENTUM¶

RESIDUAL_Z_MOMENTUM¶

RE_ROUGHNESS¶

RE_THETA¶

ROLLING_MOMENT¶

ROLLING_MOMENT_COEFFICIENT¶

SA_VARIABLE¶

SENSITIVITY¶

SIDEFORCE¶

SIDEFORCE_COEFFICIENT¶

SKIN_FRICTION_COEFFICIENT¶

SMOOTHED_NORMAL_SENSITIVITY¶

TEMPERATURE¶

TKE¶

TOTAL_FORCE¶

TOTAL_FORCE_COEFFICIENT¶

TOTAL_MOMENT¶

TOTAL_MOMENT_COEFFICIENT¶

TOTAL_PRESSURE¶

TOTAL_PRESSURE_COEFFICIENT¶

TOTAL_TEMPERATURE¶

UNSPECIFIED¶

VELOCITY¶

VELOCITY_MAGNITUDE¶

VISCOSITY¶

VISCOUS_DRAG¶

VISCOUS_DRAG_COEFFICIENT¶

WALL_SHEAR_STRESS¶

YAWING_MOMENT¶

YAWING_MOMENT_COEFFICIENT¶

Y_PLUS¶

class ReferenceValuesType¶

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

Attributes:

UNSPECIFIED
PRESCRIBE_VALUES: The specified reference values will be used.
FARFIELD_VALUES: Only the area and length reference values will be used; pressure, temperature, and velocity values will be taken from the far field boundary specification.

FARFIELD_VALUES¶

PRESCRIBE_VALUES¶

UNSPECIFIED¶

class RenderStatusType¶

Represents the status of a rendering request.

Warning

This feature is experimental and may change or be removed in the future.

Attributes:

ACTIVE: The request is currently active and being processed.
COMPLETED: The request is complete.
FAILED: The request has failed.
INVALID: The request is invalid.

ACTIVE¶

COMPLETED¶

FAILED¶

INVALID¶

class Representation¶

The representation defines how objects will appear in the scene.

Warning

This feature is experimental and may change or be removed in the future.

POINTS¶

SURFACE¶

SURFACE_WITH_EDGES¶

WIREFRAME¶

class ResidualNormalization¶

Represents a normalization method for residuals.

Attributes:

UNSPECIFIED
ABSOLUTE
RELATIVE

ABSOLUTE¶

RELATIVE¶

UNSPECIFIED¶

class ResidualType¶

Represents a Residual type.

Attributes:

ABSOLUTE
RELATIVE
MAX
MIN

ABSOLUTE¶

MAX¶

MIN¶

RELATIVE¶

UNSPECIFIED¶

class SceneMode¶

An enum for specifying how a scene should be rendered in the UI.

This enum controls whether the scene appears directly within the notebook output or inside a dedicated side panel. This is used by the visualization layer to determine the preferred rendering context for a given scene.

Warning

This feature is experimental and may change or be removed in the future.

Attributes:

INLINE: Render the scene directly in the notebook output.
SIDE_PANEL: Render the scene in the side panel for a more focused or persistent view.

FULLSCREEN = 'fullscreen'¶

INLINE = 'inline'¶

SIDE_PANEL = 'side_panel'¶

class SimulationStatus¶

Represents the status of a simulation.

Attributes:

UNSPECIFIED: A well-formed simulation resource will never have this value.
PENDING: Denotes that the simulation is waiting to be scheduled.
ACTIVE: Denotes that the simulation is running currently.
COMPLETED: Denotes that the simulation completed successfully.
FAILED: Denotes that the simulation completed in a failed state.
SUSPENDED: Denotes that the simulation has been suspended.

ACTIVE¶

COMPLETED¶

FAILED¶

PENDING¶

SUSPENDED¶

UNSPECIFIED¶

class SpaceAveragingType¶

How to average a spatial quantity over a surface.

Attributes:

MASS_FLOW
AREA
NO_AVERAGING

AREA¶

MASS_FLOW¶

NO_AVERAGING¶

UNSPECIFIED¶

class StreamlineDirection¶

An enum for specifying the integration direction for streamlines filters.

Warning

This feature is experimental and may change or be removed in the future.

Attributes:

FORWARD: Integrate streamlines in the direction of the vector field. Use this option when you want to see where a particle travels in the vector field given an initial position.
BACKWARDS: Integrate streamlines in the opposite direction of the vector field. Use this option when you want to see where a particle came from in the vector field given the final position.
BOTH: Integrate streamlines in the both directions in the vector field. Use this option whe you want to see both where the particle came from and where it travels given an initial position.

BACKWARD¶

BOTH¶

FORWARD¶

class SurfaceStreamlineMode¶

An enum for specifying the streamline behavior for SurfaceStreamlines.

Warning

This feature is experimental and may change or be removed in the future.

Attributes:

ADVECT_ON_SURFACE: Particle advection is constrained to the surfaces of the mesh.
ADVECT_IN_VOLUME: Use points on surfaces to seed particle advection in the volume.

ADVECT_IN_VOLUME = 1¶

ADVECT_ON_SURFACE = 0¶

class TableType¶

Types of tables.

Attributes:

MONITOR_POINTS: List of coordinates, name, and IDs. This type is used to define the position of monitor points and point sources.
RADIAL_DISTRIBUTION: Thrust, torque, and radial force vs relative radius.
BLADE_GEOMETRY: Twist angle, sweep angle, anhedral angle, and relative chord vs relative radius.
AIRFOIL_PERFORMANCE: C81 data for an airfoil section.
PROFILE_BC: Arbitrary number of columns vs a spatial coordinate or time. This type is also used for tabulated heat sources.
FAN_CURVE: Pressure rise vs volumetric flow rate.
CUSTOM_SAMPLE_DOE: List of design-of-experiment samples.
TEMP_VARYING: Material property (e.g. conductivity) vs temperature.

AIRFOIL_PERFORMANCE¶

BLADE_GEOMETRY¶

CUSTOM_SAMPLE_DOE¶

FAN_CURVE¶

MONITOR_POINTS¶

PROFILE_BC¶

RADIAL_DISTRIBUTION¶

TEMP_VARYING¶

class Vector3Component¶

Components of a 3-D vector. Attributes ———- UNSPECIFIED X Y Z

UNSPECIFIED¶

X¶

Y¶

Z¶

class VisQuantity¶

The visualization quantity. This is a subset of all quantities.

Warning

This feature is experimental and may change or be removed in the future.

ABSOLUTE_PRESSURE¶

ADJOINT_N_TILDE¶

ADJOINT_RE_THETA¶

DENSITY¶

EDDY_VISCOSITY¶

ENERGY_FLUX¶

GAMMA¶

GRID_VELOCITY¶

HEAT_FLUX¶

HEAT_TRANSFER_COEFFICIENT¶

MACH¶

MASS_FLUX¶

NONE¶

NORMAL_SENSITIVITY¶

N_TILDE¶

OMEGA¶

PRESSURE¶

PRESSURE_COEFFICIENT¶

Q_CRITERION¶

RELATIVE_MACH¶

RELATIVE_VELOCITY¶

RE_ROUGHNESS¶

RE_THETA¶

SA_VARIABLE¶

SENSITIVITY¶

SKIN_FRICTION_COEFFICIENT¶

SMOOTHED_NORMAL_SENSITIVITY¶

TEMPERATURE¶

TKE¶

TOTAL_PRESSURE¶

TOTAL_PRESSURE_COEFFICIENT¶

TOTAL_TEMPERATURE¶

VELOCITY¶

VISCOSITY¶

WALL_SHEAR_STRESS¶

Y_PLUS¶

class VolumeReductionType¶

How to reduce a volume output quantity over the domain.

Attributes:

MINIMUM
MAXIMUM
AVERAGE

AVERAGE¶

MAXIMUM¶

MINIMUM¶

UNSPECIFIED¶

ExtractStatusType¶