OutputConfiguration¶

class pylimer_tools_cpp.OutputConfiguration(self: pylimer_tools_cpp.OutputConfiguration)¶

Bases: pybind11_object

A configuration object to configure the output values and frequency for simulation classes in this package.

This class specifies which quantities to output and how often to write them during simulations.

Create a new OutputConfiguration instance.

Attributes Summary

`append`	Whether to append to the file or truncate it
`double_values`	List of double-valued quantities to output.
`filename`	The path and name of the file to write to.
`int_values`	List of integer-valued quantities to output.
`output_every`	How often to write the values to the output.
`use_every`	For autocorrelation and averaging, how often to include values.

Attributes Documentation

double_values¶

List of double-valued quantities to output.

Use ComputedDoubleValues enum to specify which floating-point quantities should be computed and written to output.

filename¶: The path and name of the file to write to. An empty string (“”) means standard output (console).

int_values¶

List of integer-valued quantities to output.

Use ComputedIntValues enum to specify which integer quantities should be computed and written to output.

output_every¶: How often to write the values to the output. For averages, this value also says how many values will be averaged.

use_every¶

For autocorrelation and averaging, how often to include values.

Use a value of 1 to take average of or autocorrelate, respectively, all values encountered during the simulation or optimization procedure.