OOF2: The Manual
Name
OOF.Mesh.Analyze.Integral — Integrate the data over the area of the samples.
Synopsis
OOF.Mesh.Analyze.Integral(mesh
,time
,data
,domain
,sampling
,destination
)
Details
- Parent Menu: OOF.Mesh.Analyze
-
Callback: function
_ops_callback
in moduleooflib.engine.IO.analyzemenu
-
Parameters:
mesh
- The mesh on which to compute the output Type: The path to an existing
Mesh
object. time
- Time at which to perform the analysis. Type: A floating point number, or the earliest or latest time.
data
- The output data source. Type: Either a
AggregateOutput
object, or anOutput
object whose value is a real number. domain
- Where on the mesh to compute the data. Type: An object of the
Domain
class. sampling
- How to sample the domain. Type: An object of the
SampleSet
class. destination
- Where the data should be written. Type: An object of the
OutputDestination
class.
Description
Integrate the given data over the computational domain. If the
data has multiple components, the integral is computed for each
component separately. The destination
must be
an MessageWindowStream or a
OutputStream.
If the sampling
is ElementSampleSet or ElementSegmentSampleSet the data is
weighted by the Element
area or Segment
length. Otherwise, all
points are given equal weight.
A header will be printed to identify the data. Each line of the header will begin with a comment character, which can be set by OOF.Settings.Output_Formatting.Comment_Character. Multiple columns of data will be separated by a separator character, which can be set by OOF.Settings.Output_Formatting.Separator.
The output line will include the current Mesh
time if OOF.Settings.Output_Formatting.Show_Time is
set.