Opm::BlackoilState Class Reference

Simulator state for a blackoil simulator. More...

#include <BlackoilState.hpp>

Inheritance diagram for Opm::BlackoilState:

Public Member Functions
	BlackoilState (size_t num_cells, size_t num_faces, size_t num_phases)
	BlackoilState (const BlackoilState &other)
BlackoilState &	operator= (const BlackoilState &other)
std::vector< double > &	surfacevol ()
std::vector< double > &	gasoilratio ()
std::vector< double > &	rv ()
std::vector< HydroCarbonState > &	hydroCarbonState ()
const std::vector< double > &	surfacevol () const
const std::vector< double > &	gasoilratio () const
const std::vector< double > &	rv () const
const std::vector< HydroCarbonState > &	hydroCarbonState () const

Static Public Attributes
static const std::string	GASOILRATIO
static const std::string	RV
static const std::string	SURFACEVOL
static const std::string	SSOL
static const std::string	POLYMER

Detailed Description

Simulator state for a blackoil simulator.

Constructor & Destructor Documentation

BlackoilState() [1/2]

Opm::BlackoilState::BlackoilState	(	size_t	num_cells,
		size_t	num_faces,
		size_t	num_phases
	)

Main constructor setting the sizes for the contained data types.

Parameters

num_cells	number of elements in cell data vectors
num_faces	number of elements in face data vectors
num_phases	number of phases, the number of components in any data vector must equal 1 or this number (this behaviour and argument is deprecated).

BlackoilState() [2/2]

Opm::BlackoilState::BlackoilState

(

const BlackoilState &

other

)

Copy constructor. Must be defined explicitly because class contains non-value objects (the reference pointers rv_ref_ etc.) that should not simply be copied.

Member Function Documentation

gasoilratio() [1/2]

std::vector< double > & Opm::BlackoilState::gasoilratio ( )

inline

gasoilratio() [2/2]

const std::vector< double > & Opm::BlackoilState::gasoilratio ( ) const

inline

hydroCarbonState() [1/2]

std::vector< HydroCarbonState > & Opm::BlackoilState::hydroCarbonState ( )

inline

Referenced by Opm::initHydroCarbonState().

hydroCarbonState() [2/2]

const std::vector< HydroCarbonState > & Opm::BlackoilState::hydroCarbonState ( ) const

inline

operator=()

BlackoilState & Opm::BlackoilState::operator=

(

const BlackoilState &

other

)

Copy assignment operator. Must be defined explicitly because class contains non-value objects (the reference pointers rv_ref_ etc.) that should not simply be copied.

rv() [1/2]

std::vector< double > & Opm::BlackoilState::rv ( )

inline

rv() [2/2]

const std::vector< double > & Opm::BlackoilState::rv ( ) const

inline

surfacevol() [1/2]

std::vector< double > & Opm::BlackoilState::surfacevol ( )

inline

surfacevol() [2/2]

const std::vector< double > & Opm::BlackoilState::surfacevol ( ) const

inline

Member Data Documentation

GASOILRATIO

const std::string Opm::BlackoilState::GASOILRATIO

static

POLYMER

const std::string Opm::BlackoilState::POLYMER

static

RV

const std::string Opm::BlackoilState::RV

static

SSOL

const std::string Opm::BlackoilState::SSOL

static

SURFACEVOL

const std::string Opm::BlackoilState::SURFACEVOL

static

---

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

• BlackoilState.hpp