solver_config.hpp

Go to the documentation of this file.

// Copyright (c) Lawrence Livermore National Security, LLC and
// other Smith Project Developers. See the top-level LICENSE file for
// details.
//
// SPDX-License-Identifier: (BSD-3-Clause)
 
#pragma once
 
#include <variant>
#include <vector>
 
#include "mfem.hpp"
#include "smith/infrastructure/format.hpp"
#include "smith/numerics/block_preconditioner.hpp"
 
namespace smith {
 
enum class TimestepMethod
{
  QuasiStatic, 
  // options for first order ODEs
  BackwardEuler,    
  SDIRK33,          
  ForwardEuler,     
  RK2,              
  RK3SSP,           
  RK4,              
  GeneralizedAlpha, 
  ImplicitMidpoint, 
  SDIRK23,          
  SDIRK34,          
  // options for second order ODEs
  //
  // note: we don't have a way to communicate
  //       parameters to the TimestepMethod,
  //       right now, so Newmark implies
  //       (beta = 0.25, gamma = 0.5)
  Newmark,             
  HHTAlpha,            
  WBZAlpha,            
  AverageAcceleration, 
  LinearAcceleration,  
  CentralDifference,   
  FoxGoodwin           
};
 
enum class DirichletEnforcementMethod
{
  DirectControl,
 
  RateControl,
 
  FullControl
};
 
struct TimesteppingOptions {
  TimestepMethod timestepper = TimestepMethod::QuasiStatic;
 
  DirichletEnforcementMethod enforcement_method = DirichletEnforcementMethod::RateControl;
};
 
// _linear_solvers_start
enum class LinearSolver
{
  CG,         
  GMRES,      
  SuperLU,    
  Strumpack,  
  PetscCG,    
  PetscGMRES, 
  None        
};
// _linear_solvers_end
 
inline std::string linearName(const LinearSolver& s)
{
  switch (s) {
    case LinearSolver::CG:
      return "CG";
    case LinearSolver::GMRES:
      return "GMRES";
    case LinearSolver::SuperLU:
      return "SuperLU";
    case LinearSolver::Strumpack:
      return "Strumpack";
    case LinearSolver::PetscCG:
      return "PetscCG";
    case LinearSolver::PetscGMRES:
      return "PetscGMRES";
    case LinearSolver::None:
      return "None";
  }
  // This cannot happen, but GCC doesn't know that
  return "UNKNOWN";
}
 
inline std::ostream& operator<<(std::ostream& os, LinearSolver s) { return os << linearName(s); }
 
inline std::map<std::string, LinearSolver> linearSolverMap = {
    {"CG", LinearSolver::CG},           {"GMRES", LinearSolver::GMRES},
    {"SuperLU", LinearSolver::SuperLU}, {"Strumpack", LinearSolver::Strumpack},
    {"PetscCG", LinearSolver::PetscCG}, {"PetscGMRES", LinearSolver::PetscGMRES},
    {"None", LinearSolver::None},
};
 
// Add a custom list of strings? conduit node?
// Arbitrary string (e.g. json) to define parameters?
 
// _nonlinear_solvers_start
enum class NonlinearSolver
{
  Newton,                    
  LBFGS,                     
  NewtonLineSearch,          
  TrustRegion,               
  KINFullStep,               
  KINBacktrackingLineSearch, 
  KINPicard,                 
  PetscNewton,               
  PetscNewtonBacktracking,   
  PetscNewtonCriticalPoint,  
  PetscTrustRegion           
};
// _nonlinear_solvers_end
 
inline std::string nonlinearName(const NonlinearSolver& s)
{
  switch (s) {
    case NonlinearSolver::Newton:
      return "Newton";
    case NonlinearSolver::LBFGS:
      return "LBFGS";
    case NonlinearSolver::NewtonLineSearch:
      return "NewtonLineSearch";
    case NonlinearSolver::TrustRegion:
      return "TrustRegion";
    case NonlinearSolver::KINFullStep:
      return "KINFullStep";
    case NonlinearSolver::KINBacktrackingLineSearch:
      return "KINBacktrackingLineSearch";
    case NonlinearSolver::KINPicard:
      return "KINPicard";
    case NonlinearSolver::PetscNewton:
      return "PetscNewton";
    case NonlinearSolver::PetscNewtonBacktracking:
      return "PetscNewtonBacktracking";
    case NonlinearSolver::PetscNewtonCriticalPoint:
      return "PetscNewtonCriticalPoint";
    case NonlinearSolver::PetscTrustRegion:
      return "PetscTrustRegion";
  }
  // This cannot happen, but GCC doesn't know that
  return "UNKNOWN";
}
 
inline std::ostream& operator<<(std::ostream& os, NonlinearSolver s) { return os << nonlinearName(s); }
 
inline std::map<std::string, NonlinearSolver> nonlinearSolverMap = {
    {"Newton", NonlinearSolver::Newton},
    {"LBFGS", NonlinearSolver::LBFGS},
    {"NewtonLineSearch", NonlinearSolver::NewtonLineSearch},
    {"TrustRegion", NonlinearSolver::TrustRegion},
    {"KINFullStep", NonlinearSolver::KINFullStep},
    {"KINBacktrackingLineSearch", NonlinearSolver::KINBacktrackingLineSearch},
    {"KINPicard", NonlinearSolver::KINPicard},
    {"PetscNewton", NonlinearSolver::PetscNewton},
    {"PetscNewtonBacktracking", NonlinearSolver::PetscNewtonBacktracking},
    {"PetscNewtonCriticalPoint", NonlinearSolver::PetscNewtonCriticalPoint},
    {"PetscTrustRegion", NonlinearSolver::PetscTrustRegion},
};
 
enum class AMGXSolver
{
  AMG,            
  PCGF,           
  CG,             
  PCG,            
  PBICGSTAB,      
  BICGSTAB,       
  FGMRES,         
  JACOBI_L1,      
  GS,             
  POLYNOMIAL,     
  KPZ_POLYNOMIAL, 
  BLOCK_JACOBI,   
  MULTICOLOR_GS,  
  MULTICOLOR_DILU 
};
 
struct AMGXOptions {
  AMGXSolver solver = AMGXSolver::AMG;
  AMGXSolver smoother = AMGXSolver::JACOBI_L1;
  bool verbose = false;
};
 
struct AMGFContactOptions {
  int relax_type = 88;  // l1-hybrid symmetric Gauss-Seidel smoother
  int dim_systems_options =
      3;  // geometric dimension of problem, used to set more robust options for systems such as elasticity
};
 
enum class PetscPCType
{
  JACOBI,        
  JACOBI_L1,     
  JACOBI_ROWSUM, 
  JACOBI_ROWMAX, 
  PBJACOBI,      
  BJACOBI,       
  LU,            
  ILU,           
  CHOLESKY,      
  SVD,           
  ASM,  
  GASM, 
  GAMG, 
  HMG,  
  NONE, 
};
 
inline std::string petscPCName(const PetscPCType& s)
{
  switch (s) {
    case PetscPCType::JACOBI:
      return "JACOBI";
    case PetscPCType::JACOBI_L1:
      return "JACOBI_L1";
    case PetscPCType::JACOBI_ROWSUM:
      return "JACOBI_ROWSUM";
    case PetscPCType::JACOBI_ROWMAX:
      return "JACOBI_ROWMAX";
    case PetscPCType::PBJACOBI:
      return "PBJACOBI";
    case PetscPCType::BJACOBI:
      return "BJACOBI";
    case PetscPCType::LU:
      return "LU";
    case PetscPCType::ILU:
      return "ILU";
    case PetscPCType::CHOLESKY:
      return "CHOLESKY";
    case PetscPCType::SVD:
      return "SVD";
    case PetscPCType::ASM:
      return "ASM";
    case PetscPCType::GASM:
      return "GASM";
    case PetscPCType::GAMG:
      return "GAMG";
    case PetscPCType::HMG:
      return "HMG";
    case PetscPCType::NONE:
      return "NONE";
  }
  // This cannot happen, but GCC doesn't know that
  return "UNKNOWN";
}
 
inline std::ostream& operator<<(std::ostream& os, PetscPCType s) { return os << petscPCName(s); }
 
// _preconditioners_start
enum class Preconditioner
{
  HypreJacobi,      
  HypreL1Jacobi,    
  HypreGaussSeidel, 
  HypreAMG,         
  HypreILU,         
  AMGX,             
  Petsc,            
  AMGFContact,      
  BlockDiagonal,    
  BlockTriangular,  
  BlockSchur,       
  None              
};
// _preconditioners_end
 
inline std::string preconditionerName(Preconditioner p)
{
  switch (p) {
    case Preconditioner::HypreJacobi:
      return "HypreJacobi";
    case Preconditioner::HypreL1Jacobi:
      return "HypreL1Jacobi";
    case Preconditioner::HypreGaussSeidel:
      return "HypreGaussSeidel";
    case Preconditioner::HypreAMG:
      return "HypreAMG";
    case Preconditioner::HypreILU:
      return "HypreILU";
    case Preconditioner::AMGX:
      return "AMGX";
    case Preconditioner::Petsc:
      return "Petsc";
    case Preconditioner::AMGFContact:
      return "AMGFContact";
    case Preconditioner::BlockDiagonal:
      return "BlockDiagonal";
    case Preconditioner::BlockTriangular:
      return "BlockTriangular";
    case Preconditioner::BlockSchur:
      return "BlockSchur";
    case Preconditioner::None:
      return "None";
  }
  // This cannot happen, but GCC doesn't know that
  return "UNKNOWN";
}
 
inline std::ostream& operator<<(std::ostream& os, Preconditioner p) { return os << preconditionerName(p); }
 
inline std::map<std::string, Preconditioner> preconditionerMap = {
    {"HypreJacobi", Preconditioner::HypreJacobi},
    {"HypreL1Jacobi", Preconditioner::HypreL1Jacobi},
    {"HypreGaussSeidel", Preconditioner::HypreGaussSeidel},
    {"HypreAMG", Preconditioner::HypreAMG},
    {"HypreILU", Preconditioner::HypreILU},
    {"AMGX", Preconditioner::AMGX},
    {"Petsc", Preconditioner::Petsc},
    {"AMGFContact", Preconditioner::AMGFContact},
    {"BlockDiagonal", Preconditioner::BlockDiagonal},
    {"BlockTriangular", Preconditioner::BlockTriangular},
    {"BlockSchur", Preconditioner::BlockSchur},
    {"None", Preconditioner::None},
};
 
// _linear_options_start
struct LinearSolverOptions {
  LinearSolver linear_solver = LinearSolver::GMRES;
 
  Preconditioner preconditioner = Preconditioner::HypreJacobi;
 
  AMGXOptions amgx_options = AMGXOptions{};
 
  AMGFContactOptions amgfcontact_options = AMGFContactOptions{};
 
  PetscPCType petsc_preconditioner = PetscPCType::JACOBI;
 
  double relative_tol = 1.0e-8;
 
  double absolute_tol = 1.0e-12;
 
  int max_iterations = 300;
 
  int print_level = 0;
 
  int preconditioner_print_level = 0;
 
  std::vector<LinearSolverOptions> sub_block_linear_solver_options = {};
 
  BlockTriangularType block_triangular_type = BlockTriangularType::Lower;
 
  BlockSchurType block_schur_type = BlockSchurType::Full;
 
  SchurApproxType schur_approx_type = SchurApproxType::DiagInv;
};
// _linear_options_end
 
enum SubSpaceOptions
{
  NEVER,
  WHEN_INDEFINITE,
  WHEN_INDEFINITE_OR_BOUNDARY,
  ALWAYS
};
 
// _nonlinear_options_start
struct NonlinearSolverOptions {
  NonlinearSolver nonlin_solver = NonlinearSolver::NewtonLineSearch;
 
  double relative_tol = 1.0e-8;
 
  double absolute_tol = 1.0e-12;
 
  int min_iterations = 0;
 
  int max_iterations = 20;
 
  int max_line_search_iterations = 8;
 
  int print_level = 0;
 
  double trust_region_scaling = 0.1;
 
  SubSpaceOptions subspace_option = SubSpaceOptions::NEVER;
 
  int num_leftmost = 1;
};
// _nonlinear_options_end
 
}  // namespace smith
 
// std::format support for Smith solver enums
namespace std {
template <>
struct formatter<smith::NonlinearSolver> : smith::format::OstreamFormatter {};
 
template <>
struct formatter<smith::LinearSolver> : smith::format::OstreamFormatter {};
 
template <>
struct formatter<smith::Preconditioner> : smith::format::OstreamFormatter {};
 
template <>
struct formatter<smith::PetscPCType> : smith::format::OstreamFormatter {};
}  // namespace std