chi.CellVolumeIntegralPostProcessor

Computes the volumetric integral of a field-function as a scalar.

Example usage:

Create this object:

params = 
{
    param_name1 = value1,
    param_name2 = value2,
    --etc.
}
chi.CellVolumeIntegralPostProcessor.Create(params)

Required Input parameters

►field_function       Field function handle or name

type=BLOCK. Field function handle or name.

►name       Name of the post processor

type=STRING. Name of the post processor. This name will be used in many places so make sure it's a useful name.

Optional Input parameters

►compute_volume_average       Flag, when true will compute the volume average of the post-processor

type=BOOLEAN. Flag, when true will compute the volume average of the post-processor.

Default value: false

►execute_on       List of events at which the post-processor will execute

type=ARRAY. List of events at which the post-processor will execute.

Default value: "SolverInitialized", "SolverAdvanced", "SolverExecuted", "ProgramExecuted",

►initial_value       An initial value

type=BLOCK. An initial value.

►logical_volume       Handle to a logical_volume

type=INTEGER. Handle to a logical_volume.

Default value: 0

►print_numeric_format       Numeric format to use

type=STRING. Numeric format to use.

Default value: "general"

Allowable values: "fixed", "floating_point", "scientific", "general"

►print_on       List of events at which the post-processor will print

type=ARRAY. List of events at which the post-processor will print. Make sure that these events are also set for the `PostProcessorPrinter` otherwise it wont print.

Default value: "SolverInitialized", "SolverAdvanced", "SolverExecuted", "ProgramExecuted",

►print_precision       Number of digits to display after decimal point

type=INTEGER. Number of digits to display after decimal point

Default value: 6

►solvername_filter       Controls update events to only execute on the relevant solver'sevent calls

type=STRING. Controls update events to only execute on the relevant solver'sevent calls.

Default value: ""

Usage Examples:

test/modules/CFEM_Diffusion/cDiffusion_2D_2b_RobinBCs.lua
test/modules/CFEM_Diffusion/cDiffusion_2D_2a_DirBCs.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_6ASplitMesh.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_6BSplitMesh.lua