MathLib::LinearSolverOptionsParser< PETScLinearSolver > Struct Reference

Detailed Description

Definition at line 24 of file LinearSolverOptionsParser.h.

#include <LinearSolverOptionsParser.h>

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

Member Function Documentation

parseNameAndOptions()

std::tuple< std::string, std::string > MathLib::LinearSolverOptionsParser< PETScLinearSolver >::parseNameAndOptions	(	std::string	solver_prefix,
		BaseLib::ConfigTree const *const	config ) const

The method parses the linear solver options for PETSc.

Parameters

solver_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 passed as string to PETSc options database

Input File Parameter

prj__linear_solvers__linear_solver__petsc

Input File Parameter

prj__linear_solvers__linear_solver__petsc__parameters

Input File Parameter

prj__linear_solvers__linear_solver__petsc__prefix

Definition at line 19 of file LinearSolverOptionsParser.cpp.

{
    // Insert options into petsc database. Default options are given in the
    // string below.
    std::string petsc_options =
        "-ksp_type cg -pc_type bjacobi -ksp_rtol 1e-16 -ksp_max_it 10000";
 
    if (config)
    {
        ignoreOtherLinearSolvers(*config, "petsc");
 
        if (auto const subtree = config->getConfigSubtreeOptional("petsc"))
        {
            if (auto const parameters =
                subtree->getConfigParameterOptional<std::string>("parameters"))
            {
                petsc_options = *parameters;
            }
 
            if (auto const pre =
                subtree->getConfigParameterOptional<std::string>("prefix"))
            {
                if (!pre->empty())
                    solver_prefix = *pre + "_";
            }
        }
    }
    return {solver_prefix, petsc_options};
}

References BaseLib::ConfigTree::getConfigSubtreeOptional(), and MathLib::ignoreOtherLinearSolvers().

---

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

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