ExchangeGhostField.cpp

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
//
// -------------------------------------------------------//
 
#include "shamrock/solvergraph/ExchangeGhostField.hpp"
#include "shamalgs/collective/distributedDataComm.hpp"
#include "shamrock/solvergraph/RankGetter.hpp"
#include "shamrock/solvergraph/ScalarsEdge.hpp"
 
template<class T>
void shamrock::solvergraph::ExchangeGhostField<T>::_impl_evaluate_internal() {
    auto edges = get_edges();
 
    // outputs
    auto &ghost_layer                                   = edges.ghost_layer;
    const shamrock::solvergraph::RankGetter &rank_owner = edges.rank_owner;
 
    shambase::DistributedDataShared<PatchDataField<T>> recv_dat;
 
    shamalgs::collective::serialize_sparse_comm<PatchDataField<T>>(
        shamsys::instance::get_compute_scheduler_ptr(),
        std::move(ghost_layer.patchdata_fields),
        recv_dat,
        [&](u64 id) {
            return rank_owner.get_rank_owner(id);
        },
        [](PatchDataField<T> &pdat) {
            shamalgs::SerializeHelper ser(shamsys::instance::get_compute_scheduler_ptr());
            ser.allocate(pdat.serialize_full_byte_size());
            pdat.serialize_full(ser);
            return ser.finalize();
        },
        [&](sham::DeviceBuffer<u8> &&buf) {
            // exchange the buffer held by the distrib data and give it to the serializer
            shamalgs::SerializeHelper ser(
                shamsys::instance::get_compute_scheduler_ptr(),
                std::forward<sham::DeviceBuffer<u8>>(buf));
            return PatchDataField<T>::deserialize_full(ser);
        },
        cache);
 
    ghost_layer.patchdata_fields = std::move(recv_dat);
}
 
template<class T>
std::string shamrock::solvergraph::ExchangeGhostField<T>::_impl_get_tex() const {
    auto rank_owner  = get_ro_edge_base(0).get_tex_symbol();
    auto ghost_layer = get_rw_edge_base(0).get_tex_symbol();
 
    std::string tex = R"tex(
        Exchange ghost field data between distributed processes
 
        \begin{align}
        {ghost_layer}_{i \rightarrow \underline{j}} = \text{Sparse comm}({ghost_layer}_{\underline{i} \rightarrow j}) \\
        \text{where } {rank_owner}_{\underline{j}} = \text{MPI world rank} \\
        \text{and } {rank_owner}_{\underline{i}} = \text{MPI world rank} \\
        \text{and } i \in [0, N_{\rm patch}] \\
        \text{and } j \in [0, N_{\rm patch}] \\
        \end{align},
        underlined indices denotes one that currently owned by the local process.
    )tex";
 
    shambase::replace_all(tex, "{rank_owner}", rank_owner);
    shambase::replace_all(tex, "{ghost_layer}", ghost_layer);
 
    return tex;
}
 
// Explicitly instantiate all classes in XMAC_LIST_ENABLED_FIELD
 
#ifndef DOXYGEN
    #define X(a) template class shamrock::solvergraph::ExchangeGhostField<a>;
XMAC_LIST_ENABLED_FIELD
    #undef X
#endif