LinearSolverParameters.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_PHYSICSSOLVERS_LINEARSOLVERPARAMETERS_HPP_
#define GEOS_PHYSICSSOLVERS_LINEARSOLVERPARAMETERS_HPP_
 
#include "dataRepository/Group.hpp"
#include "linearAlgebra/utilities/LinearSolverParameters.hpp"
 
namespace geos
{
 
class LinearSolverParametersInput : public dataRepository::Group
{
public:
 
  LinearSolverParametersInput() = delete;
 
  LinearSolverParametersInput( string const & name, Group * const parent );
 
  LinearSolverParametersInput( LinearSolverParametersInput && ) = default;
 
  virtual ~LinearSolverParametersInput() override = default;
 
  static string catalogName() { return "LinearSolverParameters"; }
 
  virtual void postInputInitialization() override;
 
  void print();
 
  LinearSolverParameters const & get() const
  { return m_parameters; }
 
  LinearSolverParameters & get()
  { return m_parameters; }
 
  struct viewKeyStruct
  {
    static constexpr char const * solverTypeString() { return "solverType"; }
    static constexpr char const * preconditionerTypeString() { return "preconditionerType"; }
    static constexpr char const * stopIfErrorString() { return "stopIfError"; }
 
    static constexpr char const * directCheckResidualString() { return "directCheckResidual"; }
    static constexpr char const * directEquilString() { return "directEquil"; }
    static constexpr char const * directColPermString() { return "directColPerm"; }
    static constexpr char const * directRowPermString() { return "directRowPerm"; }
    static constexpr char const * directReplTinyPivotString() { return "directReplTinyPivot"; }
    static constexpr char const * directIterRefString() { return "directIterRef"; }
    static constexpr char const * directParallelString() { return "directParallel"; }
 
    static constexpr char const * krylovMaxIterString() { return "krylovMaxIter"; }
    static constexpr char const * krylovMaxRestartString() { return "krylovMaxRestart"; }
    static constexpr char const * krylovTolString() { return "krylovTol"; }
    static constexpr char const * krylovAdaptiveTolString() { return "krylovAdaptiveTol"; }
    static constexpr char const * krylovWeakTolString() { return "krylovWeakestTol"; }
    static constexpr char const * krylovStrongTolString() { return "krylovStrongestTol"; }
    static constexpr char const * adaptiveGammaString() { return "adaptiveGamma"; }
    static constexpr char const * adaptiveExponentString() { return "adaptiveExponent"; }
 
    static constexpr char const * amgNumSweepsString() { return "amgNumSweeps"; }
    static constexpr char const * amgSmootherString() { return "amgSmootherType"; }
    static constexpr char const * amgRelaxWeight() { return "amgRelaxWeight"; }
    static constexpr char const * amgCoarseString() { return "amgCoarseSolver"; }
    static constexpr char const * amgThresholdString() { return "amgThreshold"; }
    static constexpr char const * amgNullSpaceTypeString() { return "amgNullSpaceType"; }
    static constexpr char const * amgCoarseningString() { return "amgCoarseningType"; }
    static constexpr char const * amgInterpolationString() { return "amgInterpolationType"; }
    static constexpr char const * amgInterpMaxNonZerosString() { return "amgInterpolationMaxNonZeros"; }
    static constexpr char const * amgNumFunctionsString() { return "amgNumFunctions"; }
    static constexpr char const * amgAggressiveNumPathsString() { return "amgAggressiveCoarseningPaths"; }
    static constexpr char const * amgAggressiveNumLevelsString() { return "amgAggressiveCoarseningLevels"; }
    static constexpr char const * amgAggressiveInterpTypeString() { return "amgAggressiveInterpType"; }
    static constexpr char const * amgSeparateComponentsString() { return "amgSeparateComponents"; }
 
    static constexpr char const * iluFillString() { return "iluFill"; }
    static constexpr char const * iluThresholdString() { return "iluThreshold"; }
  };
 
private:
 
  LinearSolverParameters m_parameters;
 
};
 
} // namespace geos
 
#endif //GEOS_PHYSICSSOLVERS_LINEARSOLVERPARAMETERS_HPP_