aggregatedActiveType.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/compileTimeLoop.hpp"
#include "../../misc/eventSystem.hpp"
#include "../../misc/macros.hpp"
#include "../../traits/realTraits.hpp"
#include "../lhsExpressionInterface.hpp"
#include "../logic/constructStaticContext.hpp"

namespace codi {

  template<typename T_Real, typename T_InnerActiveType, typename T_Impl, bool T_isStatic>
  struct AggregatedActiveTypeBase : public ExpressionInterface<T_Real, T_Impl> {
    public:
 
      using Real = T_Real;  
      using InnerActiveType = CODI_DD(T_InnerActiveType,
                                      CODI_DEFAULT_LHS_EXPRESSION);  
      using Impl = CODI_DD(T_Impl, AggregatedActiveTypeBase);        
      static bool constexpr isStatic = T_isStatic;                   
 
      using Tape = typename InnerActiveType::Tape;            
      using Traits = RealTraits::AggregatedTypeTraits<Real>;  
      static int constexpr Elements = Traits::Elements;       
 
      using InnerReal = typename Traits::InnerType;       
      using InnerIdentifier = typename Tape::Identifier;  
 
      InnerActiveType values[Elements];  
 
      CODI_INLINE AggregatedActiveTypeBase() = default;                                 
      CODI_INLINE AggregatedActiveTypeBase(AggregatedActiveTypeBase const&) = default;  
      CODI_INLINE ~AggregatedActiveTypeBase() = default;                                
 
      /*******************************************************************************/

      using StoreAs = typename std::conditional<isStatic, Impl, Impl const&>::type;
      using ADLogic = Tape;  

      CODI_INLINE Real const getValue() const {
        Real value{};
        static_for<Elements>([&](auto i) CODI_LAMBDA_INLINE {
          Traits::template arrayAccess<i.value>(value) = values[i.value].getValue();
        });
        return value;
      }

      template<size_t argNumber>
      CODI_INLINE Real applyTangent(InnerReal const& tangent) const {
        CODI_UNUSED(tangent);
        return Real();  // TODO: return Traits::template tangentOfConstructor<argNumber>(getValue(), adjoint);
      }

      template<size_t argNumber>
      CODI_INLINE InnerReal applyAdjoint(Real const& adjoint) const {
        return Traits::template adjointOfConstructor<argNumber>(getValue(), adjoint);
      }

      static CODI_INLINE std::string getMathRep() {
        return Traits::getMathRep();
      }
 
      /*******************************************************************************/
 
      static size_t constexpr LinkCount = Elements;  

      template<size_t argNumber>
      CODI_INLINE InnerActiveType const& getLink() const {
        return values[argNumber];
      }
 
    protected:

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

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

  template<typename T_Real, typename T_InnerActiveType, typename T_Impl>
  struct AggregatedActiveType : public AggregatedActiveTypeBase<T_Real, T_InnerActiveType, T_Impl, false> {
    public:
      using Real = T_Real;                                                              
      using InnerActiveType = CODI_DD(T_InnerActiveType, CODI_DEFAULT_LHS_EXPRESSION);  
      using Impl = CODI_DD(T_Impl, AggregatedActiveType);                               
 
      using Base =
          AggregatedActiveTypeBase<T_Real, T_InnerActiveType, T_Impl, false>;  
      using Traits = RealTraits::AggregatedTypeTraits<Real>;                   
      using PassiveReal = RealTraits::PassiveReal<Real>;                       
 
      using Base::Base;                               
      CODI_INLINE ~AggregatedActiveType() = default;  

      template<typename Expr>
      CODI_INLINE AggregatedActiveType(ExpressionInterface<Real, Expr> const& expr) : Base() {
        store(expr, EventHints::Statement::Expression);
      }

      CODI_INLINE AggregatedActiveType(AggregatedActiveType const& expr) : Base() {
        store(expr, EventHints::Statement::Copy);
      }

      CODI_INLINE AggregatedActiveType(PassiveReal const& expr) : Base() {
        static_for<Base::Elements>([&](auto i) CODI_LAMBDA_INLINE {
          Base::values[i.value] = Traits::template arrayAccess<i.value>(expr);
        });
      }

      template<typename Expr>
      CODI_INLINE Impl& operator=(ExpressionInterface<Real, Expr> const& expr) {
        store(expr, EventHints::Statement::Expression);
 
        return Base::cast();
      }

      CODI_INLINE Impl& operator=(AggregatedActiveType const& expr) {
        store(expr, EventHints::Statement::Copy);
 
        return Base::cast();
      }

      CODI_INLINE Impl& operator=(PassiveReal const& expr) {
        static_for<Base::Elements>([&](auto i) CODI_LAMBDA_INLINE {
          Base::values[i.value] = Traits::template arrayAccess<i.value>(expr);
        });
 
        return Base::cast();
      }
 
    protected:

      template<typename Rhs>
      CODI_INLINE void store(ExpressionInterface<Real, Rhs> const& rhs, EventHints::Statement const& eventType) {
        static_for<Traits::Elements>([&](auto i) {
          InnerActiveType& lhs = Base::values[i.value];
          EventSystem<typename InnerActiveType::Tape>::notifyStatementPrimalListeners(
              InnerActiveType::getTape(), lhs.getValue(), lhs.getIdentifier(),
              Traits::template arrayAccess<i.value>(rhs.cast().getValue()), eventType);
        });
 
        InnerActiveType::getTape().store(*this, rhs.cast());
      }
  };
}