tagData.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 "../../config.h"
#include "../../misc/enumBitset.hpp"
#include "../../misc/exceptions.hpp"
#include "../../misc/macros.hpp"

namespace codi {

  enum class TagFlags {
    DoNotChange,  
    DoNotWrite,   
    DoNotUse,     
    MaxElement    
  };

  template<typename T_Tag>
  struct TagData {
    public:
 
      using Tag = CODI_DD(T_Tag, int);  
 
      mutable Tag tag;                  
      EnumBitset<TagFlags> properties;  

      constexpr TagData() : tag(), properties() {}

      TagData(Tag tag) : tag(tag), properties() {}

      TagData& operator+=(TagData const& o) {
        if (*this != o) {
          CODI_EXCEPTION("Operation on different tag objects.");
        }
 
        return *this;
      }
 
#if CODI_ImplicitTagConversion
      operator Tag() const {
        return tag;
      }
#endif
  };

  template<typename Tag>
  bool operator==(TagData<Tag> const& a, TagData<Tag> const& b) {
    return a.tag == b.tag && a.properties == b.properties;
  }

  template<typename Tag>
  bool operator!=(TagData<Tag> const& a, TagData<Tag> const& b) {
    return !(a == b);
  }
}
 
namespace std {

  CODI_INLINE std::string to_string(codi::TagFlags const& flag) {
    // clang-format off
    switch (flag) {
      case codi::TagFlags::DoNotChange: return "DoNotChange";
      case codi::TagFlags::DoNotWrite:  return "DoNotWrite";
      case codi::TagFlags::DoNotUse:    return "DoNotUse";
      default:
        CODI_EXCEPTION("Unkown flag for codi::TagFlags %d.", (int)flag);
        return "unknown";
    }
    // clang-format on
  }
}