OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2024-12-28 02:00:59 -06:00
Code Issues Packages Projects Releases Wiki Activity

BlackoilPropsAdFromDeck: improve the documentation for the constructors

Browse Source
This commit is contained in:
Andreas Lauser 2015-08-31 14:04:52 +02:00
parent 0e5d8da66b
commit 9515ec6cfb
1 changed files with 42 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
opm/autodiff/BlackoilPropsAdFromDeck.hpp
View File

@ -61,7 +61,20 @@ namespace Opm
public: public:
typedef typename SaturationPropsFromDeck::MaterialLawManager MaterialLawManager; typedef typename SaturationPropsFromDeck::MaterialLawManager MaterialLawManager;
/// Constructor wrapping an opm-core black oil interface. /// Constructor to create a blackoil properties from an ECL deck.
///
/// The materialLawManager parameter represents the object from opm-material
/// which handles the creating and updating parameter objects for the capillary
/// pressure/relperm relations for each grid cell. This object is created
/// internally for the constructors below, but if it is already available
/// externally some performance can be gained by creating it only once.
///
/// \param deck The unprocessed ECL deck from opm-parser
/// \param eclState The processed ECL deck from opm-parser
/// \param materialLawManager The container for the material law parameter objects
/// \param grid The grid upon which the simulation is run on.
/// \param init_rock If true the rock properties (rock compressibility and
/// reference pressure) are read from the deck
BlackoilPropsAdFromDeck(Opm::DeckConstPtr deck, BlackoilPropsAdFromDeck(Opm::DeckConstPtr deck,
Opm::EclipseStateConstPtr eclState, Opm::EclipseStateConstPtr eclState,
std::shared_ptr<MaterialLawManager> materialLawManager, std::shared_ptr<MaterialLawManager> materialLawManager,
@ -69,7 +82,20 @@ namespace Opm
const bool init_rock = true ); const bool init_rock = true );
#ifdef HAVE_DUNE_CORNERPOINT #ifdef HAVE_DUNE_CORNERPOINT
/// Constructor wrapping an opm-core black oil interface. /// Constructor to create a blackoil properties from an ECL deck.
///
/// The materialLawManager parameter represents the object from opm-material
/// which handles the creating and updating parameter objects for the capillary
/// pressure/relperm relations for each grid cell. This object is created
/// internally for the constructors below, but if it is already available
/// externally some performance can be gained by creating it only once.
///
/// \param deck The unprocessed ECL deck from opm-parser
/// \param eclState The processed ECL deck from opm-parser
/// \param materialLawManager The container for the material law parameter objects
/// \param grid The grid upon which the simulation is run on.
/// \param init_rock If true the rock properties (rock compressibility and
/// reference pressure) are read from the deck
BlackoilPropsAdFromDeck(Opm::DeckConstPtr deck, BlackoilPropsAdFromDeck(Opm::DeckConstPtr deck,
Opm::EclipseStateConstPtr eclState, Opm::EclipseStateConstPtr eclState,
std::shared_ptr<MaterialLawManager> materialLawManager, std::shared_ptr<MaterialLawManager> materialLawManager,
@ -77,14 +103,26 @@ namespace Opm
const bool init_rock = true ); const bool init_rock = true );
#endif #endif
/// Constructor wrapping an opm-core black oil interface. /// Constructor to create a blackoil properties from an ECL deck.
///
/// \param deck The unprocessed ECL deck from opm-parser
/// \param eclState The processed ECL deck from opm-parser
/// \param grid The grid upon which the simulation is run on.
/// \param init_rock If true the rock properties (rock compressibility and
/// reference pressure) are read from the deck
BlackoilPropsAdFromDeck(Opm::DeckConstPtr deck, BlackoilPropsAdFromDeck(Opm::DeckConstPtr deck,
Opm::EclipseStateConstPtr eclState, Opm::EclipseStateConstPtr eclState,
const UnstructuredGrid& grid, const UnstructuredGrid& grid,
const bool init_rock = true ); const bool init_rock = true );
#ifdef HAVE_DUNE_CORNERPOINT #ifdef HAVE_DUNE_CORNERPOINT
/// Constructor wrapping an opm-core black oil interface. /// Constructor to create a blackoil properties from an ECL deck.
///
/// \param deck The unprocessed ECL deck from opm-parser
/// \param eclState The processed ECL deck from opm-parser
/// \param grid The grid upon which the simulation is run on.
/// \param init_rock If true the rock properties (rock compressibility and
/// reference pressure) are read from the deck
BlackoilPropsAdFromDeck(Opm::DeckConstPtr deck, BlackoilPropsAdFromDeck(Opm::DeckConstPtr deck,
Opm::EclipseStateConstPtr eclState, Opm::EclipseStateConstPtr eclState,
const Dune::CpGrid& grid, const Dune::CpGrid& grid,