SimulatorPolymer.hpp
Go to the documentation of this file.
1 /*
2  Copyright 2012 SINTEF ICT, Applied Mathematics.
3 
4  This file is part of the Open Porous Media project (OPM).
5 
6  OPM is free software: you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  OPM is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with OPM. If not, see <http://www.gnu.org/licenses/>.
18 */
19 
20 #ifndef OPM_SIMULATORPOLYMER_HEADER_INCLUDED
21 #define OPM_SIMULATORPOLYMER_HEADER_INCLUDED
22 
23 #include <boost/shared_ptr.hpp>
24 #include <vector>
25 
26 struct UnstructuredGrid;
27 struct Wells;
28 struct FlowBoundaryConditions;
29 
30 namespace Opm
31 {
32  namespace parameter { class ParameterGroup; }
33  class IncompPropertiesInterface;
34  class PolymerProperties;
35  class RockCompressibility;
36  class WellsManager;
37  class PolymerInflowInterface;
38  class LinearSolverInterface;
39  class SimulatorTimer;
40  class PolymerState;
41  class WellState;
42  struct SimulatorReport;
43 
46  {
47  public:
74  SimulatorPolymer(const parameter::ParameterGroup& param,
75  const UnstructuredGrid& grid,
76  const IncompPropertiesInterface& props,
77  const PolymerProperties& poly_props,
78  const RockCompressibility* rock_comp_props,
79  WellsManager& wells_manager,
80  const PolymerInflowInterface& polymer_inflow,
81  const std::vector<double>& src,
82  const FlowBoundaryConditions* bcs,
83  LinearSolverInterface& linsolver,
84  const double* gravity);
85 
94  SimulatorReport run(SimulatorTimer& timer,
95  PolymerState& state,
96  WellState& well_state);
97 
98  private:
99  class Impl;
100  // Using shared_ptr instead of scoped_ptr since scoped_ptr requires complete type for Impl.
101  boost::shared_ptr<Impl> pimpl_;
102  };
103 
104 } // namespace Opm
105 
106 #endif // OPM_SIMULATORPOLYMER_HEADER_INCLUDED
Definition: CompressibleTpfaPolymer.hpp:32
Class collecting all necessary components for a two-phase simulation.
Definition: SimulatorPolymer.hpp:45
Simulator state for a two-phase simulator with polymer.
Definition: PolymerState.hpp:32
SimulatorReport run(SimulatorTimer &timer, PolymerState &state, WellState &well_state)
Definition: PolymerProperties.hpp:34
Interface for classes encapsulating polymer inflow information.
Definition: PolymerInflow.hpp:38
SimulatorPolymer(const parameter::ParameterGroup &param, const UnstructuredGrid &grid, const IncompPropertiesInterface &props, const PolymerProperties &poly_props, const RockCompressibility *rock_comp_props, WellsManager &wells_manager, const PolymerInflowInterface &polymer_inflow, const std::vector< double > &src, const FlowBoundaryConditions *bcs, LinearSolverInterface &linsolver, const double *gravity)