Return to the region documentation.

style halfspace

Purpose

style halfspace is used to define a half-space, namely either of the two parts into which a plane divides the simulation domain.

Syntax

region id my_hs style halfspace point (x, y, z) normal (nx, ny, nz) keyword value

Keyword

Description

point

obligatory vector of point on the plane that subdivides the space
units: [length]

normal

obligatory, direction normal vector of plane pointing towards the halfspace

general optional keywords

General keywords of the region command

Examples

region id hs style halfspace point (0, 0, 5) normal (0, 0, 1)
region id hs style halfspace point (0, 0, 5) normal (0, 0, 1) side in
region id hs style halfspace point (0, 0, 5) normal (0, 0, 1) side out

Note

The first and second examples are equivalent, as side in is set by default (see “General optional keywords” in the region documentation). side in marks always the half-space in the direction of the normal vector. The third examples uses side out, which means that the half-space in the opposite direction of the normal vector is marked.

Return to the region documentation.