luminarycloud.outputs¶

Attributes¶

AnyOutputNodeType

Classes¶

`ConvergenceMonitoringConfig`	Configuration for a convergence monitoring calculation of an OutputNode.
`DerivedOutputNode`	An output that is expressed as a function of other output nodes.
`ForceOutputNode`	A force or moment output.
`InnerIterationOutputNode`	The presence of this node enables reporting of inner iteration counts for transient simulations.
`OutputNodeInclusions`	Specifies which values should be calculated for an OutputNode.
`PointProbeOutputNode`	An output that is calculated at specific points in the domain.
`ResidualOutputNode`	Configuration of simulation residuals.
`SurfaceAverageOutputNode`	An output that is calculated as an average over surfaces.
`TrailingAverageConfig`	Configuration for a trailing average calculation of an OutputNode.
`VolumeReductionOutputNode`	An output that is calculated as an aggregation over volumes.

Functions¶

`create_output_node`(→ AnyOutputNodeType)	Create an output node for a project.
`delete_output_node`(→ None)	Delete an output node.
`get_output_node`(→ AnyOutputNodeType)	Get an output node by ID.
`list_output_nodes`(→ list[AnyOutputNodeType])	List output nodes for a project.
`update_output_node`(→ AnyOutputNodeType)	Update an output node.

Package Contents¶

class luminarycloud.outputs.ConvergenceMonitoringConfig¶

Configuration for a convergence monitoring calculation of an OutputNode.

averaging_iterations: int = 0¶: Number of trailing iterations to average over.

iterations_to_consider: int = 0¶: Number of iterations to consider for convergence analysis.

class luminarycloud.outputs.DerivedOutputNode¶

An output that is expressed as a function of other output nodes.

class ExpressionElement_Dependency¶

A dependency on another output node.

classmethod from_proto(proto: luminarycloud._proto.frontend.output.output_pb2.ExpressionElement) → DerivedOutputNode¶

to_proto() → luminarycloud._proto.frontend.output.output_pb2.ExpressionElement¶

id: str = ''¶: ID of the output node to depend on.

include: luminarycloud.enum.OutputNodeIncludes¶: Which particular OutputNode value to depend on.

class ExpressionElement_Substring¶

A literal substring in the expression.

classmethod from_proto(proto: luminarycloud._proto.frontend.output.output_pb2.ExpressionElement) → DerivedOutputNode¶

to_proto() → luminarycloud._proto.frontend.output.output_pb2.ExpressionElement¶

substring: str = ''¶: The substring

classmethod from_proto(proto: luminarycloud._proto.frontend.output.output_pb2.OutputNode) → DerivedOutputNode¶

to_proto() → luminarycloud._proto.frontend.output.output_pb2.OutputNode¶

elements: list[DerivedOutputNode.ExpressionElement_Dependency | DerivedOutputNode.ExpressionElement_Substring] = []¶: Ordered list of expression elements.

errors: list[str] = []¶: Validation errors

id: str = ''¶: Unique identifier for the node. Will be automatically generated by the server for new nodes.

include: OutputNodeInclusions¶: Configuration for what values to include.

name: str = ''¶: Display name for the node.

class luminarycloud.outputs.ForceOutputNode¶

A force or moment output.

classmethod from_proto(proto: luminarycloud._proto.frontend.output.output_pb2.OutputNode) → ForceOutputNode¶

to_proto() → luminarycloud._proto.frontend.output.output_pb2.OutputNode¶

calc_type: luminarycloud.enum.CalculationType¶: Type of calculation to perform across all surfaces.

force_direction: luminarycloud.types.Vector3¶: Direction vector for force calculation.

id: str = ''¶: Unique identifier for the node. Will be automatically generated by the server for new nodes.

include: OutputNodeInclusions¶: Configuration for what values to include.

moment_center: luminarycloud.types.Vector3¶: Center point for moment calculations.

name: str = ''¶: Display name for the node.

porous: bool = False¶: Whether the surfaces involved are porous.

quantity: luminarycloud.enum.QuantityType¶: Type of quantity to measure.

reference_frame_id: str = ''¶: Reference frame to use for directional quantities. Empty string means use the global reference frame.

surfaces: list[str] = []¶: List of surfaces across which to calculate the output.

class luminarycloud.outputs.InnerIterationOutputNode¶

The presence of this node enables reporting of inner iteration counts for transient simulations.

classmethod from_proto(proto: luminarycloud._proto.frontend.output.output_pb2.OutputNode) → InnerIterationOutputNode¶

to_proto() → luminarycloud._proto.frontend.output.output_pb2.OutputNode¶

id: str = ''¶: Unique identifier for the node. Will be automatically generated by the server for new nodes.

name: str = ''¶: Display name for the node.

class luminarycloud.outputs.OutputNodeInclusions¶

Specifies which values should be calculated for an OutputNode.

classmethod from_proto(proto: luminarycloud._proto.frontend.output.output_pb2.OutputNode) → OutputNodeInclusions¶

base_value: bool = True¶: Whether to include the base value, i.e. the quantity itself.

coefficient: bool = False¶: Whether to compute the quantity coefficient. Only valid for forces and moments, ignored for other quantity types.

convergence_monitoring: ConvergenceMonitoringConfig | None = None¶: If present, computes a convergence monitoring criterion for the quantity.

trailing_average: TrailingAverageConfig | None = None¶: If present, computes a trailing average over the quantity.

class luminarycloud.outputs.PointProbeOutputNode¶

An output that is calculated at specific points in the domain.

classmethod from_proto(proto: luminarycloud._proto.frontend.output.output_pb2.OutputNode) → PointProbeOutputNode¶

to_proto() → luminarycloud._proto.frontend.output.output_pb2.OutputNode¶

id: str = ''¶: Unique identifier for the node. Will be automatically generated by the server for new nodes.

include: OutputNodeInclusions¶: Configuration for what values to include.

name: str = ''¶: Display name for the node.

points: list[str] = []¶: List of points for which to calculate the output.

quantity: luminarycloud.enum.QuantityType¶: Type of quantity to measure.

vector_component: luminarycloud.enum.Vector3Component¶: For vector quantities, the component to measure.

class luminarycloud.outputs.ResidualOutputNode¶

Configuration of simulation residuals.

classmethod from_proto(proto: luminarycloud._proto.frontend.output.output_pb2.OutputNode) → ResidualOutputNode¶

to_proto() → luminarycloud._proto.frontend.output.output_pb2.OutputNode¶

id: str = ''¶: Unique identifier for the node. Will be automatically generated by the server for new nodes.

include: dict[luminarycloud.enum.QuantityType, bool]¶: Which residuals to include.

name: str = ''¶: Display name for the node.

physics_id: str = ''¶: Which physics these residuals apply to.

residual_type: luminarycloud.enum.ResidualType¶: Type of residual calculation.

class luminarycloud.outputs.SurfaceAverageOutputNode¶

An output that is calculated as an average over surfaces.

classmethod from_proto(proto: luminarycloud._proto.frontend.output.output_pb2.OutputNode) → SurfaceAverageOutputNode¶

to_proto() → luminarycloud._proto.frontend.output.output_pb2.OutputNode¶

calc_type: luminarycloud.enum.CalculationType¶: Type of calculation to perform across all surfaces.

id: str = ''¶: Unique identifier for the node. Will be automatically generated by the server for new nodes.

include: OutputNodeInclusions¶: Configuration for what values to include.

name: str = ''¶: Display name for the node.

out_surfaces: list[str] = []¶: For a calc_type of CalculationType.DIFFERENCE, a list of surfaces whose aggregate will be subtracted from the aggregate of the surfaces list.

quantity: luminarycloud.enum.QuantityType¶: Type of quantity to measure.

reference_frame_id: str = ''¶: Reference frame to use for directional quantities. Empty string means use the global reference frame.

space_averaging_type: luminarycloud.enum.SpaceAveragingType¶: Type of spatial averaging to use.

surfaces: list[str] = []¶: List of surfaces across which to calculate the output.

vector_component: luminarycloud.enum.Vector3Component¶: For vector quantities, the component to measure.

class luminarycloud.outputs.TrailingAverageConfig¶

Configuration for a trailing average calculation of an OutputNode.

averaging_iterations: int = 0¶: Number of trailing iterations to average over.

class luminarycloud.outputs.VolumeReductionOutputNode¶

An output that is calculated as an aggregation over volumes.

classmethod from_proto(proto: luminarycloud._proto.frontend.output.output_pb2.OutputNode) → VolumeReductionOutputNode¶

to_proto() → luminarycloud._proto.frontend.output.output_pb2.OutputNode¶

calc_type: luminarycloud.enum.CalculationType¶: Type of calculation to perform across all volumes.

id: str = ''¶: Unique identifier for the node. Will be automatically generated by the server for new nodes.

include: OutputNodeInclusions¶: Configuration for what values to include.

name: str = ''¶: Display name for the node.

quantity: luminarycloud.enum.QuantityType¶: Type of quantity to measure.

vector_component: luminarycloud.enum.Vector3Component¶: For vector quantities, the component to measure.

volume_reduction_type: luminarycloud.enum.VolumeReductionType¶: Type of reduction to perform for each volume.

volumes: list[str] = []¶: List of volumes across which to calculate the output.

luminarycloud.outputs.create_output_node(project_id: str, output_node: AnyOutputNodeType) → AnyOutputNodeType¶

Create an output node for a project.

Parameters:

project_idstr: Project in which to create the output node.
output_nodeAnyOutputNodeType: Output node to create.

luminarycloud.outputs.delete_output_node(project_id: str, id: str) → None¶

Delete an output node.

Parameters:

project_idstr: ID of the project that owns the output node.
idstr: ID of the output node to delete.

luminarycloud.outputs.get_output_node(project_id: str, id: str) → AnyOutputNodeType¶

Get an output node by ID.

Parameters:

project_idstr: ID of the project that owns the output node.
idstr: ID of the output node to retrieve.

luminarycloud.outputs.list_output_nodes(project_id: str) → list[AnyOutputNodeType]¶

List output nodes for a project.

Parameters:

project_idstr: ID of the project to list output nodes for.

luminarycloud.outputs.update_output_node(project_id: str, output_node: AnyOutputNodeType) → AnyOutputNodeType¶

Update an output node.

Parameters:

project_idstr: ID of the project that owns the output node.
output_nodeAnyOutputNodeType: Updated output node. The ID of this output node must be present in the set of output nodes owned by the specified project.

luminarycloud.outputs.AnyOutputNodeType¶