OOF2: The Manual

Name

Line Points (LineSampleSet) — Evaluate data at evenly spaced points on a line.

Synopsis

LineSampleSet(n_points,show_distance,show_fraction,show_x,show_y)

Details

  • Base class: SampleSet
  • Parameters:

    n_points
    Number of evenly-spaced points at which to sample the cross section. Type: Integer.
    show_distance
    Include or exclude this data from the output. Type: Boolean, 0 (false) or 1 (true).
    show_fraction
    Include or exclude this data from the output. Type: Boolean, 0 (false) or 1 (true).
    show_x
    Include or exclude this data from the output. Type: Boolean, 0 (false) or 1 (true).
    show_y
    Include or exclude this data from the output. Type: Boolean, 0 (false) or 1 (true).

Description

SampleSet objects are part of the post-solution analysis framework, in which useful data is extracted from the Mesh. The SampleSet determines how data is extracted from the sampling Domain. When sampling is set to LineSampleSet, data is extracted from evenly spaced points within a linear Domain.

The LineSampleSet belongs to the line SampleSet category.

n_points determines the number of points along the line. The point spacing is determined by the length of the Domain.

The show_distance parameter governs whether or not the distance of each point from the beginning of the cross section will be displayed along with the data. show_fraction is similar, but the distance displayed will be divided by the total length of the line.

The show_x and show_y parameters govern whether the x and y positions of the points will be displayed along with the data.

[Note] Note

If n_points is too low, some Elements may be skipped. To avoid this, use ElementSegmentSampleSet instead. That will guarantee that a certain number of sampling points lie within each Element.