PassiveSpacing

class PassiveSpacing

Bases: Flow360BaseModel

Passively control the mesh spacing either through adjacent Surface’s meshing setting or doing nothing to change existing surface mesh at all.

Example

>>> fl.PassiveSpacing(
...     faces=[geometry["face1"], geometry["face2"]],
...     type="projected"
... )

---

Attributes

name: str, optional

Default:

'Passive spacing'

type: Literal['projected', 'unchanged']

1. When set to projected, turn off anisotropic layers growing for this Surface. Project the anisotropic spacing from the neighboring volumes to this face. 2. When set to unchanged, turn off anisotropic layers growing for this Surface. The surface mesh will remain unaltered when populating the volume mesh.

entities: EntityList[Surface, MirroredSurface, WindTunnelGhostSurface, GhostSurface, GhostCircularPlane]

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