sequential/cellcentered/pressure.hh

Go to the documentation of this file.

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*****************************************************************************
 *   See the file COPYING for full copying permissions.                      *
 *                                                                           *
 *   This program 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.                                     *
 *                                                                           *
 *   This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.   *
 *****************************************************************************/
#ifndef DUMUX_FVPRESSURE_HH
#define DUMUX_FVPRESSURE_HH
 
// dumux environment
#include <type_traits>
#include <dumux/common/math.hh>
#include <dumux/common/exceptions.hh>
#include <dumux/porousmediumflow/sequential/pressureproperties.hh>
#include <map>
namespace Dumux
{
 
template<class TypeTag> class FVPressure
{
    //the model implementation
    using Implementation = GetPropType<TypeTag, Properties::PressureModel>;
 
    using GridView = typename GetPropType<TypeTag, Properties::GridGeometry>::GridView;
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
    using Problem = GetPropType<TypeTag, Properties::Problem>;
    using CellData = GetPropType<TypeTag, Properties::CellData>;
 
    // using declarations to abbreviate several dune classes...
    using Element = typename GridView::Traits::template Codim<0>::Entity;
    using Intersection = typename GridView::Intersection;
 
    // the typenames used for the stiffness matrix and solution vector
    using Matrix = GetPropType<TypeTag, Properties::PressureCoefficientMatrix>;
    using RHSVector = GetPropType<TypeTag, Properties::PressureRHSVector>;
    using PressureSolution = GetPropType<TypeTag, Properties::PressureSolutionVector>;
 
    using SolutionTypes = GetProp<TypeTag, Properties::SolutionTypes>;
    using PrimaryVariables = typename SolutionTypes::PrimaryVariables;
 
    using Indices = typename GetPropType<TypeTag, Properties::ModelTraits>::Indices;
 
protected:
 
    using EntryType = Dune::FieldVector<Scalar, 2>;
 
 
    enum
    {
        rhs = 1,
        matrix = 0
 
    };
 
    enum
    {
        pressEqIdx = Indices::pressureEqIdx,
    };
 
    void initializeMatrix();
    void initializeMatrixRowSize();
    void initializeMatrixIndices();
 
 
    void assemble(bool first);
 
    void solve();
 
    PressureSolution& pressure()
    {   return pressure_;}
 
    const PressureSolution& pressure() const
    {   return pressure_;}
 
    //result in better convergence of the linear solver!
    void initializePressure()
    {
        for (const auto& element : elements(problem_.gridView()))
        {
            PrimaryVariables initValues;
            problem_.initial(initValues, element);
 
            int eIdxGlobal = problem_.variables().index(element);
 
            pressure_[eIdxGlobal] = initValues[pressEqIdx];
        }
    }
 
public:
    void getSource(EntryType& entry, const Element& element, const CellData& cellData, const bool first);
 
    void getStorage(EntryType& entry, const Element& element, const CellData& cellData, const bool first);
 
    void getFlux(EntryType& entry, const Intersection& intersection, const CellData& cellData, const bool first);
 
    void getFluxOnBoundary(EntryType& entry,
            const Intersection& intersection, const CellData& cellData, const bool first);
 
    const Scalar pressure(const int eIdxGlobal) const
    {   return pressure_[eIdxGlobal];}
 
    const Matrix& globalMatrix()
    {
        return A_;
    }
 
    const RHSVector& rightHandSide()
    {
        return f_;
    }
 
    void initialize()
    {
        int size = problem_.gridView().size(0);//resize to make sure the final grid size (after the problem was completely built) is used!
        A_.setSize(size, size);
        A_.setBuildMode(Matrix::random);
        f_.resize(size);
        pressure_.resize(size);
        initializePressure();
        asImp_().initializeMatrix();// initialize sparse matrix
    }
 
    void update()
    {
        asImp_().assemble(false); Dune::dinfo << "pressure calculation"<< std::endl;
        solve();
 
        return;
    }
 
    void calculateVelocity()
    {
        DUNE_THROW(Dune::NotImplemented,"Velocity calculation not implemented in pressure model!");
    }
 
    void updateVelocity()
    {} //empty function for the case the velocity is calculated in the transport model
 
    void serializeEntity(std::ostream &outstream, const Element &element)
    {
        int eIdxGlobal = problem_.variables().index(element);
        outstream << pressure_[eIdxGlobal][0];
    }
 
    void deserializeEntity(std::istream &instream, const Element &element)
    {
        int eIdxGlobal = problem_.variables().index(element);
        instream >> pressure_[eIdxGlobal][0];
    }
 
    void setFixPressureAtIndex(Scalar pressure, int eIdxGlobal)
    {
        fixPressure_.insert(std::make_pair(eIdxGlobal, pressure));
    }
 
    void unsetFixPressureAtIndex(int eIdxGlobal)
    {
        fixPressure_.erase(eIdxGlobal);
    }
 
    void resetFixPressureAtIndex()
    {
        fixPressure_.clear();
    }
 
    FVPressure(Problem& problem) :
    problem_(problem)
    {}
 
private:
    Implementation &asImp_()
    {   return *static_cast<Implementation *>(this);}
 
    const Implementation &asImp_() const
    {   return *static_cast<const Implementation *>(this);}
 
    Problem& problem_;
 
    PressureSolution pressure_;
 
    std::string solverName_;
    std::string preconditionerName_;
protected:
    Matrix A_;
    RHSVector f_;
private:
    std::map<int, Scalar> fixPressure_;
};
 
template<class TypeTag>
void FVPressure<TypeTag>::initializeMatrix()
{
    initializeMatrixRowSize();
    A_.endrowsizes();
    initializeMatrixIndices();
    A_.endindices();
}
 
template<class TypeTag>
void FVPressure<TypeTag>::initializeMatrixRowSize()
{
    // determine matrix row sizes
    for (const auto& element : elements(problem_.gridView()))
    {
        // cell index
        int eIdxGlobalI = problem_.variables().index(element);
 
        // initialize row size
        int rowSize = 1;
 
        // run through all intersections with neighbors
        for (const auto& intersection : intersections(problem_.gridView(), element))
        {
            if (intersection.neighbor())
                rowSize++;
        }
        A_.setrowsize(eIdxGlobalI, rowSize);
    }
}
 
template<class TypeTag>
void FVPressure<TypeTag>::initializeMatrixIndices()
{
    // determine position of matrix entries
    for (const auto& element : elements(problem_.gridView()))
    {
        // cell index
        int eIdxGlobalI = problem_.variables().index(element);
 
        // add diagonal index
        A_.addindex(eIdxGlobalI, eIdxGlobalI);
 
        // run through all intersections with neighbors
        for (const auto& intersection : intersections(problem_.gridView(), element))
            if (intersection.neighbor())
            {
                // access neighbor
                int eIdxGlobalJ = problem_.variables().index(intersection.outside());
 
                // add off diagonal index
                A_.addindex(eIdxGlobalI, eIdxGlobalJ);
            }
    }
}
 
 
template<class TypeTag>
void FVPressure<TypeTag>::assemble(bool first)
{
    // initialization: set matrix A_ to zero
    A_ = 0;
    f_ = 0;
 
    for (const auto& element : elements(problem_.gridView()))
    {
        // get the global index of the cell
        int eIdxGlobalI = problem_.variables().index(element);
 
        // assemble interior element contributions
        if (element.partitionType() == Dune::InteriorEntity)
        {
            // get the cell data
            CellData& cellDataI = problem_.variables().cellData(eIdxGlobalI);
 
            EntryType entries(0.);
 
            /*****  source term ***********/
            asImp_().getSource(entries, element, cellDataI, first);
            f_[eIdxGlobalI] += entries[rhs];
 
            /*****  flux term ***********/
            // iterate over all faces of the cell
            for (const auto& intersection : intersections(problem_.gridView(), element))
            {
                /************* handle interior face *****************/
                if (intersection.neighbor())
                {
                    auto elementNeighbor = intersection.outside();
 
                    int eIdxGlobalJ = problem_.variables().index(elementNeighbor);
 
                    // check for hanging nodes
                    bool haveSameLevel = (element.level() == elementNeighbor.level());
                    // calculate only from one side (except for hanging nodes), but add matrix entries for both sides
                    // the last condition is needed to properly assemble in the presence
                    // of ghost elements
                    if (getPropValue<TypeTag, Properties::VisitFacesOnlyOnce>()
                        && (eIdxGlobalI > eIdxGlobalJ) && haveSameLevel
                        && elementNeighbor.partitionType() == Dune::InteriorEntity)
                        continue;
 
                    entries = 0;
                    asImp_().getFlux(entries, intersection, cellDataI, first);
 
                    //set right hand side
                    f_[eIdxGlobalI] -= entries[rhs];
 
                    // set diagonal entry
                    A_[eIdxGlobalI][eIdxGlobalI] += entries[matrix];
 
                    // set off-diagonal entry
                    A_[eIdxGlobalI][eIdxGlobalJ] -= entries[matrix];
 
                    // The second condition is needed to not spoil the ghost element entries
                    if (getPropValue<TypeTag, Properties::VisitFacesOnlyOnce>()
                        && elementNeighbor.partitionType() == Dune::InteriorEntity)
                    {
                        f_[eIdxGlobalJ] += entries[rhs];
                        A_[eIdxGlobalJ][eIdxGlobalJ] += entries[matrix];
                        A_[eIdxGlobalJ][eIdxGlobalI] -= entries[matrix];
                    }
 
                } // end neighbor
 
                /************* boundary face ************************/
                else
                {
                    entries = 0;
                    asImp_().getFluxOnBoundary(entries, intersection, cellDataI, first);
 
                    //set right hand side
                    f_[eIdxGlobalI] += entries[rhs];
                    // set diagonal entry
                    A_[eIdxGlobalI][eIdxGlobalI] += entries[matrix];
                }
            } //end interfaces loop
    //        printmatrix(std::cout, A_, "global stiffness matrix", "row", 11, 3);
 
            /*****  storage term ***********/
            entries = 0;
            asImp_().getStorage(entries, element, cellDataI, first);
            f_[eIdxGlobalI] += entries[rhs];
    //         set diagonal entry
            A_[eIdxGlobalI][eIdxGlobalI] += entries[matrix];
        }
        // assemble overlap and ghost element contributions
        else
        {
            A_[eIdxGlobalI] = 0.0;
            A_[eIdxGlobalI][eIdxGlobalI] = 1.0;
            f_[eIdxGlobalI] = pressure_[eIdxGlobalI];
        }
    } // end grid traversal
//    printmatrix(std::cout, A_, "global stiffness matrix after assempling", "row", 11,3);
//    printvector(std::cout, f_, "right hand side", "row", 10);
}
 
// forward declaration
template<class T>
class AMGBiCGSTABBackend;
 
namespace Detail {
template<class T> struct isParallelAMGBackend : public std::false_type {};
template<class T>
struct isParallelAMGBackend<Dumux::AMGBiCGSTABBackend<T>> : public std::true_type {};
} // end namespace Detail
 
template<class Solver, class Problem>
typename std::enable_if_t<!Detail::isParallelAMGBackend<Solver>::value, Solver>
getSolver(const Problem& problem)
{
    return Solver();
}
 
template<class Solver, class Problem>
typename std::enable_if_t<Detail::isParallelAMGBackend<Solver>::value, Solver>
getSolver(const Problem& problem)
{
    return Solver(problem.gridView(), problem.model().dofMapper());
}
 
template<class TypeTag>
void FVPressure<TypeTag>::solve()
{
    using Solver = GetPropType<TypeTag, Properties::LinearSolver>;
 
    int verboseLevelSolver = getParam<int>("LinearSolver.Verbosity", 0);
 
    if (verboseLevelSolver)
        std::cout << __FILE__ << ": solve for pressure" << std::endl;
 
    //set a fixed pressure for a certain cell
    if (fixPressure_.size() > 0)
    {
        for (auto it = fixPressure_.begin(); it != fixPressure_.end(); ++it)
        {
            A_[it->first] = 0;
            A_[it->first][it->first] = 1;
            f_[it->first] = it->second;
        }
    }
 
//    printmatrix(std::cout, A_, "global stiffness matrix", "row", 11, 3);
//    printvector(std::cout, f_, "right hand side", "row", 10, 1, 3);
 
    auto solver = getSolver<Solver>(problem_);
    bool converged = solver.solve(A_, pressure_, f_);
 
    if (!converged)
        DUNE_THROW(Dumux::NumericalProblem, "Pressure solver did not converge!");
 
//    printvector(std::cout, pressure_, "pressure", "row", 200, 1, 3);
}
 
} //end namespace Dumux
#endif