enum_NeighCacheStrategy.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 "shambase/exception.hpp"
#include "nlohmann/json.hpp"
#include "shamrock/io/json_utils.hpp"
#include <string>
 
namespace shammodels {

    enum NeighCacheStrategy {
        SingleStage = 0, 
        TwoStage    = 1  
    };
 
    SHAMROCK_JSON_SERIALIZE_ENUM(
        NeighCacheStrategy,
        {{NeighCacheStrategy::SingleStage, "single_stage"},
         {NeighCacheStrategy::TwoStage, "two_stage"}});

    inline constexpr const char *neigh_cache_strategy_json_key = "neigh_cache_strategy";

    inline constexpr const char *neigh_cache_strategy_legacy_json_key = "use_two_stage_search";

    inline NeighCacheStrategy neigh_cache_strategy_from_two_stage_search(
        bool use_two_stage_search) {
        return (use_two_stage_search) ? NeighCacheStrategy::TwoStage
                                      : NeighCacheStrategy::SingleStage;
    }

    inline void get_to_neigh_cache_strategy(
        const nlohmann::json &j,
        NeighCacheStrategy &value,
        const std::string &log_ctx,
        bool &has_used_defaults,
        bool &has_updated_config) {
 
        if (j.contains(neigh_cache_strategy_json_key)) {
            j.at(neigh_cache_strategy_json_key).get_to(value);
            return;
        }
 
        if (j.contains(neigh_cache_strategy_legacy_json_key)) {
            value = neigh_cache_strategy_from_two_stage_search(
                j.at(neigh_cache_strategy_legacy_json_key).template get<bool>());
            has_updated_config = true;
            if (shamcomm::world_rank() == 0) {
                shamcomm::logs::warn_ln(
                    log_ctx,
                    "Updating old key [" + std::string(neigh_cache_strategy_legacy_json_key)
                        + "] to new key [" + std::string(neigh_cache_strategy_json_key)
                        + "] in from_json");
            }
            return;
        }
 
        has_used_defaults = true;
    }
 
} // namespace shammodels