itkFEMLinearSystemWrapperItpack.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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.txt
 *
 *  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.
 *
 *=========================================================================*/

#ifndef itkFEMLinearSystemWrapperItpack_h
#define itkFEMLinearSystemWrapperItpack_h

#include "itkFEMSolution.h"
#include "itkFEMLinearSystemWrapper.h"
#include "itkFEMItpackSparseMatrix.h"
#include "ITKFEMExport.h"
#include <vector>

typedef long   integer;
typedef double doublereal;

extern "C" {
typedef
int ( *ItkItpackSolverFunction )(integer *, integer *, integer *, doublereal *, doublereal *, doublereal *, integer *,
                                 integer *, doublereal *,
                                 integer *, doublereal *, integer *);
}

namespace itk
{
namespace fem
{
class ITKFEM_EXPORT LinearSystemWrapperItpack : public LinearSystemWrapper
{
public:

  typedef LinearSystemWrapperItpack Self;

  typedef LinearSystemWrapper Superclass;

  typedef ItpackSparseMatrix MatrixRepresentation;

  typedef std::vector<MatrixRepresentation> MatrixHolder;

  /* auto pointer to vector of matrices typedef */
  /* typedef std::auto_ptr<MatrixHolder> MatrixArrayPtr; */

  /* typedef std::auto_ptr<double> VectorRepresentation; */
  typedef double *VectorRepresentation;

  typedef std::vector<VectorRepresentation> VectorHolder;

  /* auto pointer to vector of vectors typedef */
  /* typedef std::auto_ptr<VectorHolder> VectorArrayPtr; */

  /* pointer to array of unsigned int typedef */
  /* typedef std::auto_ptr<unsigned int> UnsignedIntegerArrayPtr; */

  /* -----------------------------------------------------------------
   *
   * Routines for setting/reporting itpack parameters
   *
   * -----------------------------------------------------------------
   */

  void SetMaximumNumberIterations(int i)
  {
    m_IPARM[0] = i;
  }

  int  GetMaximumNumberIterations() const
  {
    return m_IPARM[0];
  }

  // void SetErrorReportingLevel(int i) {   m_IPARM[1] = i; }

  int  GetErrorReportingLevel() const
  {
    return m_IPARM[1];
  }

  void SetCommunicationSwitch(int i)
  {
    m_IPARM[2] = i;
  }

  int  GetCommunicationSwitch() const
  {
    return m_IPARM[2];
  }

  // void SetOutputNumber(int i) {   m_IPARM[3] = i; }

  int  GetOutputNumber() const
  {
    return m_IPARM[3];
  }

  void SetSymmetricMatrixFlag(int i)
  {
    m_IPARM[4] = i;
  }

  int  GetSymmetricMatrixFlag()
  {
    return m_IPARM[4];
  }

  void SetAdaptiveSwitch(int i)
  {
    m_IPARM[5] = i;
  }

  int  GetAdaptiveSwitch() const
  {
    return m_IPARM[5];
  }

  void SetAdaptiveCaseSwitch(int i)
  {
    m_IPARM[6] = i;
  }

  int  GetAdaptiveCaseSwitch() const
  {
    return m_IPARM[6];
  }

  void SetWorkspaceUsed(int i)
  {
    m_IPARM[7] = i;
  }

  int  GetWorkspaceUsed()
  {
    return m_IPARM[7];
  }

  void SetRedBlackOrderingSwitch(int i)
  {
    m_IPARM[8] = i;
  }

  int  GetRedBlackOrderingSwitch()
  {
    return m_IPARM[8];
  }

  void SetRemoveSwitch(int i)
  {
    m_IPARM[9] = i;
  }

  int  GetRemoveSwitch()
  {
    return m_IPARM[9];
  }

  void SetTimingSwitch(int i)
  {
    m_IPARM[10] = i;
  }

  int  GetTimingSwitch()
  {
    return m_IPARM[10];
  }

  void SetErrorAnalysisSwitch(int i)
  {
    m_IPARM[11] = i;
  }

  int  GetErrorAnalysisSwitch() const
  {
    return m_IPARM[11];
  }

  void   SetAccuracy(double i)
  {
    m_RPARM[0] = i;
  }

  double GetAccuracy() const
  {
    return m_RPARM[0];
  }

  void   SetLargestJacobiEigenvalueEstimate(double i)
  {
    m_RPARM[1] = i;
  }

  double GetLargestJacobiEigenvalueEstimate() const
  {
    return m_RPARM[1];
  }

  void   SetSmallestJacobiEigenvalueEstimate(double i)
  {
    m_RPARM[2] = i;
  }

  double GetSmallestJacobiEigenvalueEstimate()
  {
    return m_RPARM[2];
  }

  void   SetDampingFactor(double i)
  {
    m_RPARM[3] = i;
  }

  double GetDampingFactor() const
  {
    return m_RPARM[3];
  }

  void   SetOverrelaxationParameter(double i)
  {
    m_RPARM[4] = i;
  }

  double GetOverrelaxationParameter()
  {
    return m_RPARM[4];
  }

  void   SetEstimatedSpectralRadiusSSOR(double i)
  {
    m_RPARM[5] = i;
  }

  double GetEstimatedSpectralRadiusSSOR() const
  {
    return m_RPARM[5];
  }

  void   SetEstimatedSpectralRadiusLU(double i)
  {
    m_RPARM[6] = i;
  }

  double GetEstimatedSpectralRadiusLU() const
  {
    return m_RPARM[6];
  }

  void   SetTolerance(double i)
  {
    m_RPARM[7] = i;
  }

  double GetTolerance()
  {
    return m_RPARM[7];
  }

  void   SetTimeToConvergence(double i)
  {
    m_RPARM[8] = i;
  }

  double GetTimeToConvergence()
  {
    return m_RPARM[8];
  }

  void   SetTimeForCall(double i)
  {
    m_RPARM[9] = i;
  }

  double GetTimeForCall()
  {
    return m_RPARM[9];
  }

  void   SetDigitsInError(double i)
  {
    m_RPARM[10] = i;
  }

  double GetDigitsInError() const
  {
    return m_RPARM[10];
  }

  void   SetDigitsInResidual(double i)
  {
    m_RPARM[11] = i;
  }

  double GetDigitsInResidual() const
  {
    return m_RPARM[11];
  }

  void JacobianConjugateGradient()
  {
    m_Method = 0;
  }

  void JacobianSemiIterative()
  {
    m_Method = 1;
  }

  void SuccessiveOverrelaxation()
  {
    m_Method = 2;
  }

  void SymmetricSuccessiveOverrelaxationConjugateGradient()
  {
    m_Method = 3;
  }

  void SymmetricSuccessiveOverrelaxationSuccessiveOverrelaxation()
  {
    m_Method = 4;
  }

  void ReducedSystemConjugateGradient()
  {
    m_Method = 5;
  }

  void ReducedSystemSemiIteration()
  {
    m_Method = 6;
  }

  virtual void SetMaximumNonZeroValuesInMatrix(unsigned int maxNonZeroValues)
  {
    m_MaximumNonZeroValues =
      maxNonZeroValues;
  }

  virtual void ScaleMatrix(Float scale, unsigned int matrixIndex) ITK_OVERRIDE;

  LinearSystemWrapperItpack();

  ~LinearSystemWrapperItpack() ITK_OVERRIDE;

  /* memory management routines */
  virtual void  InitializeMatrix(unsigned int matrixIndex) ITK_OVERRIDE;

  virtual bool  IsMatrixInitialized(unsigned int matrixIndex) ITK_OVERRIDE;

  virtual void  DestroyMatrix(unsigned int matrixIndex) ITK_OVERRIDE;

  virtual void  InitializeVector(unsigned int vectorIndex) ITK_OVERRIDE;

  virtual bool  IsVectorInitialized(unsigned int vectorIndex) ITK_OVERRIDE;

  virtual void  DestroyVector(unsigned int vectorIndex) ITK_OVERRIDE;

  virtual void  InitializeSolution(unsigned int solutionIndex) ITK_OVERRIDE;

  virtual bool  IsSolutionInitialized(unsigned int solutionIndex) ITK_OVERRIDE;

  virtual void  DestroySolution(unsigned int solutionIndex) ITK_OVERRIDE;

  /* assembly & solving routines */
  virtual Float GetMatrixValue(unsigned int i, unsigned int j, unsigned int matrixIndex) const ITK_OVERRIDE;

  virtual void  SetMatrixValue(unsigned int i, unsigned int j, Float value, unsigned int matrixIndex) ITK_OVERRIDE;

  virtual void  AddMatrixValue(unsigned int i, unsigned int j, Float value, unsigned int matrixIndex) ITK_OVERRIDE;

  virtual void GetColumnsOfNonZeroMatrixElementsInRow(unsigned int row, ColumnArray & cols, unsigned int matrixIndex) ITK_OVERRIDE;

  virtual Float GetVectorValue(unsigned int i, unsigned int vectorIndex) const ITK_OVERRIDE;

  virtual void  SetVectorValue(unsigned int i, Float value, unsigned int vectorIndex) ITK_OVERRIDE;

  virtual void  AddVectorValue(unsigned int i, Float value, unsigned int vectorIndex) ITK_OVERRIDE;

  virtual Float GetSolutionValue(unsigned int i, unsigned int solutionIndex) const ITK_OVERRIDE;

  virtual void  SetSolutionValue(unsigned int i, Float value, unsigned int solutionIndex) ITK_OVERRIDE;

  virtual void  AddSolutionValue(unsigned int i, Float value, unsigned int solutionIndex) ITK_OVERRIDE;

  virtual void  Solve(void) ITK_OVERRIDE;

  /* matrix & vector manipulation routines */
  virtual void  SwapMatrices(unsigned int matrixIndex1, unsigned int matrixIndex2) ITK_OVERRIDE;

  virtual void  SwapVectors(unsigned int vectorIndex1, unsigned int vectorIndex2) ITK_OVERRIDE;

  virtual void  SwapSolutions(unsigned int solutionIndex1, unsigned int solutionIndex2) ITK_OVERRIDE;

  virtual void  CopySolution2Vector(unsigned solutionIndex, unsigned int vectorIndex) ITK_OVERRIDE;

  virtual void  CopyVector2Solution(unsigned int vectorIndex, unsigned int solutionIndex) ITK_OVERRIDE;

  virtual void  MultiplyMatrixMatrix(unsigned int resultMatrixIndex, unsigned int leftMatrixIndex,
                                     unsigned int rightMatrixIndex) ITK_OVERRIDE;

  virtual void  MultiplyMatrixVector(unsigned int resultVectorIndex, unsigned int matrixIndex, unsigned int vectorIndex) ITK_OVERRIDE;

  virtual void MultiplyMatrixSolution(unsigned int resultVectorIndex, unsigned int matrixIndex, unsigned int solutionIndex) ITK_OVERRIDE;

private:

  MatrixHolder *m_Matrices;

  VectorHolder *m_Vectors;

  VectorHolder *m_Solutions;

  // UnsignedIntegerArrayPtr m_MaximumNonZeroValues;
  unsigned int m_MaximumNonZeroValues;

  ItkItpackSolverFunction m_Methods[7];

  integer m_Method;

  integer m_IPARM[12];

  doublereal m_RPARM[12];
};

class ITK_ABI_EXPORT FEMExceptionItpackSolver : public FEMException
{
public:

  typedef long integer;

  FEMExceptionItpackSolver(const char *file, unsigned int lineNumber, std::string location, integer errorCode);

  virtual ~FEMExceptionItpackSolver() ITK_NOEXCEPT ITK_OVERRIDE {}

  itkTypeMacro(FEMExceptionItpackSolver, FEMException);
};
}
}  // end namespace itk::fem

#endif // #ifndef itkFEMLinearSystemWrapperItpack_h