Periodic

class Periodic

Bases: Flow360BaseModel

Periodic defines the translational or rotational periodic boundary condition.

Example

• Define a translationally periodic boundary condition using Translational:

  >>> fl.Periodic(
  ...     surface_pairs=[
  ...         (volume_mesh["VOLUME/BOTTOM"], volume_mesh["VOLUME/TOP"]),
  ...         (volume_mesh["VOLUME/RIGHT"], volume_mesh["VOLUME/LEFT"]),
  ...     ],
  ...     spec=fl.Translational(),
  ... )
  

• Define a rotationally periodic boundary condition using Rotational:

  >>> fl.Periodic(
  ...     surface_pairs=[(volume_mesh["VOLUME/PERIODIC-1"],
  ...         volume_mesh["VOLUME/PERIODIC-2"])],
  ...     spec=fl.Rotational()
  ... )
  

---

Attributes

name: str, optional

Name of the Periodic boundary condition.

Default:

'Periodic'

entity_pairs: UniqueItemList[Union]

List of matching pairs of Surface or ~flow360.GhostSurface.

spec: Translational | Rotational

Define the type of periodic boundary condition (translational/rotational) via Translational/Rotational.

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