10 固有値ソルバ共通のメンバ関数
power, inverse_power, ks_arnoldi が共通に持つ関数である (parcel::krylov::eigen_param から継承). set_linsolve_* は逆べき乗法と Krylov-Schur 法の shift-invert の内部線形ソルバの設定であり, power とシフトなしの ks_arnoldi では使われない. 内部線形ソルバの既定値はソルバごとに異なる (共通事項の設定). 内部 pgmres の直交化は修正 Gram-Schmidt 法に固定である. 固有値ソルバの設定の考え方は共通事項の「固有値ソルバの補足」に示す.
10.1 set_precon_spectrum() / get_precon_spectrum()
概要 固有値を求める行列を と から選ぶ.
書式
void set_precon_spectrum(bool f);
bool get_precon_spectrum() const;引数
| 名前 | 入出力 | 型 | 説明 | 既定値 |
|---|---|---|---|---|
f |
入力 | bool |
false: の固有値を求める. 外側の固有値反復は前処理を使わない. true: の固有値を求める. は set_precon_algo() などの設定で から作る |
false |
MPI 局所操作. 全ランクで同じ値を与える.
注意 true のとき, 内部線形ソルバ (inverse_power, ks_arnoldi の shift-invert) は右前処理 pgmres が を解いて を返す形になり, 前処理は そのものである (set_linsolve_precon_algo() などと ShiftMat は使わない).
関連項目 set_precon_algo(), 固有値ソルバの章
例
pw.set_precon_algo(parcel::PRECON_JACOBI); pw.set_precon_spectrum(true); // A K^-1 の最大固有値10.2 set_linsolve_algo() / get_linsolve_algo()
概要 inverse_power の内部線形ソルバの種類を設定・取得する.
書式
void set_linsolve_algo(PARCEL_INT algo);
PARCEL_INT get_linsolve_algo() const;引数
| 名前 | 入出力 | 型 | 説明 | 既定値 |
|---|---|---|---|---|
algo |
入力 | PARCEL_INT |
parcel: (0, 右前処理 pgmres) または LINSOLVE_PCG (1,pcg) |
LINSOLVE_PGMRES |
前提条件 LINSOLVE_PGMRES または LINSOLVE_PCG. それ以外の値は std::invalid_argument. LINSOLVE_PCG は が対称 (正定値または負定値) の場合に限る (検査しない). set_precon_spectrum(true) のときは指定によらず pgmres を使う.
MPI 局所操作. 全ランクで同じ値を与える.
注意 inverse_power の set_precon_spectrum(false) のときだけ有効である. ks_arnoldi の shift-invert は常に pgmres を使う.
例
ip.set_linsolve_algo(parcel::krylov::LINSOLVE_PCG);10.3 set_linsolve_tolerance() / get_linsolve_tolerance()
概要 内部線形ソルバの収束判定値 (相対残差) を設定・取得する.
書式
void set_linsolve_tolerance(double tol);
double get_linsolve_tolerance() const;引数
| 名前 | 入出力 | 型 | 説明 | 既定値 |
|---|---|---|---|---|
tol |
入力 | double |
内部線形ソルバの収束判定値 | 1.0e-10 |
前提条件 有限の正の値. 0 以下, NaN, Inf は std::invalid_argument.
MPI 局所操作. 全ランクで同じ値を与える.
注意 内部線形ソルバが収束しなくても外側の反復は続く. 収束しなかった回数は get_linsolve_failures() で得る.
10.4 set_linsolve_max_iteration() / get_linsolve_max_iteration()
概要 内部線形ソルバの最大反復回数を設定・取得する.
書式
void set_linsolve_max_iteration(PARCEL_INT itr);
PARCEL_INT get_linsolve_max_iteration() const;引数
| 名前 | 入出力 | 型 | 説明 | 既定値 |
|---|---|---|---|---|
itr |
入力 | PARCEL_INT |
内部線形ソルバの最大反復回数 (pgmres では内側反復の総数) |
inverse_power 5000, ks_arnoldi 2000 |
前提条件 1 以上. 0 以下は std::invalid_argument. 内部が pgmres の場合も set_linsolve_restart() の値の倍数でなくてよく, 周期より小さくてもよい (上限ちょうどまで反復する).
MPI 局所操作. 全ランクで同じ値を与える.
10.5 set_linsolve_restart() / get_linsolve_restart()
概要 内部 pgmres のリスタート周期を設定・取得する.
書式
void set_linsolve_restart(PARCEL_INT m);
PARCEL_INT get_linsolve_restart() const;引数
| 名前 | 入出力 | 型 | 説明 | 既定値 |
|---|---|---|---|---|
m |
入力 | PARCEL_INT |
内部線形ソルバのリスタート周期 | 30 |
前提条件 1 以上. 0 以下は std::invalid_argument.
MPI 局所操作. 全ランクで同じ値を与える.
注意 内部ソルバが pcg のときは使われない.
10.6 set_linsolve_precon_algo() / set_linsolve_blockjacobi() / set_linsolve_jacobi() / get_linsolve_precon_param()
概要 内部線形ソルバの前処理 の種類, ブロック Jacobi のブロック数, Jacobi の反復回数を設定する.
書式
void set_linsolve_precon_algo(PARCEL_INT algo);
void set_linsolve_blockjacobi(PARCEL_INT nblock);
void set_linsolve_jacobi(PARCEL_INT iter);
precon_param *get_linsolve_precon_param(); // 設定値の参照 (get_precon_algo() など)引数
| 名前 | 入出力 | 型 | 説明 | 既定値 |
|---|---|---|---|---|
algo |
入力 | PARCEL_INT |
内部線形ソルバの前処理の種類. 値は set_precon_algo() と同じ |
PRECON_JACOBI |
nblock |
入力 | PARCEL_INT |
のブロック Jacobi のブロック数 | 呼ばない場合は set_blockjacobi() と同じくデバイスから自動で決める |
iter |
入力 | PARCEL_INT |
の Jacobi 反復の回数 | 1 |
前提条件 set_precon_algo(), set_blockjacobi(), set_jacobi() と同じ. 範囲外は std::invalid_argument.
MPI 局所操作. 全ランクで同じ値を与える.
注意 set_precon_spectrum(true) のときは使わず, で前処理する. ks_arnoldi の shift-invert で使われる条件は set_shift() に示す.
例
ip.set_linsolve_precon_algo(parcel::PRECON_BLOCKJACOBI);10.7 set_linsolve_scaling_matrix() / set_linsolve_scaling_vector()
概要 の行列・ベクトルスケーリングの有無を設定する.
書式
void set_linsolve_scaling_matrix(bool f);
void set_linsolve_scaling_vector(bool f);引数
| 名前 | 入出力 | 型 | 説明 | 既定値 |
|---|---|---|---|---|
f |
入力 | bool |
false: 無, true: 有 | 呼ばない場合は自動 (set_scaling_matrix() と同じ規則) |
MPI 局所操作. 全ランクで同じ値を与える.
10.8 get_linsolve_failures()
概要 直前の solver() で内部線形ソルバが収束しなかった回数を返す.
書式
PARCEL_INT get_linsolve_failures() const;戻り値 内部線形ソルバ (inverse_power, ks_arnoldi の shift-invert) が収束判定値を満たさずに終わった回数. power とシフトなしの ks_arnoldi では 0.
MPI 局所操作. 値は全ランクで同じである.
注意 外側の収束状態 (get_converged_reason()) には反映しない. 内部が判定値に届かなくても外側は収束しうるためである. 0 でない場合は set_linsolve_max_iteration() や set_linsolve_precon_algo() を見直す.
例
if (ip.get_linsolve_failures() > 0) std::printf("inner solver did not converge %d times\n", (int)ip.get_linsolve_failures());