chi.SolverInfoPostProcessor

A post processor that can get basic info for any object based on chi_physics::Solver. This solver's execution does not filter whether solverevents are for the relevant solver. This is done to avoid differing time-histories.

Example usage:

Create this object:

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

Required Input parameters

►info       A parameter block, requiring at minimum the parameter "name" to pass to the solver

type=BLOCK. A parameter block, requiring at minimum the parameter "name" to pass to the solver. Note: each solver will have custom parameter blocks available to get a vast array of different pieces of information.

►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.

►solver       A handle to the solver

type=INTEGER. A handle to the solver.

Optional Input parameters

►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.

►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/framework/post_processors/solver_info_01.lua
test/framework/post_processors/solver_info_02.lua