pyopensn.post.SolverInfoPostProcessor

class pyopensn.post.SolverInfoPostProcessor

Post-processor for basic info of a Solver.

This solver’s execution does not filter whether solver events are for the relevant solver. This is done to avoid differing time-histories.

(really unclear, rephrasing is needed) ???

Wrapper of opensn::SolverInfoPostProcessor.

Execute(self: pyopensn.post.PostProcessor, event_name: str = 'ManualExecutation') → None

???

Parameters:

event_name (str, default='ManualExecutation') –

???

GetValue(self: pyopensn.post.PostProcessor) → float

???

__init__(self: pyopensn.post.SolverInfoPostProcessor, **kwargs) → None

Construct a solver info post processor object.

Parameters:

  • name (str) – Name of the post processor; used throughout the program.

  • execute_on (List[str], default=['SolverInitialized', 'SolverAdvanced', 'SolverExecuted', 'ProgramExecuted']) – List of events at which the post-processor executes.

  • print_on (List[str], default=['SolverInitialized', 'SolverAdvanced', 'SolverExecuted', 'ProgramExecuted']) – List of events at which the post-processor prints, ensuring these events are also set for the post-processor printer.

  • initial_value (Dict, default={}) – Dictionary of initial value.

  • print_numeric_format ({'fixed', 'floating_point', 'scientific', 'general'}, default='general') – Numeric format for printing.

  • print_precision (int, default=6) – Number of digits displayed after the decimal point.

  • solvername_filter (str, default='') – Filter to control update events to execute only on calls from the specified solver.

  • solver (pyopensn.solver.Solver) – Target solver.

  • info (Dict, default={}) – Dictionary requiring at minimum the parameter name to pass to the solver. Each solver may define additional custom parameters to retrieve various types of information.