Output Plane

Output planes are lattice-aligned 2D rectangles that span the entirety of the main lattice. The direction and position of the output plane is set by the user. Output planes are useful for visualizing spatial variations across the system without storing full volumetric data.

Property Grid

General

Value

m | The plane intercept value in template units along the defined axis direction.

Axis Direction

The plane normal direction. After defining the direction of the plane, users enter or select a plane position along this direction. Output planes are X, Y, or Z planes used to display the time-evolution of fluid properties across the domain.

For example, if the user chooses to define an X plane, they will be prompted to select a Mount Point along the X axis that positions the X plane. Only points inside the domain can be selected as Mount Points.

X

Plane is perpendicular to the Y-Z Plane.

Y

Plane is perpendicular to the X-Z Plane.

Z

Plane is perpendicular to the X-Y Plane.

Particle Screen Option

Users also have the option of declaring planes to be a particle screen. A particle screen, when used in tandem with particles, automatically computes a heat map describing the frequency at which particles cross the plane.

Disabled

No particle screening done.

Stick

The particles stick to the screen and pass beyond it.

Particle Screen Start Time

s | Time to start the screening activity. This is the time in seconds defining when the screen starts to capture particles. The default is 0.

Particle Screen Stop Time

s | Time to stop the screening activity. This is the time in seconds defining when the screen stops capturing particles. The default is -1, which implies the end of the simulation.

End of Simulation

The screen will be active from the Start Time until the simulation ends.

Custom Stop Time

The user provides a stop time. The screen will be active from the Start Time to the Custom Stop Time.

Passthrough

Particles will be noted in the heat map but continue in the flow, unimpeded.

Particle Screen Start Time

s | Time to start the screening activity. This is the time in seconds defining when the screen starts to capture particles. The default is 0.

Particle Screen Stop Time

s | Time to stop the screening activity. This is the time in seconds defining when the screen stops capturing particles. The default is -1, which implies the end of the simulation.

End of Simulation

The screen will be active from the Start Time until the simulation ends.

Custom Stop Time

The user provides a stop time. The screen will be active from the Start Time to the Custom Stop Time.

Display Attributes

Visible

Enable or disable the visibility of this component.

Hidden

Plane is active, but not shown in the GUI. This can be used when the setup is complicated or visually “busy”.

Shown

Plane is active and visible.

Mode

Defines if the visualization is a shaded or a wire frame.

Shaded

Wire

Color

Select color for the shaded surface or wireframe.

Width or Opacity

Defines the size of the wireframe or the opacity of the shading.

Output Plane Toolbar

Context-Specific Toolbar Forms	Description
Move	The Move form enables three-dimensional rigid body transform of object through free drag or point-to-point snapping.
Recenter	The Recenter command snaps a plane to the center of the bounding box.
Help	The Help command launches the M-Star reference documentation in your web browser.

For a full description of each selection on the Context-Specific Toolbar, see Toolbar Selections.