LinearSolverParameters.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2018-2020 Total, S.A
 * Copyright (c) 2019-     GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */

#ifndef GEOSX_LINEARALGEBRA_UTILITIES_LINEARSOLVERPARAMETERS_HPP_
#define GEOSX_LINEARALGEBRA_UTILITIES_LINEARSOLVERPARAMETERS_HPP_

#include "common/EnumStrings.hpp"

namespace geosx
{

struct LinearSolverParameters
{
  enum class SolverType : integer
  {
    direct,        
    cg,            
    gmres,         
    fgmres,        
    bicgstab,      
    preconditioner 
  };

  enum class PreconditionerType : integer
  {
    none,   
    jacobi, 
    gs,     
    sgs,    
    iluk,   
    ilut,   
    icc,    
    ict,    
    amg,    
    mgr,    
    block   
  };

  integer logLevel = 0;     
  integer dofsPerNode = 1;  
  bool isSymmetric = false; 
  integer stopIfError = 1;  

  SolverType solverType = SolverType::direct;                        
  PreconditionerType preconditionerType = PreconditionerType::iluk;  

  struct Direct
  {
    enum class ColPerm : integer
    {
      none,        
      MMD_AtplusA, 
      MMD_AtA,     
      colAMD,      
      metis,       
      parmetis     
    };

    enum class RowPerm : integer
    {
      none, 
      mc64  
    };

    integer checkResidual = 0;        
    integer equilibrate = 1;          
    ColPerm colPerm = ColPerm::metis; 
    RowPerm rowPerm = RowPerm::mc64;  
    integer replaceTinyPivot = 1;     
    integer iterativeRefine = 1;      
    integer parallel = 1;             
  }
  direct;                             

  struct Krylov
  {
    real64 relTolerance = 1e-6;       
    integer maxIterations = 200;      
    integer maxRestart = 200;         
    integer useAdaptiveTol = false;   
    real64 weakestTol = 1e-3;         
  }
  krylov;                             

  struct Scaling
  {
    integer useRowScaling = false;      
    integer useRowColScaling = false;   
  }
  scaling;                              

  struct AMG
  {
    integer maxLevels = 20;                  
    string cycleType = "V";                  
    string smootherType = "gaussSeidel";     
    string coarseType = "direct";            
    integer numSweeps = 2;                   
    string preOrPostSmoothing = "both";      
    real64 threshold = 0.0;                  
    integer separateComponents = false;      
    string nullSpaceType = "constantModes";  
  }
  amg;                                       

  struct MGR
  {
    string strategy;                    
    integer separateComponents = false; 
    string displacementFieldName;       
  }
  mgr;                                  

  struct ILU
  {
    integer fill = 0;        
    real64 threshold = 0.0;  
  }
  ilu;                       

  struct DD
  {
    integer overlap = 0;   
  }
  dd;                      
};

ENUM_STRINGS( LinearSolverParameters::SolverType,
              "direct",
              "cg",
              "gmres",
              "fgmres",
              "bicgstab",
              "preconditioner" )

ENUM_STRINGS( LinearSolverParameters::PreconditionerType,
              "none",
              "jacobi",
              "gs",
              "sgs",
              "iluk",
              "ilut",
              "icc",
              "ict",
              "amg",
              "mgr",
              "block" )

ENUM_STRINGS( LinearSolverParameters::Direct::ColPerm,
              "none",
              "MMD_AtplusA",
              "MMD_AtA",
              "colAMD",
              "metis",
              "parmetis" )

ENUM_STRINGS( LinearSolverParameters::Direct::RowPerm,
              "none",
              "mc64" )

} /* namespace geosx */

#endif /*GEOSX_LINEARALGEBRA_UTILITIES_LINEARSOLVERPARAMETERS_HPP_ */