BoundaryLayer

class BoundaryLayer

Bases: Flow360BaseModel

Setting for growing anisotropic layers orthogonal to the specified Surface (s).

Example

>>> fl.BoundaryLayer(
...     faces=[geometry["face1"], geometry["face2"]],
...     first_layer_thickness=1e-5,
...     growth_rate=1.15
... )

---

Attributes

name: str, optional

Default:

'Boundary layer refinement'

entities: EntityList[Surface, MirroredSurface, WindTunnelGhostSurface]

first_layer_thickness: LengthType.Positive, optional

First layer thickness for volumetric anisotropic layers grown from given Surface (s).

Default:

None

growth_rate: float, optional

Growth rate for volume prism layers for given Surface (s). Supported only by the beta mesher.

Default:

None

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')