A struct for returning timing data from a simulator to its caller. More...

#include <SimulatorReport.hpp>

Public Member Functions
	SimulatorReport (bool verbose=true)
	Default constructor initializing all times to 0.0. More...

	SimulatorReport (const SimulatorReport &)=default
	Copy constructor. More...

void	operator+= (const SimulatorReport &sr)
	Increment this report's times by those in sr. More...

void	report (std::ostream &os)
	Print a report to the given stream. More...

void	reportFullyImplicit (std::ostream &os, const SimulatorReport *failedReport=nullptr)
	Print a report, leaving out the transport time. More...

void	reportParam (std::ostream &os)

Public Attributes
double	pressure_time

double	transport_time

double	total_time

double	solver_time

double	assemble_time

double	linear_solve_time

double	update_time

double	output_write_time

unsigned int	total_well_iterations

unsigned int	total_linearizations

unsigned int	total_newton_iterations

unsigned int	total_linear_iterations

bool	converged

Detailed Description

A struct for returning timing data from a simulator to its caller.

Constructor & Destructor Documentation

◆ SimulatorReport() [1/2]

Opm::SimulatorReport::SimulatorReport ( bool verbose = true )

Default constructor initializing all times to 0.0.

◆ SimulatorReport() [2/2]

Opm::SimulatorReport::SimulatorReport ( const SimulatorReport & )

default

Copy constructor.

Member Function Documentation

◆ operator+=()

void Opm::SimulatorReport::operator+= ( const SimulatorReport & sr )

Increment this report's times by those in sr.

◆ report()

void Opm::SimulatorReport::report ( std::ostream & os )

Print a report to the given stream.

◆ reportFullyImplicit()

void Opm::SimulatorReport::reportFullyImplicit	(	std::ostream &	os,
		const SimulatorReport *	failedReport = `nullptr`
	)

Print a report, leaving out the transport time.

◆ reportParam()

void Opm::SimulatorReport::reportParam ( std::ostream & os )

Member Data Documentation

◆ assemble_time

double Opm::SimulatorReport::assemble_time

◆ converged

bool Opm::SimulatorReport::converged

◆ linear_solve_time

double Opm::SimulatorReport::linear_solve_time

◆ output_write_time

double Opm::SimulatorReport::output_write_time

◆ pressure_time

double Opm::SimulatorReport::pressure_time

◆ solver_time

double Opm::SimulatorReport::solver_time

◆ total_linear_iterations

unsigned int Opm::SimulatorReport::total_linear_iterations

◆ total_linearizations

unsigned int Opm::SimulatorReport::total_linearizations

◆ total_newton_iterations

unsigned int Opm::SimulatorReport::total_newton_iterations

◆ total_time

double Opm::SimulatorReport::total_time

◆ total_well_iterations

unsigned int Opm::SimulatorReport::total_well_iterations

◆ transport_time

double Opm::SimulatorReport::transport_time

◆ update_time

double Opm::SimulatorReport::update_time

The documentation for this struct was generated from the following file:

SimulatorReport.hpp

Public Member Functions

Public Attributes