IInternalLinearAlgebraExprT.h

Go to the documentation of this file.

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2024 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
#pragma once
 
#include <alien/core/backend/IInternalLinearAlgebraT.h>
#include <alien/utils/Precomp.h>
#include <string>
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Alien
{
 
class Space;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <class M, class V>
class IInternalLinearAlgebraExpr
{
 public:
  typedef M Matrix;
  typedef V Vector;
  typedef IInternalLinearAlgebraExpr<Matrix, Vector>* (*Factory)();
 
 public:
  virtual ~IInternalLinearAlgebraExpr() {}
 
 public:
  virtual Real norm0(const Vector& x) const = 0;

  virtual Real norm1(const Vector& x) const = 0;

  virtual Real norm2(const Vector& x) const = 0;

  virtual Real normInf(const Vector& x) const = 0;

  virtual Real norm2(const Matrix& x) const = 0;

  virtual void mult(const Matrix& a, const Vector& x, Vector& r) const = 0;

  virtual void axpy(Real alpha, const Vector& x, Vector& y) const = 0;

  virtual void aypx(Real alpha, Vector& y, const Vector& x) const = 0;

  virtual void copy(const Vector& x, Vector& r) const = 0;

  virtual void copy(const Matrix& a, Matrix& r) const = 0;

  virtual void add(const Matrix& a, Matrix& r) const = 0;

  virtual Real dot(const Vector& x, const Vector& y) const = 0;

  virtual void scal(Real alpha, Vector& x) const = 0;

  virtual void scal(Real alpha, Matrix& a) const = 0;

  virtual void diagonal(const Matrix& a, Vector& x) const = 0;

  virtual void reciprocal(Vector& x) const = 0;

  virtual void pointwiseMult(const Vector& x, const Vector& y, Vector& w) const = 0;

  virtual void dump([[maybe_unused]] Matrix const& a, [[maybe_unused]] std::string const& filename) const
  {
    throw NotImplementedException(
    A_FUNCINFO, "IInternalLinearAlgebra::dump not implemented");
  }

  virtual void dump([[maybe_unused]] Vector const& x, [[maybe_unused]] std::string const& filename) const
  {
    throw NotImplementedException(
    A_FUNCINFO, "IInternalLinearAlgebra::dump not implemented");
  }

  virtual void mult(
  const Matrix& a, const UniqueArray<Real>& x, UniqueArray<Real>& r) const = 0;

  virtual void axpy(Real alpha, const UniqueArray<Real>& x, UniqueArray<Real>& y) const = 0;

  virtual void aypx(Real alpha, UniqueArray<Real>& y, const UniqueArray<Real>& x) const = 0;

  virtual void copy(const UniqueArray<Real>& x, UniqueArray<Real>& r) const = 0;

  virtual Real dot(Integer local_size, const UniqueArray<Real>& x,
                   const UniqueArray<Real>& y) const = 0;

  virtual void scal(Real alpha, UniqueArray<Real>& x) const = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Alien
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/