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[flow360_schema.models.entities.surface_entities.SurfacePair | flow360_schema.models.entities.surface_entities.GhostSurfacePair]

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)

Load a Flow360BaseModel from a .json file.

Parameters:

filename (str)

Return type:

Flow360BaseModel

Methods

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