OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fixed/Added documentation comments.

Browse Source
This commit is contained in:
Xavier Raynaud 2012-09-05 11:45:54 +02:00
parent 5f27612b05
commit 7721defbd3
6 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
opm/polymer/CompressibleTpfaPolymer.hpp
View File

@ -40,11 +40,9 @@ namespace Opm
class PolymerBlackoilState;
class WellState;
/// Encapsulating a tpfa pressure solver for the compressible-fluid case with polymer.
/// Encapsulating a tpfa pressure solver for the compressible-fluid case with polymer.
/// Supports gravity, wells controlled by bhp or reservoir rates,
/// boundary conditions and simple sources as driving forces.
/// Rock compressibility can be included, and necessary nonlinear
/// iterations are handled.
/// Below we use the shortcuts D for the number of dimensions, N
/// for the number of cells and F for the number of faces.
class CompressibleTpfaPolymer : public CompressibleTpfa

11
opm/polymer/PolymerProperties.hpp
View File

@ -38,6 +38,17 @@ namespace Opm
enum AdsorptionBehaviour { Desorption = 1, NoDesorption = 2 };
/// Construct from parameters
/// \param[in] c_max Maximum polymer concentration used in computation of effective viscosity
/// \param[in] mix_param Mixing parameter
/// \param[in] rock_density Rock density
/// \param[in] dead_pore_vol Dead pore volume
/// \param[in] res_factor Residual resistance factor
/// \param[in] c_max_ads Maximum polymer adsorption value used in computation of the resistance factor
/// \param[in] c_vals_visc Array of concentration for effective vicosity multiplier
/// \param[in] visc_mult_vals Array of effective vicosity multiplier
/// \param[in] c_vals_ads Array of concentration for adsorption values
/// \param[in] ads_vals Array of adsorption values
PolymerProperties(double c_max,
double mix_param,
double rock_density,

3
opm/polymer/SimulatorCompressiblePolymer.hpp
View File

@ -61,6 +61,7 @@ namespace Opm
///
/// \param[in] grid grid data structure
/// \param[in] props fluid and rock properties
/// \param[in] poly_props polymer properties
/// \param[in] rock_comp if non-null, rock compressibility properties
/// \param[in] wells if non-null, wells data structure
/// \param[in] src source terms
@ -82,7 +83,7 @@ namespace Opm
/// This will run succesive timesteps until timer.done() is true. It will
/// modify the reservoir and well states.
/// \param[in,out] timer governs the requested reporting timesteps
/// \param[in,out] state state of reservoir: pressure, fluxes
/// \param[in,out] state state of reservoir: pressure, fluxes, polymer concentration
/// \param[in,out] well_state state of wells: bhp, perforation rates
/// \return simulation report, with timing data
SimulatorReport run(SimulatorTimer& timer,

1
opm/polymer/SimulatorPolymer.hpp
View File

@ -61,6 +61,7 @@ namespace Opm
///
/// \param[in] grid grid data structure
/// \param[in] props fluid and rock properties
/// \param[in] poly_props polymer properties
/// \param[in] rock_comp if non-null, rock compressibility properties
/// \param[in] wells if non-null, wells data structure
/// \param[in] src source terms

5
opm/polymer/TransportModelCompressiblePolymer.hpp
View File

@ -76,10 +76,13 @@ namespace Opm
/// \param[in] darcyflux Array of signed face fluxes.
/// \param[in] initial_pressure Array with pressure at start of timestep.
/// \param[in] pressure Array with pressure.
/// \param[in] porevolume0 Array with pore volume at start of timestep.
/// \param[in] porevolume Array with pore volume.
/// \param[in] source Transport source term.
/// \param[in] dt Time step.
/// \param[in] inflow_c Inflow polymer.
/// \param[in, out] saturation Phase saturations.
/// \param[in, out] surfacevol Surface volumes.
/// \param[in, out] concentration Polymer concentration.
/// \param[in, out] cmax Highest concentration that has occured in a given cell.
void solve(const double* darcyflux,
@ -105,9 +108,9 @@ namespace Opm
/// vertical stack, that do not interact with other columns (for
/// gravity segregation.
/// \param[in] columns Vector of cell-columns.
/// \param[in] porevolume Array of pore volumes.
/// \param[in] dt Time step.
/// \param[in, out] saturation Phase saturations.
/// \param[in, out] surfacevol Surface volumes.
/// \param[in, out] concentration Polymer concentration.
/// \param[in, out] cmax Highest concentration that has occured in a given cell.
void solveGravity(const std::vector<std::vector<int> >& columns,

2
opm/polymer/polymerUtilities.hpp
View File

@ -67,7 +67,7 @@ namespace Opm
std::vector<double>& omega);
/// @brief Computes injected and produced volumes of all phases,
/// and injeced and produced polymer mass.
/// and injected and produced polymer mass.
/// Note 1: assumes that only the first phase is injected.
/// Note 2: assumes that transport has been done with an
/// implicit method, i.e. that the current state