Opm::out::Summary Class Reference

#include <Summary.hpp>

Public Types

using GlobalProcessParameters = std::map< std::string, double >
 
using RegionParameters = std::map< std::string, std::vector< double > >
 
using BlockValues = std::map< std::pair< std::string, int >, double >
 

Public Member Functions

 Summary (const EclipseState &es, const SummaryConfig &sumcfg, const EclipseGrid &grid, const Schedule &sched, const std::string &basename="")
 
 ~Summary ()
 
void add_timestep (const SummaryState &st, const int report_step)
 
void eval (SummaryState &summary_state, const int report_step, const double secs_elapsed, const EclipseState &es, const Schedule &schedule, const data::WellRates &well_solution, const data::Group &group_solution, const GlobalProcessParameters &single_values, const RegionParameters &region_values={}, const BlockValues &block_values={}) const
 
void write () const
 

Member Typedef Documentation

◆ BlockValues

using Opm::out::Summary::BlockValues = std::map<std::pair<std::string, int>, double>

◆ GlobalProcessParameters

◆ RegionParameters

using Opm::out::Summary::RegionParameters = std::map<std::string, std::vector<double> >

Constructor & Destructor Documentation

◆ Summary()

Opm::out::Summary::Summary ( const EclipseState es,
const SummaryConfig sumcfg,
const EclipseGrid grid,
const Schedule sched,
const std::string basename = "" 
)

◆ ~Summary()

Opm::out::Summary::~Summary ( )

Member Function Documentation

◆ add_timestep()

void Opm::out::Summary::add_timestep ( const SummaryState st,
const int  report_step 
)

◆ eval()

void Opm::out::Summary::eval ( SummaryState summary_state,
const int  report_step,
const double  secs_elapsed,
const EclipseState es,
const Schedule schedule,
const data::WellRates well_solution,
const data::Group group_solution,
const GlobalProcessParameters single_values,
const RegionParameters region_values = {},
const BlockValues block_values = {} 
) const

◆ write()

void Opm::out::Summary::write ( ) const

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