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'

Methods

classmethod remap_symmetric_to_user_name(value)

Remap ‘symmetric’ ghost entity to user’s symmetry surface name for UDF backward compat.

classmethod ensure_surface_existence(value)

Ensure all boundaries will be present after mesher