multidomain/fvgridgeometry.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_MULTIDOMAIN_FV_GRIDGEOMETRY_HH
#define DUMUX_MULTIDOMAIN_FV_GRIDGEOMETRY_HH
 
#include <tuple>
#include <memory>
#include <utility>
 
#include <dune/common/hybridutilities.hh>
#include <dune/common/indices.hh>
 
namespace Dumux {
 
namespace Multidomain::Detail {
 
template<class T>
struct IsStdTuple_
: public std::false_type {};
 
template<class... Args>
struct IsStdTuple_<std::tuple<Args...>>
: public std::true_type {};
 
template<class T>
inline constexpr bool isStdTuple = IsStdTuple_<T>::value;
 
} // end namespace Multidomain::Detail
 
template<class MDTraits>
class MultiDomainFVGridGeometry
{
    static constexpr std::size_t numSubDomains = MDTraits::numSubDomains;
 
    // unwrap the tuple and pass its elements as arguments to the constructor of the ith element
    template<std::size_t i, class Tuple, size_t... Is>
    void constructFromTupleOfArgs_(Tuple&& t, std::index_sequence<Is...>)
    {
        std::get<i>(gridGeometries_) = std::make_shared<Type<i>>(std::get<Is>(std::forward<Tuple>(t))...);
    }
 
    // construct the ith element in this multidomain wrapper
    template<std::size_t i, class Arg>
    void construct_(Arg&& arg)
    {
        using ArgT = std::decay_t<Arg>;
        // use perfect forwarding of the argument(s) in both cases
        if constexpr (Multidomain::Detail::template isStdTuple<ArgT>)
            constructFromTupleOfArgs_<i>(std::forward<Arg>(arg), std::make_index_sequence<std::tuple_size_v<ArgT>>{});
        else
            std::get<i>(gridGeometries_) = std::make_shared<Type<i>>(std::forward<Arg>(arg));
    }
 
    // unwrap the tuple and pass its elements as arguments to the update function of the ith element
    template<std::size_t i, class Tuple, size_t... Is>
    void updateWithTupleOfArgs_(Tuple&& t, std::index_sequence<Is...>)
    {
        std::get<i>(gridGeometries_)->update(std::get<Is>(std::forward<Tuple>(t))...);
    }
 
    // update the ith element in this multidomain wrapper
    template<std::size_t i, class Arg>
    void update_(Arg&& arg)
    {
        using ArgT = std::decay_t<Arg>;
        // use perfect forwarding of the argument(s) in both cases
        if constexpr (Multidomain::Detail::template isStdTuple<ArgT>)
            updateWithTupleOfArgs_<i>(std::forward<Arg>(arg), std::make_index_sequence<std::tuple_size_v<ArgT>>{});
        else
            std::get<i>(gridGeometries_)->update(std::forward<Arg>(arg));
    }
 
    // remove this after 3.5
    template<std::size_t i>
    using GV = typename MDTraits::template SubDomain<i>::GridGeometry::GridView;
    using GVTuple = typename MDTraits::template Tuple<GV>;
 
public:
    template<std::size_t i>
    using Type = typename MDTraits::template SubDomain<i>::GridGeometry;
 
    template<std::size_t i>
    using PtrType = std::shared_ptr<Type<i>>;
 
    using TupleType = typename MDTraits::template Tuple<PtrType>;
 
    [[deprecated("Will be removed after release 3.5. Use variadic constructor!")]]
    MultiDomainFVGridGeometry() = default;
 
    template<typename... Args>
    MultiDomainFVGridGeometry(Args&&... args)
    {
        static_assert(numSubDomains == sizeof...(Args), "Number of arguments has to match number of subdomains");
 
        using namespace Dune::Hybrid;
        forEach(std::make_index_sequence<numSubDomains>{}, [this, t = std::forward_as_tuple(args...)](auto&& id)
        {
            constexpr auto i = std::decay_t<decltype(id)>::value;
            this->construct_<i>(std::get<i>(t));
        });
    }
 
    MultiDomainFVGridGeometry(TupleType ggTuple)
    : gridGeometries_(std::move(ggTuple))
    {}
 
    [[deprecated("Will be removed after release 3.5. Use variadic constructor!")]]
    MultiDomainFVGridGeometry(GVTuple gvTuple)
    {
        using namespace Dune::Hybrid;
        forEach(std::make_index_sequence<numSubDomains>{}, [&](auto&& id)
        {
            constexpr auto i = std::decay_t<decltype(id)>::value;
            this->construct_<i>(std::get<i>(gvTuple));
        });
    }
 
    template<typename... Args>
    void update(Args&&... args)
    {
        static_assert(numSubDomains == sizeof...(Args), "Number of arguments has to match number of subdomains");
 
        using namespace Dune::Hybrid;
        forEach(std::make_index_sequence<numSubDomains>{}, [this, t = std::forward_as_tuple(args...)](auto&& id)
        {
            constexpr auto i = std::decay_t<decltype(id)>::value;
            this->update_<i>(std::get<i>(t));
        });
    }
 
    [[deprecated("Will be removed after release 3.5. Use variadic update!")]]
    void update()
    {
        using namespace Dune::Hybrid;
        forEach(std::make_index_sequence<numSubDomains>{}, [&](auto&& id)
        {
            elementAt(gridGeometries_, id)->update();
        });
    }
 
    template<std::size_t i>
    const Type<i>& operator[] (Dune::index_constant<i>) const
    { return *std::get<i>(gridGeometries_); }
 
    template<std::size_t i>
    Type<i>& operator[] (Dune::index_constant<i>)
    { return *std::get<i>(gridGeometries_); }
 
    template<std::size_t i>
    const PtrType<i>& get(Dune::index_constant<i> id = Dune::index_constant<i>{}) const
    { return std::get<i>(gridGeometries_); }
 
    template<std::size_t i>
    PtrType<i>& get(Dune::index_constant<i> id = Dune::index_constant<i>{})
    { return std::get<i>(gridGeometries_); }
 
    template<std::size_t i>
    [[deprecated("Will be removed after release 3.5. Use one of the constructors instead.")]]
    void set(PtrType<i> p, Dune::index_constant<i> id = Dune::index_constant<i>{})
    { std::get<i>(gridGeometries_) = p; }
 
    [[deprecated("Use asTuple. Will be removed after release 3.5")]]
    TupleType getTuple()
    { return gridGeometries_; }
 
    TupleType& asTuple()
    { return gridGeometries_; }
 
    const TupleType& asTuple() const
    { return gridGeometries_; }
 
private:
 
    TupleType gridGeometries_;
};
 
} // end namespace Dumux
 
#endif