PARCEL SYCL v1.2 / API リファレンス 利用者ガイド API リファレンス 検索 ダウンロード English

13 parcel::krylov::pgmres

13.1 pgmres (クラス)

概要 前処理付き一般化最小残差法 (右前処理, リスタート付き). 非対称行列の Ax=bAx = b を解く.

書式

template< class Tspmv = parcel_double, class Tprecon = parcel_double,
          class Taxpy = parcel_double, class Tdot    = parcel_double >
class pgmres : public krylov_param;

関連項目 収束判定と破綻の扱い, set_restart(), set_qr_algo()

13.2 solver()

概要 Ax=bAx = b を解く.

書式

template< class Tmat, class Tvecx, class Tvecb, class Tvec = parcel_double,
          class Tprecon_mat = parcel_double, class Tprecon_vec = parcel_double,
          class TGS = parcel_double, class THessenberg = parcel_double >
void solver(parcel::matrix<Tmat> &Mat, parcel::vector<Tvecx> &x0, parcel::vector<Tvecb> &b0,
            parcel::precon_matrix<Tmat,Tvec,Tprecon_mat,Tprecon_vec,Tprecon> *external_precon = nullptr);

引数

名前 入出力 型 説明 既定値
TGS 入力 (テンプレート) PARCELデータ型 Gram-Schmidt 直交化の精度 parcel_double
THessenberg 入力 (テンプレート) PARCELデータ型 Hessenberg 行列の精度 parcel_double
Mat, x0, b0 pcg の solver() と同じ なし
external_precon 入力 precon_matrix * 構築済みの前処理行列. 固有値ソルバが内部で繰り返し呼ぶときに使う. 利用者は省略する. 渡す場合は, 構築に使った行列を使い終えるまで破棄・変更しない (Jacobi 前処理はその行列の構造と値を参照する) nullptr (内部で構築)

前提条件 共通の前提条件 (in-order キュー, 登録済みの行列, ベクトルのキューと長さ) を満たすこと. get_max_iteration() ≥m\geq m であること (検査しない). b=0b = 0 では pcg と同じく x=0x = 0 (前処理空間出力モードでは z=0z = 0) で戻る.

戻り値 なし.

MPI 集団操作. 全ランクが同じ設定で呼ぶ.

例

parcel::krylov::pgmres<> gm;
gm.solver(A, x, b);

13.3 set_restart() / get_restart()

概要 リスタート周期 mm を設定・取得する.

書式

void       set_restart(PARCEL_INT gmres_m);
PARCEL_INT get_restart() const;

引数

名前 入出力 型 説明 既定値
gmres_m 入力 PARCEL_INT リスタート周期 mm. 基底ベクトル m+1m+1 本ぶんの領域を確保する 30

前提条件 1 以上. 0 以下は std::invalid_argument.

MPI 局所操作. 全ランクで同じ値を与える.

例

gm.set_restart(8);

13.4 set_qr_algo() / get_qr_algo()

概要 Arnoldi 過程の直交化法を設定・取得する.

書式

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) または QR_MGS (1, 修正 Gram-Schmidt) QR_MGS

前提条件 QR_CGS または QR_MGS. それ以外の値 (QR_CHOLESKYQR を含む) は std::invalid_argument.

MPI 局所操作. 全ランクで同じ値を与える.

関連項目 QR分解の章

例

gm.set_qr_algo(parcel::qr::QR_MGS);

13.5 set_precon_space_output() / get_precon_space_output()

概要 右前処理の内部変数 zz ((AK−1)z=b(AK^{-1})z = b の解) をそのまま返すモードを設定・取得する. 固有値ソルバの AK−1AK^{-1} モードが内部で使う.

書式

void set_precon_space_output(bool f);
bool get_precon_space_output() const;

引数

名前 入出力 型 説明 既定値
f 入力 bool true のとき, 最後に K−1K^{-1} を掛けず zz を x0 に返す. x0 の初期値も z0z_0 と解釈する false

MPI 局所操作. 全ランクで同じ値を与える.

注意 true では, 解の更新でK−1K^{-1}を掛けずにx(j+1)=x(j)+∑kykvkx^{(j+1)} = x^{(j)} + \sum_{k} y_{k}v_{k} (yyは最小二乗問題の解) とし, 右前処理の内部変数zzをx0に返す. このときx0の初期値もzzと解釈し, リスタート先頭の残差はr=b−AK−1zr = b - AK^{-1}zとなる. さらに set_shift() でσ\sigmaを指定すると, (AK−1−σI)z=b(AK^{-1} - \sigma I)z = bを解く (Arnoldi 過程でw=AK−1vi−σviw = AK^{-1}v_{i} - \sigma v_{i}とし, 残差もr=b−AK−1z+σzr = b - AK^{-1}z + \sigma zとする). true のとき get_true_residual() は ∥b−AK−1z+σz∥/∥b∥\|b - AK^{-1}z + \sigma z\|/\|b\| である.

13.6 set_shift() / get_shift()

概要 set_precon_space_output(true) のとき, (AK−1−σI)z=b(AK^{-1} - \sigma I)z = b を解くシフト σ\sigma を設定・取得する.

書式

void   set_shift(double sigma);
double get_shift() const;

引数

名前 入出力 型 説明 既定値
sigma 入力 double シフト σ\sigma 0

MPI 局所操作. 全ランクで同じ値を与える.

注意 set_precon_space_output(false) では使われない. ks_arnoldi::set_shift() とは別の関数である.