linearSystemInterface.hpp

/*
 * CoDiPack, a Code Differentiation Package
 *
 * Copyright (C) 2015-2024 Chair for Scientific Computing (SciComp), University of Kaiserslautern-Landau
 * Homepage: http://www.scicomp.uni-kl.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://www.scicomp.uni-kl.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 <vector>
 
#include "../../../config.h"
#include "../../../misc/macros.hpp"
 
namespace codi {
 
  struct LinearSystemInterfaceTypes {
    public:
 
      using Type = CODI_ANY;  
 
      using Matrix = CODI_ANY;  
      using MatrixReal =
          CODI_ANY;  
      using MatrixIdentifier = CODI_ANY;  
      using Vector = CODI_ANY;            
      using VectorReal =
          CODI_ANY;  
      using VectorIdentifier = CODI_ANY;  
  };
 
  template<typename T_InterfaceTypes>
  struct LinearSystemInterface {
    public:
 
      using InterfaceTypes = CODI_DD(T_InterfaceTypes, LinearSystemInterfaceTypes);  
 
      using Type = typename InterfaceTypes::Type;  
 
      using Matrix = typename InterfaceTypes::Matrix;                      
      using MatrixReal = typename InterfaceTypes::MatrixReal;              
      using MatrixIdentifier = typename InterfaceTypes::MatrixIdentifier;  
      using Vector = typename InterfaceTypes::Vector;                      
      using VectorReal = typename InterfaceTypes::VectorReal;              
      using VectorIdentifier = typename InterfaceTypes::VectorIdentifier;  
 
      /*******************************************************************************/
 
      template<typename M>
      MatrixReal* createMatrixReal(M* mat);
 
      template<typename M>
      MatrixIdentifier* createMatrixIdentifier(M* mat);
 
      template<typename V>
      VectorReal* createVectorReal(V* vec);
 
      template<typename V>
      VectorIdentifier* createVectorIdentifier(V* vec);
 
      void deleteMatrixReal(MatrixReal* A_v);
 
      void deleteMatrixIdentifier(MatrixIdentifier* A_id);
 
      void deleteVectorReal(VectorReal* vec_v);
 
      void deleteVectorIdentifier(VectorIdentifier* vec_id);
 
      /*******************************************************************************/
 
      template<typename Func, typename MatrixA, typename MatrixB>
      void iterateMatrix(Func func, MatrixA* matA, MatrixB* matB);
 
      template<typename Func, typename MatrixA, typename MatrixB, typename MatrixC>
      void iterateMatrix(Func func, MatrixA* matA, MatrixB* matB, MatrixC* matC);
 
      template<typename Func, typename VectorA, typename VectorB>
      void iterateVector(Func func, VectorA* vecA, VectorB* vecB);
 
      template<typename Func, typename VectorA, typename VectorB, typename VectorC>
      void iterateVector(Func func, VectorA* vecA, VectorB* vecB, VectorC* vecC);
 
      template<typename Func, typename VectorA, typename VectorB, typename VectorC, typename VectorD>
      void iterateVector(Func func, VectorA* vecA, VectorB* vecB, VectorC* vecC, VectorD* vecD);
 
      /*******************************************************************************/
 
      void solveSystem(MatrixReal const* A, VectorReal const* b, VectorReal* x);
 
      /*******************************************************************************/
 
      template<typename Func>
      void iterateDyadic(Func func, MatrixIdentifier* mat_id, VectorReal* x_v, VectorReal* b_b) {
        CODI_UNUSED(func, mat_id, x_v, b_b);
      }
 
      MatrixReal* transposeMatrix(MatrixReal* A_v) {
        CODI_UNUSED(A_v);
        return NULL;
      }
 
      /*******************************************************************************/
 
      void subtractMultiply(VectorReal* t, VectorReal const* b_d, MatrixReal const* A_d, VectorReal const* x) {
        CODI_UNUSED(t, b_d, A_d, x);
      }
 
      /*******************************************************************************/
 
      void solveSystemPrimal(MatrixReal const* A, VectorReal const* b, VectorReal* x) {
        CODI_UNUSED(A, b, x);
      }
 
  };
}