LinearSolver.h

Go to the documentation of this file.

/*
 * Copyright 2020 IFPEN-CEA
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#pragma once
 
#include <alien/utils/Precomp.h>
 
#include <memory>
 
#include <arccore/base/NotImplementedException.h>
#include <arccore/base/TraceInfo.h>
 
#include <alien/core/backend/BackEnd.h>
#include <alien/core/backend/IInternalLinearSolverT.h>
 
#include <alien/expression/solver/ILinearSolver.h>
 
#include <alien/expression/solver/SolverStater.h>
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Alien
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class Space;
class IVector;
class IMatrix;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <class Tag>
class LinearSolver : public ILinearSolver
{
 public:
  typedef typename AlgebraTraits<Tag>::solver_type KernelSolver;
 
 public:
  template <typename... T>
  LinearSolver(T... args)
  : m_solver(AlgebraTraits<Tag>::solver_factory(args...))
  , m_stater(m_solver.get())
  {}

  virtual ~LinearSolver();

  Arccore::String getBackEndName() const;

  void init();

  void end();

  void updateParallelMng(Arccore::MessagePassing::IMessagePassingMng* pm);

  bool solve(const IMatrix& A, const IVector& b, IVector& x);

  const SolverStat& getSolverStat() const;

  bool hasParallelSupport() const;

  const SolverStatus& getStatus() const;

  std::shared_ptr<ILinearAlgebra> algebra() const;

  KernelSolver* implem();

  virtual void setNullSpaceConstantOption([[maybe_unused]] bool flag)
  {
    throw NotImplementedException(A_FUNCINFO);
  }
 
 private:
  std::unique_ptr<KernelSolver> m_solver;
  SolverStater<KernelSolver> m_stater;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Alien
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/