solver_config.hpp

Go to the documentation of this file.

// Copyright (c) 2019-2024, Lawrence Livermore National Security, LLC and
// other Serac Project Developers. See the top-level LICENSE file for
// details.
//
// SPDX-License-Identifier: (BSD-3-Clause)
 
#pragma once
 
#include <variant>
 
#include "mfem.hpp"
 
namespace serac {
 
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 
};
// _linear_solvers_end
 
// Add a custom list of strings? conduit node?
// Arbitrary string (e.g. json) to define parameters?
 
// _nonlinear_solvers_start
enum class NonlinearSolver
{
  Newton,                    
  LBFGS,                     
  KINFullStep,               
  KINBacktrackingLineSearch, 
  KINPicard                  
};
// _nonlinear_solvers_end
 
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;
};
 
// _preconditioners_start
enum class Preconditioner
{
  HypreJacobi,      
  HypreL1Jacobi,    
  HypreGaussSeidel, 
  HypreAMG,         
  HypreILU,         
  AMGX,             
  None              
};
// _preconditioners_end
 
// _linear_options_start
struct LinearSolverOptions {
  LinearSolver linear_solver = LinearSolver::GMRES;
 
  Preconditioner preconditioner = Preconditioner::HypreJacobi;
 
  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;
};
// _linear_options_end
 
// _nonlinear_options_start
struct NonlinearSolverOptions {
  NonlinearSolver nonlin_solver = NonlinearSolver::Newton;
 
  double relative_tol = 1.0e-8;
 
  double absolute_tol = 1.0e-12;
 
  int max_iterations = 20;
 
  int print_level = 0;
};
// _nonlinear_options_end
 
}  // namespace serac