SymmetryPlane

class SymmetryPlane

Bases: BoundaryBase

SymmetryPlane defines the symmetric boundary condition. It is similar to SlipWall, but the normal gradient of scalar quantities are forced to be zero on the symmetry plane. Only planar surfaces are supported.

Example

>>> fl.SymmetryPlane(entities=volume_mesh["fluid/symmetry"])

• Define SymmetryPlane boundary condition with automated farfield symmetry plane boundaries:

  >>> auto_farfield = fl.AutomatedFarfield()
  >>> fl.SymmetryPlane(
  ...     entities=[auto_farfield.symmetry_planes],
  ... )
  

---

Attributes

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

List of boundaries with the SymmetryPlane boundary condition imposed.

name: str, optional

Name of the SymmetryPlane boundary condition.

Default:

'Symmetry'

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