traversalLogic.hpp

/*
 * CoDiPack, a Code Differentiation Package
 *
 * Copyright (C) 2015-2025 Chair for Scientific Computing (SciComp), University of Kaiserslautern-Landau
 * Homepage: http://scicomp.rptu.de
 * Contact:  Prof. Nicolas R. Gauger (codi@scicomp.uni-kl.de)
 *
 * Lead developers: Max Sagebaum, Johannes Blühdorn (SciComp, University of Kaiserslautern-Landau)
 *
 * This file is part of CoDiPack (http://scicomp.rptu.de/software/codi).
 *
 * CoDiPack 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.
 *
 * CoDiPack 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 CoDiPack.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * For other licensing options please contact us.
 *
 * Authors:
 *  - SciComp, University of Kaiserslautern-Landau:
 *    - Max Sagebaum
 *    - Johannes Blühdorn
 *    - Former members:
 *      - Tim Albring
 */
#pragma once
 
#include <utility>
 
#include "../../config.h"
#include "../../misc/compileTimeLoop.hpp"
#include "../../misc/macros.hpp"
#include "nodeInterface.hpp"

namespace codi {

  template<typename T_Impl>
  struct TraversalLogic {
    public:
 
      using Impl = CODI_DD(T_Impl, TraversalLogic);  

      CODI_INLINE Impl& cast() {
        return static_cast<Impl&>(*this);
      }

      template<typename Node, typename... Args>
      CODI_INLINE void eval(NodeInterface<Node> const& node, Args&&... args) {
        cast().toNode(node.cast(), std::forward<Args>(args)...);
      }
 
      /*******************************************************************************/

      template<typename Node, typename... Args>
      CODI_INLINE void node(Node const& node, Args&&... args) {
        // Default logic forwards to all links.
        cast().toLinks(node, std::forward<Args>(args)...);
      }

      template<typename Node, typename... Args>
      CODI_INLINE void leaf(Node const& node, Args&&... args) {
        CODI_UNUSED(node, args...);
        // Default logic does nothing.
      }

      template<size_t ChildNumber, typename Child, typename Root, typename... Args>
      CODI_INLINE void link(Child const& child, Root const& root, Args&&... args) {
        CODI_UNUSED(root, args...);
        // Default logic forwards to node evaluation.
        cast().toNode(child, std::forward<Args>(args)...);
      }

 
    protected:
 
#ifndef DOXYGEN_DISABLE
      template<typename TraversalImpl, bool endPoint = false>
      struct CallSwitch {
        public:
          template<typename... Args>
          CODI_INLINE static void call(TraversalImpl& impl, Args&&... args) {
            impl.node(std::forward<Args>(args)...);
          }
      };
 
      template<typename TraversalImpl>
      struct CallSwitch<TraversalImpl, true> {
        public:
          template<typename... Args>
          CODI_INLINE static void call(TraversalImpl& impl, Args&&... args) {
            impl.leaf(std::forward<Args>(args)...);
          }
      };
#endif

      template<typename Node, typename... Args>
      CODI_INLINE void toNode(Node const& node, Args&&... args) {
        CallSwitch<Impl, 0 == Node::LinkCount>::call(cast(), node, std::forward<Args>(args)...);
      }

      template<typename Node, typename... Args>
      CODI_INLINE void toLinks(CODI_DD(Node, CODI_T(NodeInterface<void>)) const& node, Args&&... args) {
        static_for<Node::LinkCount>([&](auto i) CODI_LAMBDA_INLINE {
          cast().template link<i.value>(node.template getLink<i.value>(), node, std::forward<Args>(args)...);
        });
      }
  };
}