SolverGraph.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/memory.hpp"
#include "shamrock/solvergraph/IEdge.hpp"
#include "shamrock/solvergraph/INode.hpp"
#include <unordered_map>
#include <memory>
 
namespace shamrock::solvergraph {
 
    class SolverGraph {
        std::unordered_map<std::string, std::shared_ptr<INode>> nodes;
 
        std::unordered_map<std::string, std::shared_ptr<IEdge>> edges;
 
        public:
        // base getters and setters
 
        inline std::shared_ptr<INode> register_node_ptr_base(
            const std::string &name, std::shared_ptr<INode> node) {
            const auto [it, inserted] = nodes.try_emplace(name, std::move(node));
            if (!inserted) {
                shambase::throw_with_loc<std::invalid_argument>(
                    shambase::format("Node already exists: {}", name));
            }
            return it->second;
        }
 
        inline std::shared_ptr<IEdge> register_edge_ptr_base(
            const std::string &name, std::shared_ptr<IEdge> edge) {
            const auto [it, inserted] = edges.try_emplace(name, std::move(edge));
            if (!inserted) {
                shambase::throw_with_loc<std::invalid_argument>(
                    shambase::format("Edge already exists: {}", name));
            }
            return it->second;
        }
 
        inline std::shared_ptr<INode> &get_node_ptr_base(const std::string &name) {
            auto it = nodes.find(name);
            if (it == nodes.end()) {
                shambase::throw_with_loc<std::invalid_argument>(
                    shambase::format("Node does not exist: {}", name));
            }
            return it->second;
        }
 
        inline const std::shared_ptr<INode> &get_node_ptr_base(const std::string &name) const {
            auto it = nodes.find(name);
            if (it == nodes.end()) {
                shambase::throw_with_loc<std::invalid_argument>(
                    shambase::format("Node does not exist: {}", name));
            }
            return it->second;
        }
 
        inline std::shared_ptr<IEdge> &get_edge_ptr_base(const std::string &name) {
            auto it = edges.find(name);
            if (it == edges.end()) {
                shambase::throw_with_loc<std::invalid_argument>(
                    shambase::format("Edge does not exist: {}", name));
            }
            return it->second;
        }
 
        inline const std::shared_ptr<IEdge> &get_edge_ptr_base(const std::string &name) const {
            auto it = edges.find(name);
            if (it == edges.end()) {
                shambase::throw_with_loc<std::invalid_argument>(
                    shambase::format("Edge does not exist: {}", name));
            }
            return it->second;
        }
 
        // generic getters
 
        inline INode &get_node_ref_base(const std::string &name) {
            return shambase::get_check_ref(get_node_ptr_base(name));
        }
 
        inline const INode &get_node_ref_base(const std::string &name) const {
            return shambase::get_check_ref(get_node_ptr_base(name));
        }
 
        inline IEdge &get_edge_ref_base(const std::string &name) {
            return shambase::get_check_ref(get_edge_ptr_base(name));
        }
 
        inline const IEdge &get_edge_ref_base(const std::string &name) const {
            return shambase::get_check_ref(get_edge_ptr_base(name));
        }
 
        // templated register and getters
 
        template<class T>
        inline std::shared_ptr<T> register_node(const std::string &name, T &&node) {
            static_assert(std::is_base_of<INode, T>::value, "T must derive from INode");
            register_node_ptr_base(name, std::make_shared<T>(std::forward<T>(node)));
            return get_node_ptr<T>(name);
        }
 
        template<class T>
        inline std::shared_ptr<T> register_edge(const std::string &name, T &&edge) {
            static_assert(std::is_base_of<IEdge, T>::value, "T must derive from IEdge");
            register_edge_ptr_base(name, std::make_shared<T>(std::forward<T>(edge)));
            return get_edge_ptr<T>(name);
        }
 
        template<class T>
        inline std::shared_ptr<T> get_node_ptr(const std::string &name) {
            auto tmp = std::dynamic_pointer_cast<T>(get_node_ptr_base(name));
            if (!bool(tmp)) {
                shambase::throw_with_loc<std::invalid_argument>(
                    shambase::format("Node exists but is not from the requested type: {}", name));
            }
            return tmp;
        }
 
        template<class T>
        inline std::shared_ptr<T> get_node_ptr(const std::string &name) const {
            auto tmp = std::dynamic_pointer_cast<T>(get_node_ptr_base(name));
            if (!bool(tmp)) {
                shambase::throw_with_loc<std::invalid_argument>(
                    shambase::format("Node exists but is not from the requested type: {}", name));
            }
            return tmp;
        }
 
        template<class T>
        inline std::shared_ptr<T> get_edge_ptr(const std::string &name) {
            auto tmp = std::dynamic_pointer_cast<T>(get_edge_ptr_base(name));
            if (!bool(tmp)) {
                shambase::throw_with_loc<std::invalid_argument>(
                    shambase::format("Edge exists but is not from the requested type: {}", name));
            }
            return tmp;
        }
 
        template<class T>
        inline std::shared_ptr<T> get_edge_ptr(const std::string &name) const {
            auto tmp = std::dynamic_pointer_cast<T>(get_edge_ptr_base(name));
            if (!bool(tmp)) {
                shambase::throw_with_loc<std::invalid_argument>(
                    shambase::format("Edge exists but is not from the requested type: {}", name));
            }
            return tmp;
        }
 
        template<class T>
        inline T &get_node_ref(const std::string &name) {
            return shambase::get_check_ref(get_node_ptr<T>(name));
        }
 
        template<class T>
        inline const T &get_node_ref(const std::string &name) const {
            return shambase::get_check_ref(get_node_ptr<T>(name));
        }
 
        template<class T>
        inline T &get_edge_ref(const std::string &name) {
            return shambase::get_check_ref(get_edge_ptr<T>(name));
        }
 
        template<class T>
        inline const T &get_edge_ref(const std::string &name) const {
            return shambase::get_check_ref(get_edge_ptr<T>(name));
        }
    };
 
} // namespace shamrock::solvergraph