luminarycloud.outputs¶

Attributes¶

AnyOutputDefinitionType

Classes¶

`ConvergenceMonitoringConfig`	Configuration for a convergence monitoring calculation of an OutputDefinition.
`DerivedOutputDefinition`	An output that is expressed as a function of other output definitions.
`ForceOutputDefinition`	A force or moment output.
`GeneralStoppingConditions`
`InnerIterationOutputDefinition`	The presence of this definition enables reporting of inner iteration counts for transient simulations.
`OutputDefinitionInclusions`	Specifies which values should be calculated for an OutputDefinition.
`PointProbeOutputDefinition`	An output that is calculated at specific points in the domain.
`ResidualOutputDefinition`	Configuration of simulation residuals.
`StoppingCondition`
`SurfaceAverageOutputDefinition`	An output that is calculated as an average over surfaces.
`TrailingAverageConfig`	Configuration for a trailing average calculation of an OutputDefinition.
`VolumeReductionOutputDefinition`	An output that is calculated as an aggregation over volumes.

Functions¶

`create_or_update_stopping_condition`(→ StoppingCondition)	Create a stopping condition on an output definition, or update it if the stopping condition
`create_output_definition`(…)	Create an output definition for a simulation template.
`delete_output_definition`(→ None)	Delete an output definition.
`delete_stopping_condition`(→ None)	Delete a stopping condition.
`get_general_stopping_conditions`(...)	Get the general stopping conditions for a simulation template.
`get_output_definition`(→ AnyOutputDefinitionType)	Get an output definition by ID.
`get_stopping_condition`(→ StoppingCondition)	Get a stopping condition.
`list_output_definitions`(→ list[AnyOutputDefinitionType])	List output definitions for a simulation template.
`list_stopping_conditions`(→ list[StoppingCondition])	List all stopping conditions for a simulation template.
`update_general_stopping_conditions`(...)	Update the general stopping conditions for a simulation template.
`update_output_definition`(…)	Update an output definition.

Package Contents¶

class luminarycloud.outputs.ConvergenceMonitoringConfig¶

Configuration for a convergence monitoring calculation of an OutputDefinition.

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

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

class ExpressionElement_Dependency¶

A dependency on another output definition.

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

include: luminarycloud.enum.OutputDefinitionIncludes¶: Which particular OutputDefinition value to depend on.

class ExpressionElement_Substring¶

A literal substring in the expression.

substring: str = ''¶: The substring

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

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

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

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

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

class luminarycloud.outputs.ForceOutputDefinition¶

A force or moment output.

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 definition. Will be automatically generated by the server for new definitions.

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

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

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

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

max_inner_iterations: int¶: Maximum number of inner iterations for implicit-time transient simulations.

max_iterations: int¶: Maximum number of iterations.

max_physical_time: float¶: Maximum physical time for transient simulations.

stop_on_any: bool¶: If true, stop the simulation when any stopping condition is met. Otherwise, stop when all stopping conditions are met.

class luminarycloud.outputs.InnerIterationOutputDefinition¶

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

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

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

class luminarycloud.outputs.OutputDefinitionInclusions¶

Specifies which values should be calculated for an OutputDefinition.

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

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

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

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

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

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

Configuration of simulation residuals.

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

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

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

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

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

class luminarycloud.outputs.StoppingCondition¶

averaging_iterations: int¶: Trailing average window length. Number of iterations over which the monitored value is averaged before the tolerance check is applied.

id: str¶: Unique ID

iterations_to_consider: int¶: Number of (averaged) iterations to consider when determining maximum percent deviation from the current value.

output_definition_id: str¶: ID of the output definition defining the quantity to monitor.

start_at_iteration: int¶: The starting iteration for this condition. The condition will evaluate to false before this iteration is reached.

threshold: float¶: The threshold beyond which the condition is met.

class luminarycloud.outputs.SurfaceAverageOutputDefinition¶

An output that is calculated as an average over surfaces.

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

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

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

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

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

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

class luminarycloud.outputs.VolumeReductionOutputDefinition¶

An output that is calculated as an aggregation over volumes.

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

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

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

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

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_or_update_stopping_condition(simulation_template_id: str, output_definition_id: str, threshold: float, start_at_iteration: int | None = None, averaging_iterations: int | None = None, iterations_to_consider: int | None = None) → StoppingCondition¶

Create a stopping condition on an output definition, or update it if the stopping condition already has one.

While this API will prevent the creation of multiple stopping conditions on the same output definition, the UI does not. If this endpoint is invoked with an output definition that has multiple stopping conditions, all but one will be deleted, and the remaining one will be updated.

Parameters:

simulation_template_idstr: ID of the simulation template for which to create the stopping condition.
output_definition_idstr: ID of the output definition on which the stopping condition is based.
thresholdfloat: Threshold for the stopping condition. For a residual stopping condition, the condition is met when the residual drops below this threshold. For a non-residual-based stopping condition, the condition is met when the moving average in the monitored output deviates by less than this percentage of its current moving average over the specified number of iterations.
start_at_iterationint, optional: The condition will evaluate to false before this iteration is reached. Default: 1.
averaging_iterationsint, optional: Trailing average window length. Number of iterations over which the monitored value is averaged before the threshold check is applied. Default: 1.
iterations_to_considerint, optional: Number of (averaged) iterations to consider when determining maximum percent deviation from the current value. Default: 1.

luminarycloud.outputs.create_output_definition(simulation_template_id: str, output_definition: SurfaceAverageOutputDefinition) → SurfaceAverageOutputDefinition¶

luminarycloud.outputs.create_output_definition(simulation_template_id: str, output_definition: ForceOutputDefinition) → ForceOutputDefinition

luminarycloud.outputs.create_output_definition(simulation_template_id: str, output_definition: ResidualOutputDefinition) → ResidualOutputDefinition

luminarycloud.outputs.create_output_definition(simulation_template_id: str, output_definition: InnerIterationOutputDefinition) → InnerIterationOutputDefinition

luminarycloud.outputs.create_output_definition(simulation_template_id: str, output_definition: PointProbeOutputDefinition) → PointProbeOutputDefinition

luminarycloud.outputs.create_output_definition(simulation_template_id: str, output_definition: VolumeReductionOutputDefinition) → VolumeReductionOutputDefinition

luminarycloud.outputs.create_output_definition(simulation_template_id: str, output_definition: DerivedOutputDefinition) → DerivedOutputDefinition

Create an output definition for a simulation template.

Parameters:

simulation_template_idstr: Simulation template in which to create the output definition.
output_definitionAnyOutputDefinitionType: Output definition to create.

luminarycloud.outputs.delete_output_definition(simulation_template_id: str, id: str) → None¶

Delete an output definition.

Parameters:

simulation_template_idstr: ID of the simulation template that owns the output definition.
idstr: ID of the output definition to delete.

luminarycloud.outputs.delete_stopping_condition(simulation_template_id: str, id: str) → None¶

Delete a stopping condition.

Parameters:

simulation_template_idstr: Simulation template in which to delete the stopping condition.
idstr: ID of the stopping condition to delete.

luminarycloud.outputs.get_general_stopping_conditions(simulation_template_id: str) → GeneralStoppingConditions¶

Get the general stopping conditions for a simulation template.

Warning

This feature is experimental and may change or be removed without notice.

Parameters:

simulation_template_idstr: Simulation template for which to get the general stopping conditions.

luminarycloud.outputs.get_output_definition(simulation_template_id: str, id: str) → AnyOutputDefinitionType¶

Get an output definition by ID.

Parameters:

simulation_template_idstr: ID of the simulation template that owns the output definition.
idstr: ID of the output definition to retrieve.

luminarycloud.outputs.get_stopping_condition(simulation_template_id: str, id: str) → StoppingCondition¶

Get a stopping condition.

Parameters:

simulation_template_idstr: Simulation template for which to get the stopping condition.
idstr: ID of the stopping condition to get.

luminarycloud.outputs.list_output_definitions(simulation_template_id: str) → list[AnyOutputDefinitionType]¶

List output definitions for a simulation template.

Parameters:

simulation_template_idstr: ID of the simulation template to list output definitions for.

luminarycloud.outputs.list_stopping_conditions(simulation_template_id: str) → list[StoppingCondition]¶

List all stopping conditions for a simulation template.

Parameters:

simulation_template_idstr: Simulation template for which to list the stopping conditions.

luminarycloud.outputs.update_general_stopping_conditions(simulation_template_id: str, max_iterations: int | None = None, max_physical_time: float | None = None, max_inner_iterations: int | None = None, stop_on_any: bool | None = None) → GeneralStoppingConditions¶

Update the general stopping conditions for a simulation template.

Warning

This feature is experimental and may change or be removed without notice.

Parameters:

simulation_template_idstr: Simulation template for which to update the general stopping conditions.
max_iterationsint, optional: Maximum number of iterations.
max_physical_timefloat, optional: Maximum physical time for transient simulations.
max_inner_iterationsint, optional: Maximum number of inner iterations for implicit-time transient simulations.
stop_on_anybool, optional: If true, stop the simulation when any stopping condition is met. Otherwise, stop when all stopping conditions are met. Default: false.

luminarycloud.outputs.update_output_definition(simulation_template_id: str, id: str, output_definition: SurfaceAverageOutputDefinition) → SurfaceAverageOutputDefinition¶

luminarycloud.outputs.update_output_definition(simulation_template_id: str, id: str, output_definition: ForceOutputDefinition) → ForceOutputDefinition

luminarycloud.outputs.update_output_definition(simulation_template_id: str, id: str, output_definition: ResidualOutputDefinition) → ResidualOutputDefinition

luminarycloud.outputs.update_output_definition(simulation_template_id: str, id: str, output_definition: InnerIterationOutputDefinition) → InnerIterationOutputDefinition

luminarycloud.outputs.update_output_definition(simulation_template_id: str, id: str, output_definition: PointProbeOutputDefinition) → PointProbeOutputDefinition

luminarycloud.outputs.update_output_definition(simulation_template_id: str, id: str, output_definition: VolumeReductionOutputDefinition) → VolumeReductionOutputDefinition

luminarycloud.outputs.update_output_definition(simulation_template_id: str, id: str, output_definition: DerivedOutputDefinition) → DerivedOutputDefinition

Update an output definition.

Parameters:

simulation_template_idstr: ID of the simulation template that owns the output definition.
idstr: ID of the output definition to update.
output_definitionAnyOutputDefinitionType: Updated output definition. The ID of this output definition must be present in the set of output definitions owned by the specified simulation template.

luminarycloud.outputs.AnyOutputDefinitionType¶