SimulationParams

SimulationParams#

class SimulationParams[source]#

Bases: _ParamModelBase

All-in-one class for surface meshing + volume meshing + case configurations

Attributes

meshing: MeshingParams | ModularMeshingWorkflow, optional#

Surface and volume meshing parameters. See MeshingParams for more details.

Default:: None

reference_geometry: ReferenceGeometry, optional#

Global geometric reference values. See ReferenceGeometry for more details.

Default:: None

operating_condition: GenericReferenceCondition | AerospaceCondition | LiquidOperatingCondition, optional#

Global operating condition. See Operating Condition for more details.

Default:: None

Solver settings and numerical models and boundary condition settings. See Volume Models and Surface Models for more details.

Default:: None

time_stepping: Steady | Unsteady#

Time stepping settings. See Time Stepping for more details.

Default:: Steady()

user_defined_dynamics: list[flow360_schema.models.simulation.user_defined_dynamics.user_defined_dynamics.UserDefinedDynamic] | None#

User defined dynamics. See User Defined Dynamics for more details.

Default:: None

user_defined_fields: list[flow360_schema.models.simulation.outputs.outputs.UserDefinedField]#

User defined fields that can be used in outputs.

Default:: []

Output settings. See Outputs for more details.

Default:: None

run_control: RunControl, optional#

Run control settings of the simulation.

Default:: None

Properties

base_length: Length.Float64#: Get base length unit for non-dimensionalization

base_temperature: AbsoluteTemperature.Float64#: Get base temperature unit for non-dimensionalization

base_velocity: Velocity.Float64#: Get base velocity unit for non-dimensionalization

reference_velocity: Velocity.Float64#: This function returns the reference velocity. Note that the reference velocity is NOT the non-dimensionalization velocity scale.

base_density: Density.Float64#: Get base density unit for non-dimensionalization

base_mass: Mass.Float64#: Get base mass unit for non-dimensionalization

base_time: Time.Float64#: Get base time unit for non-dimensionalization

flow360_unit_system: u.UnitSystem#: Get the unit system for non-dimensionalization.

Additional Constructors

classmethod from_file(filename)#

Override to run sanitizer and version updater before validation.

Parameters:: filename (str)

Methods

convert_unit(value, target_system, length_unit=None)[source]#

Converts a given value to the specified unit system.

This method takes a dimensioned quantity and converts it from its current unit system to the target unit system, optionally considering a specific length unit for the conversion.

Parameters:

value – The dimensioned quantity to convert.
target_system (str) – The target unit system for conversion.
length_unit (Length.Float64, optional) – The length unit to use for conversion.

Returns:

The converted value in the specified target unit system.

Return type:

object

Raises:

Flow360ValueError – If the input unit system is not compatible with the target system, or if the required length unit is missing.

is_steady()[source]#: returns True when SimulationParams is steady state

has_solid()[source]#: returns True when SimulationParams has Solid model

has_actuator_disks()[source]#: returns True when SimulationParams has ActuatorDisk disk

has_bet_disks()[source]#: returns True when SimulationParams has BET disk

has_isosurfaces()[source]#: returns True when SimulationParams has isosurfaces

has_monitors()[source]#: returns True when SimulationParams has monitors

has_volume_output()[source]#: returns True when SimulationParams has volume output

has_aeroacoustics()[source]#: returns True when SimulationParams has aeroacoustics

has_user_defined_dynamics()[source]#: returns True when SimulationParams has user defined dynamics

has_force_distributions()[source]#: returns True when SimulationParams has force distributions

has_custom_forces()[source]#: returns True when SimulationParams has any ForceOutputs

display_output_units()[source]#

Display all the output units for UserVariables used in outputs.

Return type:: None

pre_submit_summary()[source]#: Display a summary of the simulation params before submission.

help(methods=False)#

Print fields and methods of a Flow360BaseModel using rich.

Parameters:: methods (bool)
Return type:: None

to_file(filename, **kwargs)#

Export Flow360BaseModel instance to a .json file.

Parameters:

filename (str)
kwargs (Any)

Return type:

None

SimulationParams

Contents

SimulationParams#