#include <OutputWriter.hpp>

Inheritance diagram for Opm::OutputWriter:

Public Member Functions
virtual	~OutputWriter ()

virtual void	writeInit (const SimulatorTimerInterface &timer)=0

virtual void	writeTimeStep (const SimulatorTimerInterface &timer, const SimulatorState &reservoirState, const WellState &wellState, bool isSubstep)=0
	Write a blackoil reservoir state to disk for later inspection with visualization tools like ResInsight. More...

Static Public Member Functions
static std::unique_ptr < OutputWriter >	create (const parameter::ParameterGroup &params, std::shared_ptr< const EclipseState > eclipseState, const Opm::PhaseUsage &phaseUsage, std::shared_ptr< const UnstructuredGrid > grid)

Constructor & Destructor Documentation

virtual Opm::OutputWriter::~OutputWriter ( )

inlinevirtual

Allow derived classes to be used in the unique_ptr that is returned from the create() method. (Every class that should be delete'd should have a proper constructor, and if the base class isn't virtual then the compiler won't call the right one when the unique_ptr goes out of scope).

Member Function Documentation

static std::unique_ptr<OutputWriter> Opm::OutputWriter::create	(	const parameter::ParameterGroup &	params,
		std::shared_ptr< const EclipseState >	eclipseState,
		const Opm::PhaseUsage &	phaseUsage,
		std::shared_ptr< const UnstructuredGrid >	grid
	)

static

Create a suitable set of output formats based on configuration.

Parameters

params	Configuration properties. This function will setup a multiplexer of applicable output formats based on the desired configuration values.
deck	Input deck used to set up the simulation.
eclipseState	The internalized input deck.

Returns: Pointer to a multiplexer to all applicable output formats.

See also: Opm::share_obj

virtual void Opm::OutputWriter::writeInit ( const SimulatorTimerInterface & timer )

pure virtual

Write the static data (grid, PVT curves, etc) to disk.

This routine should be called before the first timestep (i.e. when timer.currentStepNum () == 0)

Implemented in Opm::EclipseWriter.

virtual void Opm::OutputWriter::writeTimeStep	(	const SimulatorTimerInterface &	timer,
		const SimulatorState &	reservoirState,
		const WellState &	wellState,
		bool	isSubstep
	)

pure virtual

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

Parameters

[in]	timer	The timer providing time, time step, etc. information
[in]	reservoirState	The thermodynamic state of the reservoir
[in]	wellState	The production/injection data for all wells

This routine should be called after the timestep has been advanced, i.e. timer.currentStepNum () > 0.

Implemented in Opm::EclipseWriter.

Referenced by Opm::AdaptiveTimeStepping::stepImpl().

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

OutputWriter.hpp

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation