Opm::BlackoilOutputWriter Class Reference

Wrapper class for VTK, Matlab, and ECL output. More...

#include <SimulatorFullyImplicitBlackoilOutput.hpp>

Public Member Functions

template<class Grid >
 BlackoilOutputWriter (const Grid &grid, const ParameterGroup &param, const Opm::EclipseState &eclipseState, std::unique_ptr< EclipseIO > &&eclIO, const Opm::PhaseUsage &phaseUsage)
 
void writeInit (const data::Solution &simProps, const NNC &nnc)
 
More...
 
template<class Model >
void writeTimeStep (const SimulatorTimerInterface &timer, const SimulationDataContainer &reservoirState, const Opm::WellStateFullyImplicitBlackoil &wellState, const Model &physicalModel, const bool substep=false, const double nextstep=-1.0, const SimulatorReport &simulatorReport=SimulatorReport())
 Write a blackoil reservoir state to disk for later inspection with visualization tools like ResInsight. More...
 
void writeTimeStepWithCellProperties (const SimulatorTimerInterface &timer, const SimulationDataContainer &reservoirState, const data::Solution &cellData, const Opm::WellStateFullyImplicitBlackoil &wellState, const std::map< std::string, double > &miscSummaryData, const std::map< std::string, std::vector< double >> &extraRestartData, bool substep=false)
 Write a blackoil reservoir state to disk for later inspection with visualization tools like ResInsight. More...
 
void writeTimeStepWithoutCellProperties (const SimulatorTimerInterface &timer, const SimulationDataContainer &reservoirState, const Opm::WellStateFullyImplicitBlackoil &wellState, const std::map< std::string, double > &miscSummaryData, const std::map< std::string, std::vector< double >> &extraRestartData, bool substep=false)
 Write a blackoil reservoir state to disk for later inspection with visualization tools like ResInsight. More...
 
void writeTimeStepSerial (const SimulatorTimerInterface &timer, const SimulationDataContainer &reservoirState, const Opm::WellStateFullyImplicitBlackoil &wellState, const data::Solution &simProps, const std::map< std::string, double > &miscSummaryData, const std::map< std::string, std::vector< double >> &extraRestartData, bool substep)
 Write a blackoil reservoir state to disk for later inspection with visualization tools like ResInsight. More...
 
const std::string & outputDirectory () const
 return output directory
 
bool output () const
 return true if output is enabled
 
bool isIORank () const
 Whether this process does write to disk.
 
void restore (SimulatorTimerInterface &timer, BlackoilState &state, WellStateFullyImplicitBlackoil &wellState, const std::string &filename, const int desiredReportStep)
 
template<class Grid , class WellState >
void initFromRestartFile (const PhaseUsage &phaseUsage, const Grid &grid, SimulationDataContainer &simulatorstate, WellState &wellstate, ExtraData &extra)
 
bool isRestart () const
 
bool requireFIPNUM () const
 

Protected Attributes

const bool output_
 
std::unique_ptr< ParallelDebugOutputInterfaceparallelOutput_
 
const std::string outputDir_
 
const bool restart_double_si_
 
int lastBackupReportStep_
 
std::ofstream backupfile_
 
Opm::PhaseUsage phaseUsage_
 
std::unique_ptr< BlackoilSubWritervtkWriter_
 
std::unique_ptr< BlackoilSubWritermatlabWriter_
 
std::unique_ptr< EclipseIO > eclIO_
 
const EclipseState & eclipseState_
 
std::unique_ptr< ThreadHandleasyncOutput_
 

Detailed Description

Wrapper class for VTK, Matlab, and ECL output.

Member Function Documentation

◆ writeInit()

void Opm::BlackoilOutputWriter::writeInit ( const data::Solution &  simProps,
const NNC &  nnc 
)


◆ writeTimeStep()

template<class Model >
void Opm::BlackoilOutputWriter::writeTimeStep ( const SimulatorTimerInterface timer,
const SimulationDataContainer &  reservoirState,
const Opm::WellStateFullyImplicitBlackoil wellState,
const Model &  physicalModel,
const bool  substep = false,
const double  nextstep = -1.0,
const SimulatorReport &  simulatorReport = SimulatorReport() 
)
inline

Write a blackoil reservoir state to disk for later inspection with visualization tools like ResInsight.

This function will extract the requested output cell properties specified by the RPTRST keyword and write these to file.

◆ writeTimeStepSerial()

void Opm::BlackoilOutputWriter::writeTimeStepSerial ( const SimulatorTimerInterface timer,
const SimulationDataContainer &  reservoirState,
const Opm::WellStateFullyImplicitBlackoil wellState,
const data::Solution &  simProps,
const std::map< std::string, double > &  miscSummaryData,
const std::map< std::string, std::vector< double >> &  extraRestartData,
bool  substep 
)

Write a blackoil reservoir state to disk for later inspection with visualization tools like ResInsight.

This is the function which does the actual write to file.

◆ writeTimeStepWithCellProperties()

void Opm::BlackoilOutputWriter::writeTimeStepWithCellProperties ( const SimulatorTimerInterface timer,
const SimulationDataContainer &  reservoirState,
const data::Solution &  cellData,
const Opm::WellStateFullyImplicitBlackoil wellState,
const std::map< std::string, double > &  miscSummaryData,
const std::map< std::string, std::vector< double >> &  extraRestartData,
bool  substep = false 
)

Write a blackoil reservoir state to disk for later inspection with visualization tools like ResInsight.

This function will write all CellData in simProps to the file as well as the extraRestartData.

◆ writeTimeStepWithoutCellProperties()

void Opm::BlackoilOutputWriter::writeTimeStepWithoutCellProperties ( const SimulatorTimerInterface timer,
const SimulationDataContainer &  reservoirState,
const Opm::WellStateFullyImplicitBlackoil wellState,
const std::map< std::string, double > &  miscSummaryData,
const std::map< std::string, std::vector< double >> &  extraRestartData,
bool  substep = false 
)

Write a blackoil reservoir state to disk for later inspection with visualization tools like ResInsight.

This function will not write any cell properties (e.g., those requested by RPTRST keyword)


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