17 parcel::krylov::ks_arnoldi
17.1 ks_arnoldi (クラス)
概要 Arnoldi 過程と Krylov-Schur リスタートによる固有値ソルバ. 非対称行列にも対応し, (set_precon_spectrum(true) 時は ) の絶対値の大きい側 (shift-invert 時は 近傍) の複数の固有対を同時に求める.
書式
template< class Tspmv = parcel_double, class Tprecon = parcel_double,
class Taxpy = parcel_double, class Tdot = parcel_double >
class ks_arnoldi : public eigen_param;注意 set_tolerance() は Ritz 対 の相対残差 に対する値である (記号). set_max_iteration() は使わない. 収束判定と破綻の扱いはソルバごとの収束判定に示す.
17.2 solver()
概要 固有対を 組求める. 収束判定の対象は先頭の 組である.
書式
template< class Tmat, class Teigen_val, class Teigen_vec,
class Tprecon_mat = Teigen_vec, class Tprecon_vec = Teigen_vec >
void solver(parcel::matrix<Tmat> &Mat,
parcel::vector<Teigen_val> &EigenValue, parcel::vector<Teigen_vec> &EigenVec,
parcel::matrix<Tmat> *ShiftMat = nullptr);引数
| 名前 | 入出力 | 型 | 説明 | 既定値 |
|---|---|---|---|---|
Mat |
入力 | parcel::matrix<Tmat> & |
係数行列 | なし |
EigenValue |
出力 | parcel::vector<Teigen_val> & |
固有値. 要素数 (実部と虚部を交互に格納) | なし |
EigenVec |
入出力 | parcel::vector<Teigen_vec> & |
固有ベクトル. 要素数 以上 ( は担当行数 Mat.n_local(). 列 が 番目). 書くのは 本 ( 以上なら 本). 入力時は先頭 要素を初期ベクトルとして使う |
なし |
ShiftMat |
入力 | parcel::matrix<Tmat> * |
shift-invert で用いる (扱いは set_shift()). set_shift() を呼んでいない場合は渡しても使われない (検査しない) |
nullptr |
前提条件 次は入口で検査し, 違反すると std::invalid_argument を投げる. 違反はランクごとに異なりうるので, 判定を MPI_Allreduce で集めてから全ランクが投げる.
- in-order キュー (共通の前提条件).
- ( は全ランクの局所行数の和).
EigenVecの要素数が 以上,EigenValueの要素数が 以上であること ( はMat.n_local()).
次は検査しない.
- 共通の前提条件のうち, ベクトルのキュー.
ShiftMatはMatとは別の配列からset_crsMat()で登録したものであること (set_crsMat() の注意).
初期ベクトル (先頭 要素) のノルムが 0 または非有限の場合は, 既定の初期ベクトル (大域行番号から作る. power の solver() と同じ) に置き換え, rank 0 がその旨を表示する.
戻り値 なし.
MPI 集団操作. 全ランクが同じ設定で呼ぶ.
注意 固有値が複素共役対の場合, 対応する固有ベクトルは実部と虚部の 2 本として格納される. Arnoldi 過程が不変部分空間に達した場合は真の残差で収束を確かめ, 確かめられなければ乱数方向で続ける (固有値ソルバの章). 有効次元が に満たないまま終えた場合, 足りない固有対は 0 で返す. shift-invert の逆変換で となる固有値は を返す. 密行列の LAPACK 計算は rank 0 が行い, 結果を全ランクに配る.
関連項目 set_ks_subspace(), set_shift(), get_ks_nconv(), 固有値ソルバの章
例
parcel::krylov::ks_arnoldi<> ks;
ks.solver(A, eval, evec);
ks.solver(A, eval, evec, &As); // shift-invert (As = A - σI)17.3 set_ks_subspace() / get_ks_m() / get_ks_k_keep() / get_ks_nev()
概要 Krylov 部分空間の最大次元 , リスタート後に残す本数 , 求める固有対の数 を設定・取得する.
書式
void set_ks_subspace(PARCEL_INT m, PARCEL_INT k_keep, PARCEL_INT nev);
PARCEL_INT get_ks_m() const;
PARCEL_INT get_ks_k_keep() const;
PARCEL_INT get_ks_nev() const;引数
| 名前 | 入出力 | 型 | 説明 | 既定値 |
|---|---|---|---|---|
m |
入力 | PARCEL_INT |
Krylov 部分空間の最大次元 | 30 |
k_keep |
入力 | PARCEL_INT |
リスタート後に残す Ritz 対の数. solver() が返す固有対の数 |
10 |
nev |
入力 | PARCEL_INT |
収束判定の対象とする固有対の数 | 4 |
前提条件 . でなければ std::invalid_argument (値は変えない). は行列が要るので solver() の入口で検査する.
MPI 局所操作. 全ランクで同じ値を与える.
例
ks.set_ks_subspace(30, 10, 4);17.4 set_ks_max_restart() / get_ks_max_restart()
概要 最大リスタート回数を設定・取得する.
書式
void set_ks_max_restart(PARCEL_INT R);
PARCEL_INT get_ks_max_restart() const;引数
| 名前 | 入出力 | 型 | 説明 | 既定値 |
|---|---|---|---|---|
R |
入力 | PARCEL_INT |
最大リスタート回数 | 200 |
前提条件 1 以上. 0 以下は std::invalid_argument.
MPI 局所操作. 全ランクで同じ値を与える.
例
ks.set_ks_max_restart(200);17.5 set_qr_algo() / get_qr_algo()
概要 Arnoldi 過程の直交化の方式を設定・取得する. 定数は pgmres と同じで, ks_arnoldi ではどちらも 2 回適用する.
書式
void set_qr_algo(PARCEL_INT qrdecomposition_algo);
PARCEL_INT get_qr_algo() const;引数
| 名前 | 入出力 | 型 | 説明 | 既定値 |
|---|---|---|---|---|
qrdecomposition_algo |
入力 | PARCEL_INT |
parcel::qr::QR_CGS (0, 古典 Gram-Schmidt 法 2 回 = CGS2) または QR_MGS (1, 修正 Gram-Schmidt 法 2 回 = MGS2) |
QR_CGS. ライブラリをマクロ PARCEL_KS_ORTHO_DEFAULT=mgs でビルドしたときは QR_MGS (利用者ガイドの「ks_arnoldi の直交化の既定」) |
前提条件 QR_CGS または QR_MGS. それ以外の値 (QR_CHOLESKYQR を含む) は std::invalid_argument.
MPI 局所操作. 全ランクで同じ値を与える.
注意 どちらも固有値の精度は同等で, 速さだけが違う. 1 ランクの局所行数が小さい CPU の構成では MGS2 が速い場合があり, 局所行数が大きい CPU と GPU では CGS2 が速い. 環境変数PARCEL_KS_ORTHOは読まない (設定されていると, 最初のsolver()で rank 0 が標準エラーに警告を 1 行出す).
関連項目 ソルバごとの収束判定の ks_arnoldi, QR分解の章
例
ks.set_qr_algo(parcel::qr::QR_MGS); // MGS217.6 set_shift() / disable_shift()
概要 shift-invert モードを有効 / 無効にする. 有効にすると (set_precon_spectrum(true) 時は ) に Arnoldi 過程を適用し, 近傍の固有値を で返す ( は Ritz 値).
書式
void set_shift(double sigma);
void disable_shift();引数
| 名前 | 入出力 | 型 | 説明 | 既定値 |
|---|---|---|---|---|
sigma |
入力 | double |
シフト | 無効 |
前提条件 が固有値に一致しないこと (検査しない).
MPI 局所操作. 全ランクで同じ値を与える.
注意 内部 pgmres の収束判定値・最大反復回数・リスタート周期は set_linsolve_* で設定する (既定値は共通事項の設定). 内部 pgmres の前処理は, set_precon_spectrum() と solver() の第 4 引数 ShiftMat によって次のように決まる.
set_precon_spectrum(false)でShiftMat() を渡した場合: をset_linsolve_precon_algo()・set_linsolve_blockjacobi()・set_linsolve_jacobi()の設定でShiftMatから一度だけ作る.set_precon_spectrum(false)でShiftMatを省いた場合: とシフト から を解き ( を組む必要はない), に固定する.set_linsolve_precon_algo()などは使われない (前処理なし以外を明示していれば rank 0 がその旨を表示する. 既定の Jacobi 前処理のままでは表示しない). 内部反復を前処理で速める場合はShiftMatを渡す.set_precon_spectrum(true)の場合: を解き, 前処理は ( から作る) である.ShiftMatとset_linsolve_precon_algo()などは使わない.
例
ks.set_shift(-13.0);17.7 get_ks_nconv()
概要 最後の収束判定で判定値を満たした固有対の数を返す.
書式
PARCEL_INT get_ks_nconv() const;戻り値 個のうち Ritz 残差が set_tolerance() の値以下の数 (NaN は数えない. 不変部分空間などで真の残差を確かめた場合はその数). 収束時は .
MPI 局所操作. 値は全ランクで同じである.
例
std::printf("converged pairs = %d / %d\n", (int)ks.get_ks_nconv(), (int)ks.get_ks_nev());17.8 set_shift_linsolve_tolerance() / set_shift_linsolve_max_iteration() / set_shift_linsolve_restart() (非推奨)
概要 set_linsolve_tolerance(), set_linsolve_max_iteration(), set_linsolve_restart() の旧名である. 互換のために残している.
書式
void set_shift_linsolve_tolerance(double t);
void set_shift_linsolve_max_iteration(PARCEL_INT n);
void set_shift_linsolve_restart(PARCEL_INT r);引数 対応する set_linsolve_* と同じである (既定値は共通事項の設定).
注意 新しく書くプログラムでは set_linsolve_* を用いる.