DetachedEddySimulation#

class DetachedEddySimulation[source]#

Bases: Flow360BaseModel

DetachedEddySimulation class is used for running hybrid RANS-LES simulations It is supported for both SpalartAllmaras and kOmegaSST turbulence models, with and without AmplificationFactorTransport transition model enabled.”

Example

>>> fl.SpalartAllmaras(
...     hybrid_model = DetachedEddySimulation(shielding_function = 'ZDES', grid_size_for_LES = 'maxEdgeLength')
... )

Attributes

shielding_function: Literal['DDES', 'ZDES']#

Specifies the type of shielding used for the detached eddy simulation. The allowed inputs are DDES (Delayed Detached Eddy Simulation proposed by Spalart 2006) and ZDES (proposed by Deck and Renard 2020).

Default:

'DDES'

grid_size_for_LES: Literal['maxEdgeLength', 'meanEdgeLength', 'shearLayerAdapted']#

Specifies the length used for the computation of LES length scale. The allowed inputs are maxEdgeLength, meanEdgeLength and shearLayerAdapted.

Default:

'maxEdgeLength'

Additional Constructors

classmethod from_file(filename)#

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

help(methods=False)#

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 
to_file(filename, **kwargs)#

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')