Opm::SimulatorReport Struct Reference

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...
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)
	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
unsigned int	total_newton_iterations
unsigned int	total_linear_iterations

Detailed Description

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

Constructor & Destructor Documentation

Opm::SimulatorReport::SimulatorReport

(

bool

verbose = true

)

Default constructor initializing all times to 0.0.

Member Function Documentation

void Opm::SimulatorReport::operator+=

(

const SimulatorReport &

sr

)

Increment this report's times by those in sr.

void Opm::SimulatorReport::report

(

std::ostream &

os

)

Print a report to the given stream.

void Opm::SimulatorReport::reportFullyImplicit

(

std::ostream &

os

)

Print a report, leaving out the transport time.

void Opm::SimulatorReport::reportParam

(

std::ostream &

os

)

Member Data Documentation

double Opm::SimulatorReport::pressure_time

unsigned int Opm::SimulatorReport::total_linear_iterations

unsigned int Opm::SimulatorReport::total_newton_iterations

double Opm::SimulatorReport::total_time

double Opm::SimulatorReport::transport_time

---

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

• SimulatorReport.hpp