KmlAmgPrecondCreate
创建预条件子句柄。
接口定义
C Interface：KmlAmgStatus KmlAmgPrecondCreate(KmlAmgPrecondH* precond, const KmlAmgPrecondOptions* options);
参数
参数名 |
类型 |
描述 |
输入/输出 |
|---|---|---|---|
precond |
KmlAmgPrecondH* |
预条件子句柄，precond不可为空指针 |
输入/输出 |
options |
const KmlAmgPrecondOptions* |
预条件子配置选项 |
输入 |
返回值
返回值 |
类型 |
描述 |
|---|---|---|
KMLAMG_SUCCESS |
int |
运行成功 |
KMLAMG_ERR_INVALID_PARAM |
int |
参数无效 |
KMLAMG_ERR_UNSUPPORTED |
int |
功能暂不支持 |
KMLAMG_ERR_NULL_POINTER |
int |
空指针 |
KMLAMG_ERR_NO_REQUIRED_FIELD |
int |
没有设置必需字段 |
KMLAMG_ERR_NO_MEMORY |
int |
内存分配失败 |
KMLAMG_ERR_UNKNOWN_TYPE |
int |
未知的类型 |
KMLAMG_ERR_UNEXPECTED_CALL_ORDER |
int |
预期之外的调用顺序 |
KMLAMG_ERR_NO_RESOURCE |
int |
资源未就绪 |
KMLAMG_ERR_INCONSISTENT |
int |
不同阶段传递的信息不一致 |
KMLAMG_ERR_UNKNOWN_ERROR |
int |
未知错误 |
结构体说明
KmlAmgPrecondOptions结构体描述：
字段名 |
类型 |
描述 |
|---|---|---|
fieldMask |
uint64_t |
配置生效的字段掩码。非0的位代表配置对应字段指定的值，0的位代表使用默认值，可配置的掩码位见具体字段的说明。 |
valueType |
KmlAmgValueType |
预条件子矩阵数值类型
掩码位：KMLAMG_PRECOND_OPTIONS_VALUE_TYPE |
indexType |
KmlAmgIndexType |
预条件子矩阵索引类型
掩码位：KMLAMG_PRECOND_OPTIONS_INDEX_TYPE |
precondType |
KmlAmgPrecondType |
预条件子类型有如下值： KMLAMG_PRECOND_AMG表示amg预条件子 掩码位：KMLAMG_PRECOND_OPTIONS_TYPE |
numThreads |
int32_t |
线程数 掩码位：KMLAMG_PRECOND_OPTIONS_NUM_THREADS |
依赖
#include "amg4c.h"