KmlMgSolverQuery

查询求解器配置信息。

接口定义

C Interface:

KmlMgStatus KmlMgSolverQuery(KmlMgSolverH solver, KmlMgSolverInfo* info);

参数

参数名

类型

描述

输入/输出

solver

KmlMgSolverH

由KmlMgSolverCreate创建的求解器句柄

输入/输出

info

KmlMgSolverInfo*

用于保存用户查询的求解器信息结果

输出

返回值

返回值

类型

描述

KML_MG_OK

int

正常执行

KML_MG_ERR_INVALID_PARAM

int

参数无效

KML_MG_ERR_UNSUPPORTED

int

暂不支持的功能

KML_MG_ERR_NO_MEMORY

int

分配内存失败

KML_MG_ERR_EXCEEDS_LIMIT

int

超过设置限制

KML_MG_ERR_INCOMPATIBLE

int

版本不兼容

KML_MG_ERR_NO_REQUIRED_FIELD

int

没设置必填字段

KML_MG_ERR_UNKNOWN_TYPE

int

未知的类型

KML_MG_ERR_THIRD_PART

int

内部调用第三方错误

KML_MG_ERR_INCONSISTENT

int

传递信息不一致

KML_MG_ERR_UNEXPECTED_CALL_ORDER

int

预期之外的调用顺序

KML_MG_ERR_MATRIX_VALUE_IS_NULL

int

矩阵值为空

KML_MG_ERR_NO_RESOURCE

int

资源未就绪

结构体说明

KmlMgSolverInfo

字段名

字段类型

字段说明

fieldMask

uint64_t

配置生效的字段掩码。非0的位代表配置对应字段指定的值,0的位代表使用默认值,可配置的掩码位请参见具体字段的说明。

ksp

KmlMgSolverKsp

KmlMgSolverOptions的ksp字段,详细说明见KmlMgSolverOptions

掩码位:KML_MG_SOLVER_INFO_KSP_TYPE

useZeroGuess

bool

KmlMgApplyOptions的useZeroGuess字段,详细说明见KmlMgApplyOptions

掩码位:KML_MG_SOLVER_INFO_USE_ZERO_GUESS

toleranceType

KmlMgToleranceType

KmlMgApplyOptions的toleranceType字段,详细说明见KmlMgApplyOptions

掩码位:KML_MG_SOLVER_INFO_TOLERANCE_TYPE

tolerance

double

KmlMgApplyOptions的tolerance字段,详细说明见KmlMgApplyOptions

掩码位:KML_MG_SOLVER_INFO_TOLERANCE

maxIteration

int64_t

KmlMgApplyOptions的maxIteration字段,详细说明见KmlMgApplyOptions

掩码位:KML_MG_SOLVER_INFO_MAX_ITERATION

restartStep

int64_t

KmlMgApplyOptions的KML_MGrestartStep字段,详细说明见KmlMgApplyOptions,仅当KmlMgSolverOptions.ksp为KML_MG_SOLVER_GCR或KML_MG_SOLVER_GMRES时生效

掩码位:KML_MG_SOLVER_INFO_RESTART_STEP

solveResi

bool

KmlMgApplyOptions的solveResi字段,详细说明见KmlMgApplyOptions,仅当KmlMgSolverOptions.ksp为KML_MG_SOLVER_GCR时生效

掩码位:KML_MG_SOLVER_INFO_SOLVE_RESI

依赖

#include "mg.h"

示例代码请参见示例