Boundary Conditions

class BoundaryCondition
name

Gets the name of the boundary condition, i.e. “top”, “bottom”, etc..

kind

The ‘kind’ of the boundary condition, i.e. “PERIODIC”, “FREESLIP”, or “VELOCITY”

velocity

gets / sets the velocity of the boundary, a length-3 vector. Note a “no-slip” boundary is just a “velocity” boundary with a zero velocity vector.

normal

get the normal vector of the boundary, points into the simulation domain.

restore

gets / sets the restoring percent. When objects hit this boundary, they get reflected back at restore percent, so if restore is 0.5, and object hitting the boundary at 3 length / time recoils with a velocity of 1.5 lengths / time.

class Boundaryconditions

The BoundaryConditions class really just serves as a contianer for the six instances of the BoundaryCondition object:

left
right
front
back
bottom
top

Boundary Condition Constants

BOUNDARY_NONE

no boundary conditions

PERIODIC_X

periodic in the x direction

PERIODIC_Y

periodic in the y direction

PERIODIC_Z

periodic in the z direction

PERIODIC_FULL

periodic in all directions

PERIODIC_GHOST_X
PERIODIC_GHOST_Y
PERIODIC_GHOST_Z
PERIODIC_GHOST_FULL
FREESLIP_X

free slip in the x direction

FREESLIP_Y

free slip in the y direction

FREESLIP_Z

free slip in the z direction

FREESLIP_FULL

free slip in all directions