TofDiscGalReorder.hpp

Go to the documentation of this file.

/*
  Copyright 2012 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_TOFDISCGALREORDER_HEADER_INCLUDED
#define OPM_TOFDISCGALREORDER_HEADER_INCLUDED

#include <opm/core/transport/reorder/ReorderSolverInterface.hpp>
#include <memory>
#include <vector>
#include <map>
#include <ostream>

struct UnstructuredGrid;

namespace Opm
{

    class IncompPropertiesInterface;
    class VelocityInterpolationInterface;
    class DGBasisInterface;
    namespace parameter { class ParameterGroup; }
    template <typename T> class SparseTable;

    class TofDiscGalReorder : public ReorderSolverInterface
    {
    public:
        TofDiscGalReorder(const UnstructuredGrid& grid,
                          const parameter::ParameterGroup& param);


        void solveTof(const double* darcyflux,
                      const double* porevolume,
                      const double* source,
                      std::vector<double>& tof_coeff);

        void solveTofTracer(const double* darcyflux,
                            const double* porevolume,
                            const double* source,
                            const SparseTable<int>& tracerheads,
                            std::vector<double>& tof_coeff,
                            std::vector<double>& tracer_coeff);

    private:
        virtual void solveSingleCell(const int cell);
        virtual void solveMultiCell(const int num_cells, const int* cells);

        void cellContribs(const int cell);
        void faceContribs(const int cell);
        void solveLinearSystem(const int cell);

    private:
        // Disable copying and assignment.
        TofDiscGalReorder(const TofDiscGalReorder&);
        TofDiscGalReorder& operator=(const TofDiscGalReorder&);

        // Data members
        const UnstructuredGrid& grid_;
        std::shared_ptr<VelocityInterpolationInterface> velocity_interpolation_;
        bool use_cvi_;
        bool use_limiter_;
        double limiter_relative_flux_threshold_;
        enum LimiterMethod { MinUpwindFace, MinUpwindAverage };
        LimiterMethod limiter_method_;
        enum LimiterUsage { DuringComputations, AsPostProcess, AsSimultaneousPostProcess };
        LimiterUsage limiter_usage_;
        const double* darcyflux_;   // one flux per grid face
        const double* porevolume_;  // one volume per cell
        const double* source_;      // one volumetric source term per cell
        std::shared_ptr<DGBasisInterface> basis_func_;
        double* tof_coeff_;
        // For tracers.
        double* tracer_coeff_;
        int num_tracers_;
        enum { NoTracerHead = -1 };
        std::vector<int> tracerhead_by_cell_;
        bool tracers_ensure_unity_;
        // Used by solveSingleCell().
        std::vector<double> rhs_;   // single-cell right-hand-sides
        std::vector<double> jac_;   // single-cell jacobian
        std::vector<double> orig_rhs_;   // single-cell right-hand-sides (copy)
        std::vector<double> orig_jac_;   // single-cell jacobian (copy)
        std::vector<double> coord_;
        mutable std::vector<double> basis_;
        mutable std::vector<double> basis_nb_;
        std::vector<double> grad_basis_;
        std::vector<double> velocity_;
        int num_singlesolves_;
        // Used by solveMultiCell():
        double gauss_seidel_tol_;
        int num_multicell_;
        int max_size_multicell_;
        int max_iter_multicell_;

        // Private methods

        // Apply some limiter, writing to array tof
        // (will read data from tof_coeff_, it is ok to call
        //  with tof_coeff as tof argument.
        void applyLimiter(const int cell, double* tof);
        void applyMinUpwindLimiter(const int cell, const bool face_min, double* tof);
        void applyLimiterAsPostProcess();
        void applyLimiterAsSimultaneousPostProcess();
        double totalFlux(const int cell) const;
        double minCornerVal(const int cell, const int face) const;

        // Apply a simple (restrict to [0,1]) limiter.
        // Intended for tracers.
        void applyTracerLimiter(const int cell, double* local_coeff);
    };

} // namespace Opm

#endif // OPM_TRANSPORTMODELTRACERTOFDISCGAL_HEADER_INCLUDED