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)
 Main constructor setting the sizes for the contained data types. More...
 
 BlackoilState (const BlackoilState &other)
 Copy constructor. More...
 
BlackoilStateoperator= (const BlackoilState &other)
 Copy assignment operator. More...
 
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 = "GASOILRATIO"
 
static const std::string RV = "RV"
 
static const std::string SURFACEVOL = "SURFACEVOL"
 
static const std::string SSOL = "SSOL"
 
static const std::string POLYMER = "POLYMER"
 

Detailed Description

Simulator state for a blackoil simulator.

Constructor & Destructor Documentation

◆ BlackoilState() [1/2]

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_cellsnumber of elements in cell data vectors
num_facesnumber of elements in face data vectors
num_phasesnumber 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]

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

◆ operator=()

BlackoilState & 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.


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