StatisticsVectorPostprocessor

Short Description

Compute statistical values of a given VectorPostprocessor. The statistics are computed for each column.

Description

The StatisticsVectorPostprocessor computes statistical information for each column of another VectorPostprocessor (VPP). The results are output in columns corresponding to the column-names of the original VPP. The rows of each column are the statistical measures the StatisticsVectorPostprocessor was asked to compute. In addition, the first column is named stat_type and contains the unique identifier for the type of statistical measure computed in that row.

The statistical measures are chosen using the stats input parameter. Note that multiple statistical measures can be computed simultaneously by passing in more than one to the stats input parameter. The current statistical measures (and their stat_type identifier) the StatisticsPostprocessor can compute are:

Min: 0

stats = min

The minimum value within the column.

Max: 1

stats = max

The maximum value within the column

Sum: 2

stats = sum

The sum of the column

(1)

Average: 3

stats = average

The average (mean) of the column

(2)

Standard Deviation: 4

stats = stddev

The standard deviation of the values

(3)

The 2-Norm (Eucliden Norm): 5

stats = norm2

The 2-norm (also known as the Euclidean Norm or the "distance")

(4)

Important Notes

Note that this VPP only computes on processor 0. This is because that's all that is necessary for output - and the VPP it uses for its values may be doing the same.

Input Parameters

  • statsThe statistics you would like to compute for each column of the VectorPostprocessor

    C++ Type:MultiMooseEnum

    Options:min max sum average stddev norm2

    Description:The statistics you would like to compute for each column of the VectorPostprocessor

  • vppThe VectorPostprocessor to compute statistics for.

    C++ Type:VectorPostprocessorName

    Options:

    Description:The VectorPostprocessor to compute statistics for.

Required Parameters

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

  • contains_complete_historyFalseSet this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation

    Default:False

    C++ Type:bool

    Options:

    Description:Set this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation

Optional Parameters

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Options:

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

  • outputsVector of output names were you would like to restrict the output of variables(s) associated with this object

    C++ Type:std::vector

    Options:

    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

    Default:False

    C++ Type:bool

    Options:

    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

  • force_preauxFalseForces the GeneralUserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Options:

    Description:Forces the GeneralUserObject to be executed in PREAUX

Advanced Parameters

Input Files

References