Opm::ParallelEclipseState Class Reference

Parallel frontend to the EclipseState. More...

#include <ParallelEclipseState.hpp>

Inheritance diagram for Opm::ParallelEclipseState:

Public Member Functions
	ParallelEclipseState (Parallel::Communication comm)
	Default constructor. More...
	ParallelEclipseState (const Deck &deck)
	Construct from a deck instance. More...
	ParallelEclipseState (const Deck &deck, Parallel::Communication comm)
	Construct from a deck instance. More...
void	switchToGlobalProps ()
	Switch to global field properties. More...
void	switchToDistributedProps ()
	Switch to distributed field properies. More...
const FieldPropsManager &	fieldProps () const override
	Returns a const ref to current field properties. More...
const FieldPropsManager &	globalFieldProps () const override
	Returns a const ref to global field properties. More...
void	computeFipRegionStatistics () override
	Compute basic descriptive statistics about all FIP region sets. More...
const EclipseGrid &	getInputGrid () const override
	Returns a const ref to the eclipse grid. More...
template<class T >
void	resetCartesianMapper (const T *mapper)
	Resets the underlying cartesian mapper \detail This has to be the cartesian mapper of the distributed grid. It will be used to autocreate properties not explicitly stored. More...

Friends
template<class Grid >
class	PropsDataHandle
	Friend to set up props. More...

Detailed Description

Parallel frontend to the EclipseState.

This is a parallel frontend to the mpi-unaware EclipseState in opm-common. It extends the eclipse state class with serialization support, and contains methods to switch between full global field properties, and distributed field properties for consumption in the simulator. Additionally, it has a few sanity checks to ensure that the data that is only available on the root process is not attempted to be accessed on non-root processes.

Constructor & Destructor Documentation

ParallelEclipseState() [1/3]

Opm::ParallelEclipseState::ParallelEclipseState

(

Parallel::Communication

comm

)

Default constructor.

ParallelEclipseState() [2/3]

Opm::ParallelEclipseState::ParallelEclipseState

(

const Deck &

deck

)

Construct from a deck instance.

Parameters

deck	The deck to construct from

Only called on root process

ParallelEclipseState() [3/3]

Opm::ParallelEclipseState::ParallelEclipseState	(	const Deck &	deck,
		Parallel::Communication	comm
	)

Construct from a deck instance.

EXPERIMENTAL FUNCTION TO ADD COMM AS INPUT.

Parameters

deck	The deck to construct from

Only called on root process

Member Function Documentation

computeFipRegionStatistics()

void Opm::ParallelEclipseState::computeFipRegionStatistics ( )

override

Compute basic descriptive statistics about all FIP region sets.

MPI-aware version which knows how to compute statistics across all ranks.

fieldProps()

const FieldPropsManager & Opm::ParallelEclipseState::fieldProps ( ) const

override

Returns a const ref to current field properties.

getInputGrid()

const EclipseGrid & Opm::ParallelEclipseState::getInputGrid ( ) const

override

Returns a const ref to the eclipse grid.

Can only be called on root process.

globalFieldProps()

const FieldPropsManager & Opm::ParallelEclipseState::globalFieldProps ( ) const

override

Returns a const ref to global field properties.

Can only be called on root process.

Referenced by Opm::PropsDataHandle< Grid >::PropsDataHandle().

resetCartesianMapper()

template<class T >

void Opm::ParallelEclipseState::resetCartesianMapper ( const T *  mapper )

inline

Resets the underlying cartesian mapper \detail This has to be the cartesian mapper of the distributed grid. It will be used to autocreate properties not explicitly stored.

Template Parameters

T	The type of the cartesian mapper

Parameters

mapper

The cartesian mapper of the distributed grid

References Opm::ParallelFieldPropsManager::resetCartesianMapper().

switchToDistributedProps()

void Opm::ParallelEclipseState::switchToDistributedProps

(

)

Switch to distributed field properies.

Called on root process to use the distributed field properties. setupLocalProps must be called prior to this.

switchToGlobalProps()

void Opm::ParallelEclipseState::switchToGlobalProps

(

)

Switch to global field properties.

Called on root process to use the global field properties

Friends And Related Function Documentation

PropsDataHandle

template<class Grid >

friend class PropsDataHandle

friend

Friend to set up props.

---

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

• ParallelEclipseState.hpp