assembly/fvassembler.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:
//
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_FV_ASSEMBLER_HH
#define DUMUX_FV_ASSEMBLER_HH
 
#include <algorithm>
#include <vector>
#include <deque>
#include <type_traits>
#include <memory>
 
#include <dune/istl/matrixindexset.hh>
 
#include <dumux/common/properties.hh>
#include <dumux/common/timeloop.hh>
#include <dumux/common/gridcapabilities.hh>
#include <dumux/common/typetraits/vector.hh>
#include <dumux/common/typetraits/periodic.hh>
 
#include <dumux/discretization/method.hh>
#include <dumux/linear/parallelhelpers.hh>
#include <dumux/linear/dunevectors.hh>
 
#include <dumux/assembly/coloring.hh>
#include <dumux/assembly/jacobianpattern.hh>
#include <dumux/assembly/diffmethod.hh>
 
#include <dumux/parallel/multithreading.hh>
#include <dumux/parallel/parallel_for.hh>
 
#include "cvfelocalassembler.hh"
#include "cclocalassembler.hh"
#include "fclocalassembler.hh"
 
#include <dumux/common/deprecated.hh>
 
namespace Dumux::Detail {
 
template<class DiscretizationMethod>
struct LocalAssemblerChooser;
 
template<class DM>
struct LocalAssemblerChooser<DiscretizationMethods::CVFE<DM>>
{
    template<class TypeTag, class Impl, DiffMethod diffMethod, bool isImplicit>
    using type = CVFELocalAssembler<TypeTag, Impl, diffMethod, isImplicit>;
};
 
template<>
struct LocalAssemblerChooser<DiscretizationMethods::CCMpfa>
{
    template<class TypeTag, class Impl, DiffMethod diffMethod, bool isImplicit>
    using type = CCLocalAssembler<TypeTag, Impl, diffMethod, isImplicit>;
};
 
template<>
struct LocalAssemblerChooser<DiscretizationMethods::CCTpfa>
{
    template<class TypeTag, class Impl, DiffMethod diffMethod, bool isImplicit>
    using type = CCLocalAssembler<TypeTag, Impl, diffMethod, isImplicit>;
};
 
template<>
struct LocalAssemblerChooser<DiscretizationMethods::FCStaggered>
{
    template<class TypeTag, class Impl, DiffMethod diffMethod, bool isImplicit>
    using type = FaceCenteredLocalAssembler<TypeTag, Impl, diffMethod, isImplicit>;
};
 
template<class TypeTag, class Impl, DiffMethod diffMethod, bool isImplicit>
using LocalAssemblerChooser_t = typename LocalAssemblerChooser<
    typename GetPropType<TypeTag, Properties::GridGeometry>::DiscretizationMethod
>::template type<TypeTag, Impl, diffMethod, isImplicit>;

template<class P>
using ProblemConstraintsDetector = decltype(std::declval<P>().constraints());
 
template<class P>
constexpr inline bool hasGlobalConstraints()
{ return Dune::Std::is_detected<ProblemConstraintsDetector, P>::value; }
 
} // end namespace Dumux::Detail
 
namespace Dumux {

template<class TypeTag, DiffMethod diffMethod, bool isImplicit = true, class LocalResidual = GetPropType<TypeTag, Properties::LocalResidual>>
class FVAssembler
{
    using GridGeo = GetPropType<TypeTag, Properties::GridGeometry>;
    using GridView = typename GridGeo::GridView;
    using Element = typename GridView::template Codim<0>::Entity;
    using ElementSeed = typename GridView::Grid::template Codim<0>::EntitySeed;
    using TimeLoop = TimeLoopBase<GetPropType<TypeTag, Properties::Scalar>>;
 
    static constexpr bool isBox = GridGeo::discMethod == DiscretizationMethods::box;
 
    using ThisType = FVAssembler<TypeTag, diffMethod, isImplicit, LocalResidual>;
    using LocalAssembler = typename Detail::LocalAssemblerChooser_t<TypeTag, ThisType, diffMethod, isImplicit>;
 
public:
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
    using JacobianMatrix = GetPropType<TypeTag, Properties::JacobianMatrix>;
    using SolutionVector = GetPropType<TypeTag, Properties::SolutionVector>;
    using ResidualType = typename Detail::NativeDuneVectorType<SolutionVector>::type;
 
    using GridVariables = GetPropType<TypeTag, Properties::GridVariables>;
 
    using GridGeometry = GridGeo;
    using Problem = GetPropType<TypeTag, Properties::Problem>;

    FVAssembler(std::shared_ptr<const Problem> problem,
                std::shared_ptr<const GridGeometry> gridGeometry,
                std::shared_ptr<GridVariables> gridVariables)
    : problem_(problem)
    , gridGeometry_(gridGeometry)
    , gridVariables_(gridVariables)
    , timeLoop_()
    , isStationaryProblem_(true)
    {
        static_assert(isImplicit, "Explicit assembler for stationary problem doesn't make sense!");
        enableMultithreading_ = SupportsColoring<typename GridGeometry::DiscretizationMethod>::value
            && Grid::Capabilities::supportsMultithreading(gridGeometry_->gridView())
            && !Multithreading::isSerial()
            && getParam<bool>("Assembly.Multithreading", true);
 
        maybeComputeColors_();
    }

    FVAssembler(std::shared_ptr<const Problem> problem,
                std::shared_ptr<const GridGeometry> gridGeometry,
                std::shared_ptr<GridVariables> gridVariables,
                std::shared_ptr<const TimeLoop> timeLoop,
                const SolutionVector& prevSol)
    : problem_(problem)
    , gridGeometry_(gridGeometry)
    , gridVariables_(gridVariables)
    , timeLoop_(timeLoop)
    , prevSol_(&prevSol)
    , isStationaryProblem_(!timeLoop)
    {
        enableMultithreading_ = SupportsColoring<typename GridGeometry::DiscretizationMethod>::value
            && Grid::Capabilities::supportsMultithreading(gridGeometry_->gridView())
            && !Multithreading::isSerial()
            && getParam<bool>("Assembly.Multithreading", true);
 
        maybeComputeColors_();
    }

    template<class PartialReassembler = DefaultPartialReassembler>
    void assembleJacobianAndResidual(const SolutionVector& curSol, const PartialReassembler* partialReassembler = nullptr)
    {
        checkAssemblerState_();
        resetJacobian_(partialReassembler);
        resetResidual_();
 
        assemble_([&](const Element& element)
        {
            LocalAssembler localAssembler(*this, element, curSol);
            localAssembler.assembleJacobianAndResidual(*jacobian_, *residual_, *gridVariables_, partialReassembler);
        });
 
        enforcePeriodicConstraints_(*jacobian_, *residual_, curSol, *gridGeometry_);
 
        auto applyDirichletConstraint = [&] (const auto& dofIdx,
                                             const auto& values,
                                             const auto eqIdx,
                                             const auto pvIdx)
        {
            (*residual_)[dofIdx][eqIdx] = curSol[dofIdx][pvIdx] - values[pvIdx];
 
            auto& row = (*jacobian_)[dofIdx];
            for (auto col = row.begin(); col != row.end(); ++col)
                row[col.index()][eqIdx] = 0.0;
 
            (*jacobian_)[dofIdx][dofIdx][eqIdx][pvIdx] = 1.0;
        };
        enforceProblemConstraints_(*problem_, *gridGeometry_, applyDirichletConstraint);
    }

    void assembleJacobian(const SolutionVector& curSol)
    {
        checkAssemblerState_();
        resetJacobian_();
 
        assemble_([&](const Element& element)
        {
            LocalAssembler localAssembler(*this, element, curSol);
            localAssembler.assembleJacobian(*jacobian_, *gridVariables_);
        });
 
        enforcePeriodicConstraints_(*jacobian_, curSol, *gridGeometry_);
 
        auto applyDirichletConstraint = [&] (const auto& dofIdx,
                                             const auto& values,
                                             const auto eqIdx,
                                             const auto pvIdx)
        {
            auto& row = (*jacobian_)[dofIdx];
            for (auto col = row.begin(); col != row.end(); ++col)
            row[col.index()][eqIdx] = 0.0;
 
            (*jacobian_)[dofIdx][dofIdx][eqIdx][pvIdx] = 1.0;
        };
        enforceProblemConstraints_(*problem_, *gridGeometry_, applyDirichletConstraint);
    }

    void assembleResidual(const SolutionVector& curSol)
    {
        resetResidual_();
        assembleResidual(*residual_, curSol);
    }

    void assembleResidual(ResidualType& r, const SolutionVector& curSol) const
    {
        checkAssemblerState_();
 
        assemble_([&](const Element& element)
        {
            LocalAssembler localAssembler(*this, element, curSol);
            localAssembler.assembleResidual(r);
        });
 
        enforcePeriodicConstraints_(r, curSol, *gridGeometry_);
 
        auto applyDirichletConstraint = [&] (const auto& dofIdx,
                                             const auto& values,
                                             const auto eqIdx,
                                             const auto pvIdx)
        {
            r[dofIdx][eqIdx] = curSol[dofIdx][pvIdx] - values[pvIdx];
        };
        enforceProblemConstraints_(*problem_, *gridGeometry_, applyDirichletConstraint);
    }

    void setLinearSystem(std::shared_ptr<JacobianMatrix> A,
                         std::shared_ptr<ResidualType> r)
    {
        jacobian_ = A;
        residual_ = r;
 
        // check and/or set the BCRS matrix's build mode
        if (jacobian_->buildMode() == JacobianMatrix::BuildMode::unknown)
            jacobian_->setBuildMode(JacobianMatrix::random);
        else if (jacobian_->buildMode() != JacobianMatrix::BuildMode::random)
            DUNE_THROW(Dune::NotImplemented, "Only BCRS matrices with random build mode are supported at the moment");
 
        setResidualSize_();
        setJacobianPattern_();
    }

    void setLinearSystem()
    {
        jacobian_ = std::make_shared<JacobianMatrix>();
        jacobian_->setBuildMode(JacobianMatrix::random);
        residual_ = std::make_shared<ResidualType>();
 
        setResidualSize_();
        setJacobianPattern_();
    }

    void updateAfterGridAdaption()
    {
        setResidualSize_();
        setJacobianPattern_();
        maybeComputeColors_();
    }

    std::size_t numDofs() const
    { return gridGeometry_->numDofs(); }

    const Problem& problem() const
    { return *problem_; }

    const GridGeometry& gridGeometry() const
    { return *gridGeometry_; }

    const GridView& gridView() const
    { return gridGeometry().gridView(); }

    GridVariables& gridVariables()
    { return *gridVariables_; }

    const GridVariables& gridVariables() const
    { return *gridVariables_; }

    JacobianMatrix& jacobian()
    { return *jacobian_; }

    ResidualType& residual()
    { return *residual_; }

    const SolutionVector& prevSol() const
    { return *prevSol_; }

    void setTimeLoop(std::shared_ptr<const TimeLoop> timeLoop)
    { timeLoop_ = timeLoop; isStationaryProblem_ = !static_cast<bool>(timeLoop); }

    void setPreviousSolution(const SolutionVector& u)
    { prevSol_ = &u;  }

    bool isStationaryProblem() const
    { return isStationaryProblem_; }

    LocalResidual localResidual() const
    { return LocalResidual(problem_.get(), timeLoop_.get()); }

    void updateGridVariables(const SolutionVector &cursol)
    {
        gridVariables().update(cursol);
    }

    void resetTimeStep(const SolutionVector &cursol)
    {
        gridVariables().resetTimeStep(cursol);
    }
 
private:
    void setJacobianPattern_()
    {
        // resize the jacobian and the residual
        const auto numDofs = this->numDofs();
        jacobian_->setSize(numDofs, numDofs);
 
        // create occupation pattern of the jacobian
        const auto occupationPattern = getJacobianPattern<isImplicit>(gridGeometry());
 
        // export pattern to jacobian
        occupationPattern.exportIdx(*jacobian_);
    }

    void setResidualSize_()
    { residual_->resize(numDofs()); }

    void maybeComputeColors_()
    {
        if (enableMultithreading_)
            elementSets_ = computeColoring(gridGeometry()).sets;
    }
 
    // reset the residual vector to 0.0
    void resetResidual_()
    {
        if(!residual_)
        {
            residual_ = std::make_shared<ResidualType>();
            setResidualSize_();
        }
 
        (*residual_) = 0.0;
    }
 
    // reset the Jacobian matrix to 0.0
    template <class PartialReassembler = DefaultPartialReassembler>
    void resetJacobian_(const PartialReassembler *partialReassembler = nullptr)
    {
        if(!jacobian_)
        {
            jacobian_ = std::make_shared<JacobianMatrix>();
            jacobian_->setBuildMode(JacobianMatrix::random);
            setJacobianPattern_();
        }
 
        if (partialReassembler)
            partialReassembler->resetJacobian(*this);
        else
            *jacobian_ = 0.0;
    }
 
    // check if the assembler is in a correct state for assembly
    void checkAssemblerState_() const
    {
        if (!isStationaryProblem_ && !prevSol_)
            DUNE_THROW(Dune::InvalidStateException, "Assembling instationary problem but previous solution was not set!");
    }

    template<typename AssembleElementFunc>
    void assemble_(AssembleElementFunc&& assembleElement) const
    {
        // a state that will be checked on all processes
        bool succeeded = false;
 
        // try assembling using the local assembly function
        try
        {
            if (enableMultithreading_)
            {
                assert(elementSets_.size() > 0);
 
                // make this element loop run in parallel
                // for this we have to color the elements so that we don't get
                // race conditions when writing into the global matrix
                // each color can be assembled using multiple threads
                for (const auto& elements : elementSets_)
                {
                    Dumux::parallelFor(elements.size(), [&](const std::size_t i)
                    {
                        const auto element = gridView().grid().entity(elements[i]);
                        assembleElement(element);
                    });
                }
            }
            else
                for (const auto& element : elements(gridView()))
                    assembleElement(element);
 
            // if we get here, everything worked well on this process
            succeeded = true;
        }
        // throw exception if a problem occurred
        catch (NumericalProblem &e)
        {
            std::cout << "rank " << gridView().comm().rank()
                      << " caught an exception while assembling:" << e.what()
                      << "\n";
            succeeded = false;
        }
 
        // make sure everything worked well on all processes
        if (gridView().comm().size() > 1)
            succeeded = gridView().comm().min(succeeded);
 
        // if not succeeded rethrow the error on all processes
        if (!succeeded)
            DUNE_THROW(NumericalProblem, "A process did not succeed in linearizing the system");
    }
 
    template<class GG>
    void enforcePeriodicConstraints_(JacobianMatrix& jac, ResidualType& res, const SolutionVector& curSol, const GG& gridGeometry) const
    {
        if constexpr (Detail::hasPeriodicDofMap<GG>())
        {
            for (const auto& m : gridGeometry.periodicDofMap())
            {
                const auto& periodicallyMappedDofs = Dumux::Deprecated::ensureRangeOfPeriodicDofs(m.second);
                if (std::ranges::all_of(periodicallyMappedDofs, [&](auto second){ return m.first < second; }))
                {
                    for (const auto& second : periodicallyMappedDofs)
                    {
                        // add the second row to the first
                        res[m.first] += res[second];
                        const auto end = jac[second].end();
                        for (auto it = jac[second].begin(); it != end; ++it)
                            jac[m.first][it.index()] += (*it);
 
                        // enforce constraint in second row
                        res[second] = curSol[second] - curSol[m.first];
 
                        // set derivatives accordingly in jacobian, i.e. id for second and -id for m.first
                        auto setMatrixBlock = [] (auto& matrixBlock, double diagValue)
                        {
                            for (int eIdx = 0; eIdx < matrixBlock.N(); ++eIdx)
                                matrixBlock[eIdx][eIdx] = diagValue;
                        };
 
                        for (auto it = jac[second].begin(); it != end; ++it)
                        {
                            auto& matrixBlock = *it;
                            matrixBlock = 0.0;
 
                            assert(matrixBlock.N() == matrixBlock.M());
                            if(it.index() == second)
                                setMatrixBlock(matrixBlock, 1.0);
 
                            if(it.index() == m.first)
                                setMatrixBlock(matrixBlock, -1.0);
 
                        }
                    }
                }
            }
        }
    }
 
    template<class GG>
    void enforcePeriodicConstraints_(JacobianMatrix& jac, const SolutionVector& curSol, const GG& gridGeometry) const
    {
        if constexpr (Detail::hasPeriodicDofMap<GG>())
        {
            for (const auto& m : gridGeometry.periodicDofMap())
            {
                const auto& periodicallyMappedDofs = Dumux::Deprecated::ensureRangeOfPeriodicDofs(m.second);
                if (std::ranges::all_of(periodicallyMappedDofs, [&](auto second){ return m.first < second; }))
                {
                    for (const auto& second : periodicallyMappedDofs)
                    {
                        // add the second row to the first
                        const auto end = jac[second].end();
                        for (auto it = jac[second].begin(); it != end; ++it)
                            jac[m.first][it.index()] += (*it);
 
                        // set derivatives accordingly in jacobian, i.e. id for second and -id for m.first
                        auto setMatrixBlock = [] (auto& matrixBlock, double diagValue)
                        {
                            for (int eIdx = 0; eIdx < matrixBlock.N(); ++eIdx)
                                matrixBlock[eIdx][eIdx] = diagValue;
                        };
 
                        for (auto it = jac[second].begin(); it != end; ++it)
                        {
                            auto& matrixBlock = *it;
                            matrixBlock = 0.0;
 
                            assert(matrixBlock.N() == matrixBlock.M());
                            if(it.index() == second)
                                setMatrixBlock(matrixBlock, 1.0);
 
                            if(it.index() == m.first)
                                setMatrixBlock(matrixBlock, -1.0);
 
                        }
                    }
                }
            }
        }
    }
 
    template<class GG>
    void enforcePeriodicConstraints_(ResidualType& res, const SolutionVector& curSol, const GG& gridGeometry) const
    {
        if constexpr (Detail::hasPeriodicDofMap<GG>())
        {
            for (const auto& m : gridGeometry.periodicDofMap())
            {
                const auto& periodicallyMappedDofs = Dumux::Deprecated::ensureRangeOfPeriodicDofs(m.second);
                if (std::ranges::all_of(periodicallyMappedDofs, [&](auto second){ return m.first < second; }))
                {
                    for (const auto& second : periodicallyMappedDofs)
                    {
                        // add the second row to the first
                        res[m.first] += res[second];
 
                        // enforce constraint in second row
                        res[second] = curSol[second] - curSol[m.first];
                    }
                }
            }
        }
    }
 
    template<class Problem, class GG, typename ApplyFunction>
    void enforceProblemConstraints_(const Problem& problem, const GG& gridGeometry, const ApplyFunction& applyDirichletConstraint) const
    {
        if constexpr (Detail::hasGlobalConstraints<Problem>())
        {
            for (const auto& constraintData : problem.constraints())
            {
                const auto& constraintInfo = constraintData.constraintInfo();
                const auto& values = constraintData.values();
                const auto dofIdx = constraintData.dofIndex();
                // set the constraint in residual and jacobian
                for (int eqIdx = 0; eqIdx < constraintInfo.size(); ++eqIdx)
                {
                    if (constraintInfo.isConstraintEquation(eqIdx))
                    {
                        const auto pvIdx = constraintInfo.eqToPriVarIndex(eqIdx);
                        assert(0 <= pvIdx && pvIdx < constraintInfo.size());
                        applyDirichletConstraint(dofIdx, values, eqIdx, pvIdx);
                    }
                }
            }
        }
    }

    std::shared_ptr<const Problem> problem_;

    std::shared_ptr<const GridGeometry> gridGeometry_;

    std::shared_ptr<GridVariables> gridVariables_;

    std::shared_ptr<const TimeLoop> timeLoop_;

    const SolutionVector* prevSol_ = nullptr;

    bool isStationaryProblem_;

    std::shared_ptr<JacobianMatrix> jacobian_;
    std::shared_ptr<ResidualType> residual_;

    bool enableMultithreading_ = false;
    std::deque<std::vector<ElementSeed>> elementSets_;
};
 
} // namespace Dumux
 
#endif