MultiRefOpt.hpp

Go to the documentation of this file.

// -------------------------------------------------------//
//
// SHAMROCK code for hydrodynamics
// Copyright (c) 2021-2026 Timothée David--Cléris <tim.shamrock@proton.me>
// SPDX-License-Identifier: CeCILL Free Software License Agreement v2.1
// Shamrock is licensed under the CeCILL 2.1 License, see LICENSE for more information
//
// -------------------------------------------------------//
 
#pragma once

 
#include "shambackends/kernel_call/buffer_access_utils.hpp"
 
namespace sham {

    template<class T>
    shambase::opt_ref<T> to_opt_ref(T &t) {
        return t;
    }

    template<class T>
    auto empty_buf_ref() {
        return shambase::opt_ref<sham::DeviceBuffer<T>>{};
    }

    template<class... Targ>
    struct MultiRefOpt {
        using storage_t = std::tuple<shambase::opt_ref<Targ>...>;

        storage_t storage;

        MultiRefOpt(shambase::opt_ref<Targ>... arg) : storage(arg...) {}

        auto get_read_access(sham::EventList &depends_list) {
            __shamrock_stack_entry();
            return std::apply(
                [&](auto &...__a) {
                    return std::tuple(details::read_access_optional(__a, depends_list)...);
                },
                storage);
        }

        auto get_write_access(sham::EventList &depends_list) {
            __shamrock_stack_entry();
            return std::apply(
                [&](auto &...__a) {
                    return std::tuple(details::write_access_optional(__a, depends_list)...);
                },
                storage);
        }

        void complete_event_state(sycl::event e) {
            __shamrock_stack_entry();
            std::apply(
                [&](auto &...__in) {
                    ((details::complete_state_optional(e, __in)), ...);
                },
                storage);
        }
    };
 
    namespace details {
        template<class T>
        struct mapper {
            using type = T;
        };

        template<class T>
        struct mapper<shambase::opt_ref<T>> {
            using type = T;
        };
    } // namespace details

    template<class... Targ>
    MultiRefOpt(Targ... arg) -> MultiRefOpt<typename details::mapper<Targ>::type...>;
} // namespace sham