luminarycloud.enum

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

ImageStatusType

Represents the status of an image request.

MeshStatus

Represents the status of a mesh.

MeshType

Represents the file format for a mesh file.

OutputNodeIncludes

Values that can be included in an output node.

QuantityType

Represents a quantity type.

ReferenceValuesType

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

Representation

The representation defines how objects will appear in the scene.

ResidualNormalization

Represents a normalization method for residuals.

ResidualType

Represents a Residual type.

SimulationStatus

Represents the status of a simulation.

SpaceAveragingType

How to average a spatial quantity over a surface.

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 luminarycloud.enum.AveragingType

Bases: enum.IntEnum

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 luminarycloud.enum.CalculationType

Bases: enum.IntEnum

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 luminarycloud.enum.CameraDirection

Bases: enum.IntEnum

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 luminarycloud.enum.CameraProjection

Bases: enum.IntEnum

The type of projection used in the camera.

Attributes:
ORTHOGRAPHIC

A orthographic (i.e., parallel) projection.

PERSPECTIVE

A perspective projection.

ORTHOGRAPHIC
PERSPECTIVE
class luminarycloud.enum.ColorMapPreset

Bases: enum.IntEnum

Predefined color map presets.

COOL_TO_WARM
JET
TURBO
VIRIDIS
WAVE
XRAY
class luminarycloud.enum.EntityType

Bases: enum.IntEnum

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 luminarycloud.enum.FieldComponent

Bases: enum.IntEnum

Specifies which component of a field is used for visualization. When using scalars, the X component is the only valid component.

Warning

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

MAGNITUDE
X
Y
Z
class luminarycloud.enum.ForceDirectionType

Bases: enum.IntEnum

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 luminarycloud.enum.GPUType

Bases: enum.IntEnum

Represents a GPU type.

A100
UNSPECIFIED
V100
class luminarycloud.enum.ImageStatusType

Bases: enum.IntEnum

Represents the status of an image 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 luminarycloud.enum.MeshStatus

Bases: enum.IntEnum

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 luminarycloud.enum.MeshType

Bases: enum.IntEnum

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 luminarycloud.enum.OutputNodeIncludes

Bases: enum.IntEnum

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 luminarycloud.enum.QuantityType

Bases: enum.IntEnum

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
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_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
ROLLING_MOMENT
ROLLING_MOMENT_COEFFICIENT
SIDEFORCE
SIDEFORCE_COEFFICIENT
TEMPERATURE
TOTAL_FORCE
TOTAL_FORCE_COEFFICIENT
TOTAL_MOMENT
TOTAL_MOMENT_COEFFICIENT
TOTAL_PRESSURE
TOTAL_TEMPERATURE
UNSPECIFIED
VELOCITY
VELOCITY_MAGNITUDE
VISCOUS_DRAG
VISCOUS_DRAG_COEFFICIENT
YAWING_MOMENT
YAWING_MOMENT_COEFFICIENT
Y_PLUS
class luminarycloud.enum.ReferenceValuesType

Bases: enum.IntEnum

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 luminarycloud.enum.Representation

Bases: enum.IntEnum

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 luminarycloud.enum.ResidualNormalization

Bases: enum.IntEnum

Represents a normalization method for residuals.

Attributes:
UNSPECIFIED
ABSOLUTE
RELATIVE
ABSOLUTE
RELATIVE
UNSPECIFIED
class luminarycloud.enum.ResidualType

Bases: enum.IntEnum

Represents a Residual type.

Attributes:
ABSOLUTE
RELATIVE
MAX
MIN
ABSOLUTE
MAX
MIN
RELATIVE
UNSPECIFIED
class luminarycloud.enum.SimulationStatus

Bases: enum.IntEnum

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 luminarycloud.enum.SpaceAveragingType

Bases: enum.IntEnum

How to average a spatial quantity over a surface.

Attributes:
MASS_FLOW
AREA
NO_AVERAGING
AREA
MASS_FLOW
NO_AVERAGING
UNSPECIFIED
class luminarycloud.enum.TableType

Bases: enum.IntEnum

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 luminarycloud.enum.Vector3Component

Bases: enum.IntEnum

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

UNSPECIFIED
X
Y
Z
class luminarycloud.enum.VisQuantity

Bases: enum.IntEnum

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
DENSITY
FRICTION_COEFFICIENT
HEAT_FLUX
MACH
NONE
PRESSURE
PRESSURE_COEFFICIENT
Q_CRITERION
TEMPERATURE
TOTAL_PRESSURE
TOTAL_PRESSURE_COEFFICIENT
TOTAL_TEMPREATURE
VELOCITY
WALL_SHEAR_STRESS
class luminarycloud.enum.VolumeReductionType

Bases: enum.IntEnum

How to reduce a volume output quantity over the domain.

Attributes:
MINIMUM
MAXIMUM
AVERAGE
AVERAGE
MAXIMUM
MINIMUM
UNSPECIFIED