MathLib::LinearSolverOptionsParser< EigenLisLinearSolver > Struct Reference

Detailed Description

Definition at line 23 of file LinearSolverOptionsParser.h.

#include <LinearSolverOptionsParser.h>

Public Member Functions
std::tuple< std::string, std::string >	parseNameAndOptions (std::string const &prefix, BaseLib::ConfigTree const *const config) const

Member Function Documentation

parseNameAndOptions()

std::tuple< std::string, std::string > MathLib::LinearSolverOptionsParser< EigenLisLinearSolver >::parseNameAndOptions	(	std::string const &	prefix,
		BaseLib::ConfigTree const *const	config ) const

The method parses the linear solver options for LIS.

Parameters

prefix	the prefix for the linear solver to distinguish different linear solvers for instance in the staggered schema
config	the part of the property tree (usually created from the linear solver section in the project file)

Returns

the first item of the returned tuple is the solver prefix as string, the second item are all the options as a string that will be passed to LIS via lis_solver_set_options()

Input File Parameter

prj__linear_solvers__linear_solver__lis

Definition at line 22 of file LinearSolverOptionsParser.cpp.

{
    std::string lis_options = "-initx_zeros 0";
 
    if (config)
    {
        ignoreOtherLinearSolvers(*config, "lis");
        if (auto s = config->getConfigParameterOptional<std::string>("lis"))
        {
            if (!s->empty())
            {
                lis_options += " " + *s;
                INFO("Lis options: '{:s}'", lis_options);
            }
        }
    }
    return {prefix, lis_options};
}

References BaseLib::ConfigTree::getConfigParameterOptional(), MathLib::ignoreOtherLinearSolvers(), INFO(), and MathLib::s.

---

The documentation for this struct was generated from the following files:

• MathLib/LinAlg/EigenLis/LinearSolverOptionsParser.h
• MathLib/LinAlg/EigenLis/LinearSolverOptionsParser.cpp