gko::log::SolverProgress#

Emits per-iteration residual norm (and optionally the full residual / solution vectors) to disk so a solve’s trajectory can be plotted offline. Useful for diagnosing slow convergence or comparing preconditioners.

class SolverProgress #

Inherits from

This Logger outputs the value of all scalar values (and potentially vectors) stored internally by the solver after each iteration. It needs to be attached to the solver being inspected.

Public Static Functions

static std::shared_ptr<SolverProgress> create_scalar_table_writer(
std::ostream &output,
int precision = 6,
int column_width = 12,
)#

Creates a logger printing the value for all scalar values in the solver after each iteration in an ASCII table. If the solver is applied to multiple right-hand sides, only the first right-hand side gets printed.

Parameters:

  • output – the stream to write the output to.

  • precision – the number of digits of precision to print

  • column_width – the number of characters an output column is wide

static std::shared_ptr<SolverProgress> create_scalar_csv_writer(
std::ostream &output,
int precision = 6,
char separator = ',',
)#

Creates a logger printing the value for all scalar values in the solver after each iteration in a CSV table. If the solver is applied to multiple right-hand sides, only the first right-hand side gets printed.

Parameters:

  • output – the stream to write the output to.

  • precision – the number of digits of precision to print

  • separator – the character separating columns from each other

static std::shared_ptr<SolverProgress> create_vector_storage(
std::string output_file_prefix = "solver_",
bool binary = false,
)#

Creates a logger storing all vectors and scalar values in the solver after each iteration on disk. This logger can handle multiple right-hand sides, in contrast to create_scalar_table_writer or create_scalar_csv_writer.

Parameters:

  • output – the path and file name prefix used to generate the output file names.

  • precision – the number of digits of precision to print when outputting matrices in text format

  • binary – if true, write data in Ginkgo’s own binary format (lossless), if false write data in the MatrixMarket format (potentially lossy)