OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2024-12-01 13:29:08 -06:00
Code Issues Packages Projects Releases Wiki Activity
ebb1da0662
opm-simulators/opm/autodiff/BlackoilPropsAdInterface.hpp

329 lines
15 KiB
C++
Raw Normal View History

Added abstract class BlackoilPropsAdInterface. Also made BlackoilPropsAd (the class wrapping opm-core BlackoilPropertiesInterface) inherit from it.
2013-05-22 03:56:14 -05:00
/*
Copyright 2013 SINTEF ICT, Applied Mathematics.
This file is part of the Open Porous Media project (OPM).
OPM is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OPM is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with OPM. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef OPM_BLACKOILPROPSADINTERFACE_HEADER_INCLUDED
#define OPM_BLACKOILPROPSADINTERFACE_HEADER_INCLUDED
#include <opm/autodiff/AutoDiffBlock.hpp>
#include <opm/core/props/BlackoilPhases.hpp>
namespace Opm
{
/// This class is intended to present a fluid interface for
/// three-phase black-oil that is easy to use with the AD-using
/// simulators.
///
/// Most methods are available in two overloaded versions, one
/// taking a constant vector and returning the same, and one
/// taking an AD type and returning the same. Derivatives are not
/// returned separately by any method, only implicitly with the AD
/// version of the methods.
class BlackoilPropsAdInterface
{
public:
/// Virtual destructor for inheritance.
virtual ~BlackoilPropsAdInterface();
////////////////////////////
// Rock interface //
////////////////////////////
/// \return D, the number of spatial dimensions.
virtual int numDimensions() const = 0;
/// \return N, the number of cells.
virtual int numCells() const = 0;
/// \return Array of N porosity values.
virtual const double* porosity() const = 0;
/// \return Array of ND^2 permeability values.
/// The D^2 permeability values for a cell are organized as a matrix,
/// which is symmetric (so ordering does not matter).
virtual const double* permeability() const = 0;
////////////////////////////
// Fluid interface //
////////////////////////////
Rename AutoDiff::ForwardBlock -> Opm::AutoDiffBlock. Also moved AutoDiffHelpers.hpp content to Opm namespace, and modified other files as required by these two changes.
2013-09-19 05:53:28 -05:00
typedef AutoDiffBlock<double> ADB;
Added abstract class BlackoilPropsAdInterface. Also made BlackoilPropsAd (the class wrapping opm-core BlackoilPropertiesInterface) inherit from it.
2013-05-22 03:56:14 -05:00
typedef ADB::V V;
typedef ADB::M M;
typedef std::vector<int> Cells;
Expose PhaseUsage to clients This is likely to be a hack, but it does facilitate creating the fully implicit solver for arbitrary two- and three-phase fluid systems.
2013-05-23 11:26:25 -05:00
/// \return Number of active phases (also the number of components).
virtual int numPhases() const = 0;
/// \return Object describing the active phases.
virtual PhaseUsage phaseUsage() const = 0;
Added abstract class BlackoilPropsAdInterface. Also made BlackoilPropsAd (the class wrapping opm-core BlackoilPropertiesInterface) inherit from it.
2013-05-22 03:56:14 -05:00
// ------ Canonical named indices for each phase ------
/// Canonical named indices for each phase.
enum PhaseIndex { Water = 0, Oil = 1, Gas = 2 };
// ------ Density ------
/// Densities of stock components at surface conditions.
/// \return Array of 3 density values.
virtual const double* surfaceDensity() const = 0;
// ------ Viscosity ------
/// Water viscosity.
/// \param[in] pw Array of n water pressure values.
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n viscosity values.
virtual
V muWat(const V& pw,
const Cells& cells) const = 0;
/// Oil viscosity.
/// \param[in] po Array of n oil pressure values.
/// \param[in] rs Array of n gas solution factor values.
make the phase-presence docstring understandable for mere mortals
2013-12-04 05:08:46 -06:00
/// \param[in] cond Array of n objects, each specifying which phases are present with non-zero saturation in a cell.
Added abstract class BlackoilPropsAdInterface. Also made BlackoilPropsAd (the class wrapping opm-core BlackoilPropertiesInterface) inherit from it.
2013-05-22 03:56:14 -05:00
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n viscosity values.
virtual
V muOil(const V& po,
const V& rs,
Switch condition interface to phase presence facility Commit 4aa0eaf introduced density and viscosity evaluators into the BlackoilPropsAdInterface that accepted an externally assignable condition to distinguish saturated from unsaturated cases. As a result of a few low-level technical problems with that approach, this commit changes those affected interfaces to use the black-oil specific 'PhasePresence' facility of opm-core's commit a033329. Update callers accordingly.
2013-12-03 11:12:54 -06:00
const std::vector<PhasePresence>& cond,
Added abstract class BlackoilPropsAdInterface. Also made BlackoilPropsAd (the class wrapping opm-core BlackoilPropertiesInterface) inherit from it.
2013-05-22 03:56:14 -05:00
const Cells& cells) const = 0;
/// Gas viscosity.
/// \param[in] pg Array of n gas pressure values.
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n viscosity values.
virtual
V muGas(const V& pg,
const Cells& cells) const = 0;
/// Water viscosity.
/// \param[in] pw Array of n water pressure values.
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n viscosity values.
virtual
ADB muWat(const ADB& pw,
const Cells& cells) const = 0;
/// Oil viscosity.
/// \param[in] po Array of n oil pressure values.
/// \param[in] rs Array of n gas solution factor values.
make the phase-presence docstring understandable for mere mortals
2013-12-04 05:08:46 -06:00
/// \param[in] cond Array of n objects, each specifying which phases are present with non-zero saturation in a cell.
Added abstract class BlackoilPropsAdInterface. Also made BlackoilPropsAd (the class wrapping opm-core BlackoilPropertiesInterface) inherit from it.
2013-05-22 03:56:14 -05:00
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n viscosity values.
virtual
ADB muOil(const ADB& po,
const ADB& rs,
Switch condition interface to phase presence facility Commit 4aa0eaf introduced density and viscosity evaluators into the BlackoilPropsAdInterface that accepted an externally assignable condition to distinguish saturated from unsaturated cases. As a result of a few low-level technical problems with that approach, this commit changes those affected interfaces to use the black-oil specific 'PhasePresence' facility of opm-core's commit a033329. Update callers accordingly.
2013-12-03 11:12:54 -06:00
const std::vector<PhasePresence>& cond,
Added abstract class BlackoilPropsAdInterface. Also made BlackoilPropsAd (the class wrapping opm-core BlackoilPropertiesInterface) inherit from it.
2013-05-22 03:56:14 -05:00
const Cells& cells) const = 0;
/// Gas viscosity.
/// \param[in] pg Array of n gas pressure values.
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n viscosity values.
virtual
ADB muGas(const ADB& pg,
const Cells& cells) const = 0;
Implementation of live gas The simulator now handles live gas as well as live oil. The primary variables are Po,Sw and Rs,Rv or Sg depending on fluid condition State 1 Gas only (Undersaturated gas): Po, Sw and Rv State 2 Gas and oil: Po, Sw and Sg State 3 Oil only (Undersaturated oil): Po, Sw and Rs This commit includes: 1. New interfaces for the vapor oil/gas ratios (Rv) 2. Modifications in the equations to handle rvs 3. New definition of ADI variable to handle changing primary variables 4. Modifications in the solution updates to handle changing primary variable 5. Some changes in the appleyard process to sync with Mrsts livegas implementation. NOTE: The implementation is tested on the liveoil cases SPE1 and a simplified SPE9 and produces the same results as the old code. The simulator is not yet able to converge on SPE3 with livegas present. For SPE3 to converge a more robust well implementation is needed. The current simulator reproduce the results of Mrst when a similar well model is used in Mrst as is currently implemented OPM.
2014-01-10 07:19:37 -06:00
/// Gas viscosity.
/// \param[in] pg Array of n gas pressure values.
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n viscosity values.
virtual
ADB muGas(const ADB& pg,
const ADB& rv,
const std::vector<PhasePresence>& cond,
const Cells& cells) const = 0;
Added abstract class BlackoilPropsAdInterface. Also made BlackoilPropsAd (the class wrapping opm-core BlackoilPropertiesInterface) inherit from it.
2013-05-22 03:56:14 -05:00
// ------ Formation volume factor (b) ------
/// Water formation volume factor.
/// \param[in] pw Array of n water pressure values.
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n formation volume factor values.
virtual
V bWat(const V& pw,
const Cells& cells) const = 0;
/// Oil formation volume factor.
/// \param[in] po Array of n oil pressure values.
/// \param[in] rs Array of n gas solution factor values.
make the phase-presence docstring understandable for mere mortals
2013-12-04 05:08:46 -06:00
/// \param[in] cond Array of n objects, each specifying which phases are present with non-zero saturation in a cell.
Added abstract class BlackoilPropsAdInterface. Also made BlackoilPropsAd (the class wrapping opm-core BlackoilPropertiesInterface) inherit from it.
2013-05-22 03:56:14 -05:00
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n formation volume factor values.
virtual
V bOil(const V& po,
const V& rs,
Switch condition interface to phase presence facility Commit 4aa0eaf introduced density and viscosity evaluators into the BlackoilPropsAdInterface that accepted an externally assignable condition to distinguish saturated from unsaturated cases. As a result of a few low-level technical problems with that approach, this commit changes those affected interfaces to use the black-oil specific 'PhasePresence' facility of opm-core's commit a033329. Update callers accordingly.
2013-12-03 11:12:54 -06:00
const std::vector<PhasePresence>& cond,
Added abstract class BlackoilPropsAdInterface. Also made BlackoilPropsAd (the class wrapping opm-core BlackoilPropertiesInterface) inherit from it.
2013-05-22 03:56:14 -05:00
const Cells& cells) const = 0;
/// Gas formation volume factor.
/// \param[in] pg Array of n gas pressure values.
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n formation volume factor values.
virtual
V bGas(const V& pg,
const Cells& cells) const = 0;
Add interface for wet gas The pvt interface is extened to handle wet gas 1. A function for rvSat is added to the interface 2. An interface that takes rv and the fluid condition as an input for the gas properties is added. The old interface without rv and the fluid condition is kept in the file. 3. The new interface is implemented in BlackoilPropsAd and BlackoilPropsAdFromDeck. A simulator that tests wet gas is not yet implemented.
2013-12-13 10:01:43 -06:00
/// Gas formation volume factor.
/// \param[in] pg Array of n gas pressure values.
/// \param[in] rv Array of n vapor oil/gas ratio
/// \param[in] cond Array of n objects, each specifying which phases are present with non-zero saturation in a cell.
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n formation volume factor values.
virtual
V bGas(const V& pg,
const V& rv,
const std::vector<PhasePresence>& cond,
const Cells& cells) const = 0;
Added abstract class BlackoilPropsAdInterface. Also made BlackoilPropsAd (the class wrapping opm-core BlackoilPropertiesInterface) inherit from it.
2013-05-22 03:56:14 -05:00
/// Water formation volume factor.
/// \param[in] pw Array of n water pressure values.
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n formation volume factor values.
virtual
ADB bWat(const ADB& pw,
const Cells& cells) const = 0;
/// Oil formation volume factor.
/// \param[in] po Array of n oil pressure values.
/// \param[in] rs Array of n gas solution factor values.
make the phase-presence docstring understandable for mere mortals
2013-12-04 05:08:46 -06:00
/// \param[in] cond Array of n objects, each specifying which phases are present with non-zero saturation in a cell.
Added abstract class BlackoilPropsAdInterface. Also made BlackoilPropsAd (the class wrapping opm-core BlackoilPropertiesInterface) inherit from it.
2013-05-22 03:56:14 -05:00
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n formation volume factor values.
virtual
ADB bOil(const ADB& po,
const ADB& rs,
Switch condition interface to phase presence facility Commit 4aa0eaf introduced density and viscosity evaluators into the BlackoilPropsAdInterface that accepted an externally assignable condition to distinguish saturated from unsaturated cases. As a result of a few low-level technical problems with that approach, this commit changes those affected interfaces to use the black-oil specific 'PhasePresence' facility of opm-core's commit a033329. Update callers accordingly.
2013-12-03 11:12:54 -06:00
const std::vector<PhasePresence>& cond,
Added abstract class BlackoilPropsAdInterface. Also made BlackoilPropsAd (the class wrapping opm-core BlackoilPropertiesInterface) inherit from it.
2013-05-22 03:56:14 -05:00
const Cells& cells) const = 0;
/// Gas formation volume factor.
/// \param[in] pg Array of n gas pressure values.
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n formation volume factor values.
virtual
ADB bGas(const ADB& pg,
const Cells& cells) const = 0;
Add interface for wet gas The pvt interface is extened to handle wet gas 1. A function for rvSat is added to the interface 2. An interface that takes rv and the fluid condition as an input for the gas properties is added. The old interface without rv and the fluid condition is kept in the file. 3. The new interface is implemented in BlackoilPropsAd and BlackoilPropsAdFromDeck. A simulator that tests wet gas is not yet implemented.
2013-12-13 10:01:43 -06:00
/// Gas formation volume factor.
/// \param[in] pg Array of n gas pressure values.
/// \param[in] rv Array of n vapor oil/gas ratio
/// \param[in] cond Array of n objects, each specifying which phases are present with non-zero saturation in a cell.
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n formation volume factor values.
virtual
ADB bGas(const ADB& pg,
const ADB& rv,
const std::vector<PhasePresence>& cond,
const Cells& cells) const = 0;
// ------ Rs bubble point curve ------
/// Bubble point curve for Rs as function of oil pressure.
/// \param[in] po Array of n oil pressure values.
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n bubble point values for Rs.
virtual
V rsSat(const V& po,
const Cells& cells) const = 0;
/// Bubble point curve for Rs as function of oil pressure.
/// \param[in] po Array of n oil pressure values.
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n bubble point values for Rs.
virtual
ADB rsSat(const ADB& po,
const Cells& cells) const = 0;
Added abstract class BlackoilPropsAdInterface. Also made BlackoilPropsAd (the class wrapping opm-core BlackoilPropertiesInterface) inherit from it.
2013-05-22 03:56:14 -05:00
// ------ Rs bubble point curve ------
New interface methods rsMax() in BlackoilPropsAdInterface. Notes: - Interface was already present, just disabled. - Class BlackoilPropsAd cannot properly implement rsMax() with derivatives, and implements only a throw statement.
2013-05-27 03:26:41 -05:00
Added abstract class BlackoilPropsAdInterface. Also made BlackoilPropsAd (the class wrapping opm-core BlackoilPropertiesInterface) inherit from it.
2013-05-22 03:56:14 -05:00
/// Bubble point curve for Rs as function of oil pressure.
/// \param[in] po Array of n oil pressure values.
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n bubble point values for Rs.
virtual
Add interface for wet gas The pvt interface is extened to handle wet gas 1. A function for rvSat is added to the interface 2. An interface that takes rv and the fluid condition as an input for the gas properties is added. The old interface without rv and the fluid condition is kept in the file. 3. The new interface is implemented in BlackoilPropsAd and BlackoilPropsAdFromDeck. A simulator that tests wet gas is not yet implemented.
2013-12-13 10:01:43 -06:00
V rvSat(const V& po,
Added abstract class BlackoilPropsAdInterface. Also made BlackoilPropsAd (the class wrapping opm-core BlackoilPropertiesInterface) inherit from it.
2013-05-22 03:56:14 -05:00
const Cells& cells) const = 0;
/// Bubble point curve for Rs as function of oil pressure.
/// \param[in] po Array of n oil pressure values.
/// \param[in] cells Array of n cell indices to be associated with the pressure values.
/// \return Array of n bubble point values for Rs.
virtual
Add interface for wet gas The pvt interface is extened to handle wet gas 1. A function for rvSat is added to the interface 2. An interface that takes rv and the fluid condition as an input for the gas properties is added. The old interface without rv and the fluid condition is kept in the file. 3. The new interface is implemented in BlackoilPropsAd and BlackoilPropsAdFromDeck. A simulator that tests wet gas is not yet implemented.
2013-12-13 10:01:43 -06:00
ADB rvSat(const ADB& po,
Added abstract class BlackoilPropsAdInterface. Also made BlackoilPropsAd (the class wrapping opm-core BlackoilPropertiesInterface) inherit from it.
2013-05-22 03:56:14 -05:00
const Cells& cells) const = 0;
// ------ Relative permeability ------
/// Relative permeabilities for all phases.
/// \param[in] sw Array of n water saturation values.
/// \param[in] so Array of n oil saturation values.
/// \param[in] sg Array of n gas saturation values.
/// \param[in] cells Array of n cell indices to be associated with the saturation values.
/// \return An std::vector with 3 elements, each an array of n relperm values,
/// containing krw, kro, krg. Use PhaseIndex for indexing into the result.
virtual
std::vector<V> relperm(const V& sw,
const V& so,
const V& sg,
const Cells& cells) const = 0;
/// Relative permeabilities for all phases.
/// \param[in] sw Array of n water saturation values.
/// \param[in] so Array of n oil saturation values.
/// \param[in] sg Array of n gas saturation values.
/// \param[in] cells Array of n cell indices to be associated with the saturation values.
/// \return An std::vector with 3 elements, each an array of n relperm values,
/// containing krw, kro, krg. Use PhaseIndex for indexing into the result.
virtual
std::vector<ADB> relperm(const ADB& sw,
const ADB& so,
const ADB& sg,
const Cells& cells) const = 0;
include capillary pressure in the PDEs I'm neither sure that this is fully correct nor that I found all occurences (so far, the output writing code is missing in this patch), but it seems to work for SPE1...
2013-11-26 06:51:10 -06:00
/// Capillary pressure for all phases.
/// \param[in] sw Array of n water saturation values.
/// \param[in] so Array of n oil saturation values.
/// \param[in] sg Array of n gas saturation values.
/// \param[in] cells Array of n cell indices to be associated with the saturation values.
/// \return An std::vector with 3 elements, each an array of n capillary pressure values,
/// containing the offsets for each p_g, p_o, p_w. The capillary pressure between
/// two arbitrary phases alpha and beta is then given as p_alpha - p_beta.
virtual
std::vector<ADB> capPress(const ADB& sw,
const ADB& so,
const ADB& sg,
const Cells& cells) const = 0;
Hysteresis. SimulatorFullyImplicitBlackoil reports saturation values at each completed time-step, allowing detection of hysteris behavior.
2014-02-18 07:50:29 -06:00
/// Saturation update for hysteresis behavior.
/// \param[in] cells Array of n cell indices to be associated with the saturation values.
virtual
void updateSatHyst(const std::vector<double>& saturation,
Make BlackoilPropsAdInterface pure virtual again. Done by adding (throwing) implementation to BlackoilPropsAd class.
2014-03-04 06:09:23 -06:00
const std::vector<int>& cells) = 0;
Added abstract class BlackoilPropsAdInterface. Also made BlackoilPropsAd (the class wrapping opm-core BlackoilPropertiesInterface) inherit from it.
2013-05-22 03:56:14 -05:00
};
} // namespace Opm
#endif // OPM_BLACKOILPROPSADINTERFACE_HEADER_INCLUDED
Reference in New Issue Copy Permalink