Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Opm::SimulatorOutput< Simulator > Struct Template Reference

#include <SimulatorOutput.hpp>

Inheritance diagram for Opm::SimulatorOutput< Simulator >:
Inheritance graph

Public Member Functions

 SimulatorOutput (const parameter::ParameterGroup &params, std::shared_ptr< const EclipseState > eclipseState, const Opm::PhaseUsage &phaseUsage, std::shared_ptr< const UnstructuredGrid > grid, std::shared_ptr< const SimulatorTimer > timer, std::shared_ptr< const SimulationDataContainer > state, std::shared_ptr< const WellState > wellState, std::shared_ptr< Simulator > sim)
 
 SimulatorOutput (const parameter::ParameterGroup &params, const EclipseState &eclipseState, const Opm::PhaseUsage &phaseUsage, const UnstructuredGrid &grid, const SimulatorTimer &timer, const SimulationDataContainer &state, const WellState &wellState, Simulator &sim)
 

Protected Member Functions

virtual void sync ()
 Make sure that the simulator state is up to date before writing. More...
 
 operator std::function< void ()>()
 
virtual void writeOutput ()
 Call the writers that were created based on the parameters. More...
 

Protected Attributes

std::shared_ptr< const SimulatorTimer > timer_
 Just hold a reference to these objects that are owned elsewhere. More...
 
std::shared_ptr< const TimeMap > timeMap_
 
std::shared_ptr< const SimulationDataContainer > reservoirState_
 
std::shared_ptr< const WellState > wellState_
 
std::unique_ptr< OutputWriter > writer_
 Created locally and destructed together with us. More...
 

Constructor & Destructor Documentation

◆ SimulatorOutput() [1/2]

template<typename Simulator >
Opm::SimulatorOutput< Simulator >::SimulatorOutput ( const parameter::ParameterGroup &  params,
std::shared_ptr< const EclipseState >  eclipseState,
const Opm::PhaseUsage &  phaseUsage,
std::shared_ptr< const UnstructuredGrid >  grid,
std::shared_ptr< const SimulatorTimer >  timer,
std::shared_ptr< const SimulationDataContainer >  state,
std::shared_ptr< const WellState >  wellState,
std::shared_ptr< Simulator >  sim 
)
inline
Examples
/var/opm/opm-verteq/opm/verteq/SimulatorOutput.hpp.

◆ SimulatorOutput() [2/2]

template<typename Simulator >
Opm::SimulatorOutput< Simulator >::SimulatorOutput ( const parameter::ParameterGroup &  params,
const EclipseState &  eclipseState,
const Opm::PhaseUsage &  phaseUsage,
const UnstructuredGrid &  grid,
const SimulatorTimer &  timer,
const SimulationDataContainer &  state,
const WellState &  wellState,
Simulator &  sim 
)
inline

Compatibility constructor for clients written in C++03-style: The client provide an informal guarantee that the lifetime of the arguments passed exceeds the lifetime of this object.

Member Function Documentation

◆ operator std::function< void()

Opm::SimulatorOutputBase::operator std::function< void ( )
protectedinherited

Conversion operator which allows the object to be directly passed into an Event and used as a handler.

See also
Opm::SimulatorIncompTwophase::timestep_completed

◆ sync()

template<typename Simulator >
virtual void Opm::SimulatorOutput< Simulator >::sync ( )
inlineprotectedvirtual

Make sure that the simulator state is up to date before writing.

Reimplemented from Opm::SimulatorOutputBase.

Examples
/var/opm/opm-verteq/opm/verteq/SimulatorOutput.hpp.

◆ writeOutput()

virtual void Opm::SimulatorOutputBase::writeOutput ( )
protectedvirtualinherited

Call the writers that were created based on the parameters.

Examples
/var/opm/opm-verteq/opm/verteq/SimulatorOutput.hpp.

Member Data Documentation

◆ reservoirState_

std::shared_ptr<const SimulationDataContainer> Opm::SimulatorOutputBase::reservoirState_
protectedinherited
Examples
/var/opm/opm-verteq/opm/verteq/SimulatorOutput.hpp.

◆ timeMap_

std::shared_ptr<const TimeMap> Opm::SimulatorOutputBase::timeMap_
protectedinherited
Examples
/var/opm/opm-verteq/opm/verteq/SimulatorOutput.hpp.

◆ timer_

std::shared_ptr<const SimulatorTimer> Opm::SimulatorOutputBase::timer_
protectedinherited

Just hold a reference to these objects that are owned elsewhere.

Examples
/var/opm/opm-verteq/opm/verteq/SimulatorOutput.hpp.

◆ wellState_

std::shared_ptr<const WellState> Opm::SimulatorOutputBase::wellState_
protectedinherited
Examples
/var/opm/opm-verteq/opm/verteq/SimulatorOutput.hpp.

◆ writer_

std::unique_ptr<OutputWriter> Opm::SimulatorOutputBase::writer_
protectedinherited

Created locally and destructed together with us.

Examples
/var/opm/opm-verteq/opm/verteq/SimulatorOutput.hpp.
The documentation for this struct was generated from the following file: