MathLib::LisOption Struct Reference

Detailed Description

Option for Lis solver.

Options are stored as a string obtained from the lis-tag of the passed options. The string will be passed as is to Lis. In particular it will not be checked by this method if options are valid.

For possible values, please refer to the Lis User Guide: http://www.ssisc.org/lis/lis-ug-en.pdf

Note: Option -omp_num_threads cannot be used with this class since Lis currently (version 1.5.57) only sets the number of threads in lis_initialize(). Refer to the Lis source code for details.

Definition at line 40 of file LisOption.h.

#include <LisOption.h>

Public Member Functions
	LisOption (BaseLib::ConfigTree const *const options)

Public Attributes
std::string	_option_string = "-initx_zeros 0"

Constructor & Destructor Documentation

LisOption()

MathLib::LisOption::LisOption ( BaseLib::ConfigTree const *const  options )

inlineexplicit

Input File Parameter:

prj__linear_solvers__linear_solver__lis

Definition at line 42 of file LisOption.h.

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

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

Member Data Documentation

_option_string

std::string MathLib::LisOption::_option_string = "-initx_zeros 0"

Definition at line 56 of file LisOption.h.

Referenced by LisOption(), and MathLib::LisLinearSolver::solve().

---

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

• MathLib/LinAlg/Lis/LisOption.h