Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Opm::SimulatorReportSingle Struct Reference

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

#include <SimulatorReport.hpp>

Public Member Functions

bool operator== (const SimulatorReportSingle &) const
 
void operator+= (const SimulatorReportSingle &sr)
 Increment this report's times by those in sr. More...
 
void reportStep (std::ostream &os) const
 Print a report suitable for a single simulation step. More...
 
void reportFullyImplicit (std::ostream &os, const SimulatorReportSingle *failedReport=nullptr) const
 Print a report suitable for the end of a fully implicit case, leaving out the pressure/transport time. More...
 
template<class Serializer >
void serializeOp (Serializer &serializer)
 

Static Public Member Functions

static SimulatorReportSingle serializationTestObject ()
 

Public Attributes

double pressure_time = 0.0
 
double transport_time = 0.0
 
double total_time = 0.0
 
double solver_time = 0.0
 
double assemble_time = 0.0
 
double pre_post_time = 0.0
 
double assemble_time_well = 0.0
 
double linear_solve_setup_time = 0.0
 
double linear_solve_time = 0.0
 
double update_time = 0.0
 
double output_write_time = 0.0
 
unsigned int total_well_iterations = 0
 
unsigned int total_linearizations = 0
 
unsigned int total_newton_iterations = 0
 
unsigned int total_linear_iterations = 0
 
unsigned int min_linear_iterations = std::numeric_limits<unsigned int>::max()
 
unsigned int max_linear_iterations = 0
 
bool converged = false
 
bool well_group_control_changed = false
 
int exit_status = EXIT_SUCCESS
 
double global_time = 0.0
 
double timestep_length = 0.0
 

Detailed Description

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

Member Function Documentation

◆ operator+=()

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

Increment this report's times by those in sr.

◆ operator==()

bool Opm::SimulatorReportSingle::operator== ( const SimulatorReportSingle &  ) const

◆ reportFullyImplicit()

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

Print a report suitable for the end of a fully implicit case, leaving out the pressure/transport time.

◆ reportStep()

void Opm::SimulatorReportSingle::reportStep ( std::ostream &  os) const

Print a report suitable for a single simulation step.

◆ serializationTestObject()

static SimulatorReportSingle Opm::SimulatorReportSingle::serializationTestObject ( )
static

◆ serializeOp()

template<class Serializer >
void Opm::SimulatorReportSingle::serializeOp ( Serializer &  serializer)
inline

References assemble_time, assemble_time_well, converged, exit_status, global_time, linear_solve_setup_time, linear_solve_time, max_linear_iterations, min_linear_iterations, output_write_time, pre_post_time, pressure_time, solver_time, timestep_length, total_linear_iterations, total_linearizations, total_newton_iterations, total_time, total_well_iterations, transport_time, update_time, and well_group_control_changed.

Member Data Documentation

◆ assemble_time

double Opm::SimulatorReportSingle::assemble_time = 0.0

Referenced by Opm::BlackoilModel< TypeTag >::initialLinearization(), and serializeOp().

◆ assemble_time_well

double Opm::SimulatorReportSingle::assemble_time_well = 0.0

Referenced by serializeOp().

◆ converged

bool Opm::SimulatorReportSingle::converged = false

Referenced by Opm::SimulatorFullyImplicitBlackoil< TypeTag >::finalize(), Opm::BlackoilModel< TypeTag >::initialLinearization(), Opm::BlackoilModel< TypeTag >::nonlinearIterationNewton(), Opm::BlackoilModelNldd< TypeTag >::nonlinearIterationNldd(), serializeOp(), and Opm::NonlinearSolver< TypeTag, PhysicalModel >::step().

◆ exit_status

int Opm::SimulatorReportSingle::exit_status = EXIT_SUCCESS

Referenced by Opm::FlowMain< TypeTag >::executeStepsCleanup(), Opm::SimulatorFullyImplicitBlackoil< TypeTag >::runStep(), and serializeOp().

◆ global_time

double Opm::SimulatorReportSingle::global_time = 0.0

Referenced by serializeOp(), and Opm::NonlinearSolver< TypeTag, PhysicalModel >::step().

◆ linear_solve_setup_time

double Opm::SimulatorReportSingle::linear_solve_setup_time = 0.0

Referenced by Opm::BlackoilModel< TypeTag >::nonlinearIterationNewton(), and serializeOp().

◆ linear_solve_time

double Opm::SimulatorReportSingle::linear_solve_time = 0.0

Referenced by Opm::BlackoilModel< TypeTag >::nonlinearIterationNewton(), and serializeOp().

◆ max_linear_iterations

unsigned int Opm::SimulatorReportSingle::max_linear_iterations = 0

Referenced by Opm::EclWriter< TypeTag >::evalSummaryState(), and serializeOp().

◆ min_linear_iterations

unsigned int Opm::SimulatorReportSingle::min_linear_iterations = std::numeric_limits<unsigned int>::max()

Referenced by Opm::EclWriter< TypeTag >::evalSummaryState(), and serializeOp().

◆ output_write_time

double Opm::SimulatorReportSingle::output_write_time = 0.0

Referenced by Opm::SimulatorFullyImplicitBlackoil< TypeTag >::finalize(), Opm::SimulatorFullyImplicitBlackoil< TypeTag >::runStep(), and serializeOp().

◆ pre_post_time

double Opm::SimulatorReportSingle::pre_post_time = 0.0

Referenced by Opm::BlackoilModel< TypeTag >::afterStep(), Opm::BlackoilModel< TypeTag >::prepareStep(), and serializeOp().

◆ pressure_time

double Opm::SimulatorReportSingle::pressure_time = 0.0

Referenced by serializeOp().

◆ solver_time

double Opm::SimulatorReportSingle::solver_time = 0.0

Referenced by Opm::SimulatorFullyImplicitBlackoil< TypeTag >::runStep(), and serializeOp().

◆ timestep_length

double Opm::SimulatorReportSingle::timestep_length = 0.0

Referenced by serializeOp(), and Opm::NonlinearSolver< TypeTag, PhysicalModel >::step().

◆ total_linear_iterations

unsigned int Opm::SimulatorReportSingle::total_linear_iterations = 0

Referenced by Opm::EclWriter< TypeTag >::evalSummaryState(), Opm::BlackoilModel< TypeTag >::nonlinearIterationNewton(), and serializeOp().

◆ total_linearizations

unsigned int Opm::SimulatorReportSingle::total_linearizations = 0

Referenced by Opm::BlackoilModel< TypeTag >::initialLinearization(), and serializeOp().

◆ total_newton_iterations

unsigned int Opm::SimulatorReportSingle::total_newton_iterations = 0

Referenced by Opm::EclWriter< TypeTag >::evalSummaryState(), Opm::BlackoilModel< TypeTag >::nonlinearIterationNewton(), Opm::BlackoilModelNldd< TypeTag >::nonlinearIterationNldd(), and serializeOp().

◆ total_time

double Opm::SimulatorReportSingle::total_time = 0.0

Referenced by Opm::SimulatorFullyImplicitBlackoil< TypeTag >::finalize(), and serializeOp().

◆ total_well_iterations

unsigned int Opm::SimulatorReportSingle::total_well_iterations = 0

Referenced by serializeOp().

◆ transport_time

double Opm::SimulatorReportSingle::transport_time = 0.0

Referenced by serializeOp().

◆ update_time

double Opm::SimulatorReportSingle::update_time = 0.0

Referenced by Opm::BlackoilModel< TypeTag >::initialLinearization(), Opm::BlackoilModel< TypeTag >::nonlinearIterationNewton(), and serializeOp().

◆ well_group_control_changed

bool Opm::SimulatorReportSingle::well_group_control_changed = false

Referenced by serializeOp().

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