luminarycloud.params.convergence_criteria

Classes

ConvergenceCriteria

Physics configuration for a simulation.

StoppingCondition

Stopping condition for the solver

Package Contents

class luminarycloud.params.convergence_criteria.ConvergenceCriteria

Bases: luminarycloud.params._param_wrappers.ParamGroupWrapper[luminarycloud._proto.client.simulation_pb2.ConvergenceCriteria]

Physics configuration for a simulation.

max_iterations: int = 2000

Maximum number of iterations to run the simulation.

stop_on_any: bool = False

If true, the simulation will stop if any stopping condition is satisfied.

stopping_conditions: list[luminarycloud.params.convergence_criteria.StoppingCondition]

List of stopping conditions.

class luminarycloud.params.convergence_criteria.StoppingCondition

Bases: luminarycloud.params._param_wrappers.ParamGroupWrapper[luminarycloud._proto.output.output_pb2.StoppingCondition]

Stopping condition for the solver

output: luminarycloud.params.outputs.Output
threshold: float