vectorAccessInterface.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 <cstddef>
 
#include "../../config.h"
#include "../../misc/macros.hpp"

namespace codi {

  template<typename T_Real, typename T_Identifier>
  struct VectorAccessInterface {
    public:
 
      using Real = CODI_DD(T_Real, double);           
      using Identifier = CODI_DD(T_Identifier, int);  
 
      virtual ~VectorAccessInterface() {}  
 
      /*******************************************************************************/
 
      virtual size_t getVectorSize() const = 0;          
      virtual bool isLhsZero() = 0;                      
      virtual VectorAccessInterface* clone() const = 0;  
 
      /*******************************************************************************/
 
      virtual void setLhsAdjoint(Identifier const& index) = 0;  
      virtual void updateAdjointWithLhs(Identifier const& index,
                                        Real const& jacobian) = 0;  
 
      /*******************************************************************************/
 
      virtual void setLhsTangent(Identifier const& index) = 0;  
      virtual void updateTangentWithLhs(Identifier const& index,
                                        Real const& jacobian) = 0;  
 
      /*******************************************************************************/
 
      virtual void setActiveVariableForIndirectAccess(size_t pos) = 0;  
 
      /*******************************************************************************/
 
      virtual void resetAdjoint(Identifier const& index, size_t dim) = 0;  
      virtual void resetAdjointVec(Identifier const& index) = 0;           
 
      virtual Real getAdjoint(Identifier const& index, size_t dim) = 0;          
      virtual void getAdjointVec(Identifier const& index, Real* const vec) = 0;  
      virtual Real const* getAdjointVec(Identifier const& index) = 0;            
 
      virtual void updateAdjoint(Identifier const& index, size_t dim,
                                 Real const& adjoint) = 0;  
      virtual void updateAdjointVec(Identifier const& index, Real const* const vec) = 0;  
 
      /*******************************************************************************/
 
      virtual void setPrimal(Identifier const& index, Real const& primal) = 0;  
      virtual Real getPrimal(Identifier const& index) = 0;                      
 
      virtual bool hasPrimals() = 0;  
  };
}