common/pdesolver.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-FileCopyrightInfo: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_COMMON_PDESOLVER_HH
#define DUMUX_COMMON_PDESOLVER_HH
 
#include <memory>
#include <utility>
 
#include <dune/common/hybridutilities.hh>
#include <dune/common/std/type_traits.hh>
 
#include <dumux/common/timeloop.hh>
 
// forward declare
namespace Dune {
template <class FirstRow, class ... Args>
class MultiTypeBlockMatrix;
} // end namespace Dune
 
namespace Dumux::Detail::PDESolver {
 
template<class Assembler>
using AssemblerVariablesType = typename Assembler::Variables;
 
template<class Assembler>
inline constexpr bool assemblerExportsVariables = Dune::Std::is_detected_v<AssemblerVariablesType, Assembler>;
 
template<class A, bool exports = assemblerExportsVariables<A>> struct VariablesChooser;
template<class A> struct VariablesChooser<A, true> { using Type = AssemblerVariablesType<A>; };
template<class A> struct VariablesChooser<A, false> { using Type = typename A::SolutionVector; };
 
template<class Assembler>
using AssemblerVariables = typename VariablesChooser<Assembler>::Type;
 
} // end namespace Dumux::Detail::PDESolver
 
namespace Dumux {
 
template<class A, class LS>
class PDESolver
{
    using Scalar = typename A::Scalar;
    using TimeLoop = TimeLoopBase<Scalar>;
 
public:
    using Assembler = A;
    using LinearSolver = LS;
 
    using Variables = Detail::PDESolver::AssemblerVariables<Assembler>;
 
    PDESolver(std::shared_ptr<Assembler> assembler,
              std::shared_ptr<LinearSolver> linearSolver)
    : assembler_(assembler)
    , linearSolver_(linearSolver)
    {}
 
    virtual ~PDESolver() = default;
 
    virtual bool apply(Variables& vars) = 0;
 
    virtual void solve(Variables& vars) = 0;
 
    virtual void solve(Variables& vars, TimeLoop& timeLoop)
    {
        // per default we just forward to the method without time step control
        solve(vars);
    }
 
    const Assembler& assembler() const
    { return *assembler_; }
 
    Assembler& assembler()
    { return *assembler_; }
 
    const LinearSolver& linearSolver() const
    { return *linearSolver_; }
 
protected:
 
    LinearSolver& linearSolver()
    { return *linearSolver_; }
 
    template <class FirstRow, class ... Args>
    bool checkSizesOfSubMatrices(const Dune::MultiTypeBlockMatrix<FirstRow, Args...>& matrix) const
    {
        bool matrixHasCorrectSize = true;
        using namespace Dune::Hybrid;
        forEach(std::make_index_sequence<Dune::MultiTypeBlockMatrix<FirstRow, Args...>::N()>(), [&](const auto i)
        {
            const auto& row = matrix[i];
            const auto numRowsLeftMostBlock = row[Dune::index_constant<0>{}].N();
            forEach(row, [&](const auto& subBlock)
            {
                if (subBlock.N() != numRowsLeftMostBlock)
                    matrixHasCorrectSize = false;
            });
        });
        return matrixHasCorrectSize;
    }
 
    template <class M>
    bool checkSizesOfSubMatrices(const M&) const { return true; }
 
private:
    std::shared_ptr<Assembler> assembler_;
    std::shared_ptr<LinearSolver> linearSolver_;
};
 
} // namespace Dumux
 
#endif