add: MultisegmentWellEquations

this is a container for the multisegment well equation system

opm/simulators/wells/MultisegmentWellEquations.hpp

@@ -0,0 +1,80 @@
+/*
+  Copyright 2017 SINTEF Digital, Mathematics and Cybernetics.
+  Copyright 2017 Statoil ASA.
+  Copyright 2016 - 2017 IRIS AS.
+
+  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_MULTISEGMENTWELL_EQUATIONS_HEADER_INCLUDED
+#define OPM_MULTISEGMENTWELL_EQUATIONS_HEADER_INCLUDED
+
+#include <dune/common/fmatrix.hh>
+#include <dune/common/fvector.hh>
+#include <dune/istl/bcrsmatrix.hh>
+#include <dune/istl/bvector.hh>
+
+#include <memory>
+
+namespace Dune {
+template<class M> class UMFPack;
+}
+
+namespace Opm
+{
+
+template<class Scalar, int numWellEq, int numEq>
+class MultisegmentWellEquations
+{
+public:
+    // sparsity pattern for the matrices
+    // [A C^T    [x       =  [ res
+    //  B  D ]   x_well]      res_well]
+
+    // the vector type for the res_well and x_well
+    using VectorBlockWellType = Dune::FieldVector<Scalar,numWellEq>;
+    using BVectorWell = Dune::BlockVector<VectorBlockWellType>;
+
+    using VectorBlockType = Dune::FieldVector<Scalar,numEq>;
+    using BVector = Dune::BlockVector<VectorBlockType>;
+
+    // the matrix type for the diagonal matrix D
+    using DiagMatrixBlockWellType = Dune::FieldMatrix<Scalar,numWellEq,numWellEq>;
+    using DiagMatWell = Dune::BCRSMatrix<DiagMatrixBlockWellType>;
+
+    // the matrix type for the non-diagonal matrix B and C^T
+    using OffDiagMatrixBlockWellType = Dune::FieldMatrix<Scalar,numWellEq,numEq>;
+    using OffDiagMatWell = Dune::BCRSMatrix<OffDiagMatrixBlockWellType>;
+
+    // TODO, the following should go to a class for computing purpose
+    // two off-diagonal matrices
+    OffDiagMatWell duneB_;
+    OffDiagMatWell duneC_;
+    // "diagonal" matrix for the well. It has offdiagonal entries for inlets and outlets.
+    DiagMatWell duneD_;
+
+    /// \brief solver for diagonal matrix
+    ///
+    /// This is a shared_ptr as MultisegmentWell is copied in computeWellPotentials...
+    mutable std::shared_ptr<Dune::UMFPack<DiagMatWell> > duneDSolver_;
+
+    // residuals of the well equations
+    BVectorWell resWell_;
+};
+
+}
+
+#endif // OPM_MULTISEGMENTWELLWELL_EQUATIONS_HEADER_INCLUDED