8 ソルバ共通の事項
C++ のソルバクラスに共通の事項 (精度のテンプレート引数, 設定と例外, 定数の名前) を示す. 記号と用語は共通事項の「記号と用語」に示す.
8.1 クラステンプレート引数 (演算精度)
ソルバクラスはすべて, 演算ごとの計算精度を次のテンプレート引数で指定する. 省略時はいずれも parcel_double である.
| 引数 | 説明 | 既定値 |
|---|---|---|
Tspmv |
疎行列ベクトル積 (SpMV) の計算精度 | parcel_double |
Tprecon |
前処理の計算精度 | parcel_double |
Taxpy |
ベクトル演算 (axpy () 等) の計算精度 | parcel_double |
Tdot |
縮約演算 (内積・ノルム) の計算精度 | parcel_double |
template< class Tspmv = parcel_double, class Tprecon = parcel_double,
class Taxpy = parcel_double, class Tdot = parcel_double >
class pcg; // pbicgstab, pgmres, pcagmres, power, inverse_power, ks_arnoldi も同じ7 つのソルバクラスはすべてこの 4 引数を持つ.
8.2 solver() のテンプレート引数 (データ精度)
solver() 関数のテンプレート引数では, 各データを保持する精度を指定する. ソルバ固有の引数は各クラスの項に示す. 実引数から推論できる引数は省略でき, 推論できない引数の既定は parcel_double である. したがって精度をすべて倍精度にする場合は parcel::krylov::pcg<> s; s.solver(A, x, b); と書ける (固有値ソルバも s.solver(A, ev, evec)). 明示する場合は先頭から順に与える.
| 引数 | 説明 | 既定値 |
|---|---|---|
Tmat |
係数行列のデータ精度 (parcel::matrix<Tmat> の型と一致させる) |
実引数から推論 |
Tvecx / Tvecb |
解ベクトル / 右辺ベクトルのデータ精度 (線形ソルバ) | 実引数から推論 |
Teigen_val / Teigen_vec |
固有値 / 固有ベクトルのデータ精度 (固有値ソルバ) | 実引数から推論 |
Tvec |
ソルバ内部のベクトルのデータ精度 (ks_arnoldi には無い) |
parcel_double |
Tprecon_mat |
前処理行列のデータ精度 | parcel_double (ks_arnoldi は Teigen_vec) |
Tprecon_vec |
前処理ベクトルのデータ精度 | parcel_double (ks_arnoldi は Teigen_vec) |
8.3 設定の扱いと例外
- ソルバの設定関数 (
set_*) は値をオブジェクトに記録するだけの局所操作である. 設定はsolver()を呼んだときに使われ, 次に変えるまで保持される. 同じオブジェクトでsolver()を繰り返し呼んでよい. - 次の設定関数は値を検査し, 範囲外なら
std::invalid_argumentを投げる (値は変えない). 設定関数は全ランクで同じ引数で呼ぶ前提なので, 全ランクが同じように投げる.
| 関数 | 受け付ける値 |
|---|---|
set_tolerance(), set_linsolve_tolerance() |
有限の正の値 (0 以下, NaN,Inf は不可) |
set_max_iteration(), set_linsolve_max_iteration(), set_linsolve_restart(), ks_arnoldi: |
1 以上 |
set_precon_algo(), set_linsolve_precon_algo() |
PRECON_NONE, PRECON_POINTJACOBI, PRECON_BLOCKJACOBI, PRECON_JACOBI |
set_jacobi(), set_linsolve_jacobi() |
1 以上 |
set_blockjacobi(), set_linsolve_blockjacobi() |
1 以上 (担当行数以下であることは検査しない) |
set_linsolve_algo() |
LINSOLVE_PGMRES, LINSOLVE_PCG |
pgmres::set_restart() |
1 以上 |
pgmres::set_qr_algo() |
QR_CGS, QR_MGS |
pcagmres::set_restart() |
, とも 1 以上 |
pcagmres::set_qr_algo() |
QR_CGS, QR_MGS, QR_CHOLESKYQR, QR_CAGMRES_CHOLESKYQR |
pcagmres::set_explicit_q() |
CAGMRES_Q_AUTO, CAGMRES_Q_EXPLICIT, CAGMRES_Q_IMPLICIT |
ks_arnoldi::set_ks_subspace() |
|
ks_arnoldi::set_qr_algo() |
QR_CGS, QR_MGS |
solver()の入口では次を検査し, 違反するとstd::invalid_argumentを投げる. いずれも集団通信の前に, 全ランクが同じ判定で投げる.- SYCL キューが in-order であること (全ソルバ.
set_crsMat()も同じ).-DPARCEL_REQUIRE_IN_ORDER=0で外せる. ks_arnoldi: ,EigenVecの要素数 ,EigenValueの要素数 . 要素数はランクごとに異なりうるので, 判定をMPI_Allreduceで集めてから全ランクで投げる.pcagmres: の作り方と QR 分解の組合せ (set_explicit_q()).
- SYCL キューが in-order であること (全ソルバ.
solver()には次の前提条件もある (各ソルバの前提条件の欄で「共通の前提条件」と呼ぶ).Matはset_crsMat()で登録した行列であること. 未登録の行列 (set_diaMat()で登録したものを含む) ではstd::runtime_errorを投げる.- ベクトル (
x0,b0,EigenValue,EigenVec) はMatと同じキューで確保すること (検査しない.solver()はMatのキューだけを使う). - 局所の長さは, 線形ソルバでは
x0の要素数,power・inverse_powerではEigenVecの要素数から取る (ks_arnoldiはMat.n_local()). これが担当行数と異なる場合の動作は不定である (検査しない).
- 前処理の適用で未知の種類に出会った場合も
std::invalid_argumentを投げる (設定関数で検査するので通常は起きない). - 前処理の構築で, 前処理が作る CRS (ブロック Jacobi の L・U など) の非零要素数が元の行列より増えて
PARCEL_LINTの範囲を超えた場合はstd::overflow_errorを投げる. この判定はランクごとで, 超えたランクだけが投げる (元の行列が範囲の上限近くの場合だけ起こる).-DPARCEL_LOCAL_INT64でビルドし直す. parcel::vectorの確保,set_crsMat(),solver()の作業領域の確保でデバイスメモリが足りない場合はutil_sycl::device_bad_alloc(std::bad_allocの派生) を投げる.what()は要求したバイト数と確保した場所を返す. 確保に失敗するのは多くの場合一部のランクだけで, 他のランクは次の集団通信で待ち続ける. 捕まえた場合は処理を続けず,MPI_Abort()などで全体を止める.- 上記以外 (
vectorの長さ, 行列の中身など) は検査しない. 各関数の前提条件の欄を参照. solver()は集団操作 (MPI_Barrier, 内積のMPI_Allreduce, SpMV の袖通信) である. 行列を登録したコミュニケータの全ランクが, 同じ設定で呼ばなければならない. 設定がランクごとに異なると, 反復回数が食い違ってデッドロックすることがある (共通事項の「設定の扱いと MPI」).- 収束状態 (
get_converged_reason()など) はsolver()の入口でリセットされ, 出口で設定される. 値は全ランクで同じである. solver()は未収束でも例外やエラーを返さない. 結果を使う前にis_converged()などで確かめる.
8.4 定数
設定関数に渡す定数と収束状態の定数は次の名前空間にある. 型はいずれも const PARCEL_INT である. 値の意味は共通事項の定数と収束状態に示す.
| 名前空間 | 定数 (値) | 用いる関数 |
|---|---|---|
parcel:: |
PRECON_NONE (0), PRECON_POINTJACOBI (1), PRECON_BLOCKJACOBI (2), PRECON_JACOBI (4) |
set_precon_algo(), set_linsolve_precon_algo() |
parcel::qr:: |
QR_CGS (0), QR_MGS (1), QR_CHOLESKYQR (2), QR_CAGMRES_CHOLESKYQR (202) |
pgmres::set_qr_algo(), pcagmres::set_qr_algo(), ks_arnoldi::set_qr_algo() |
parcel::krylov:: |
LINSOLVE_PGMRES (0), LINSOLVE_PCG (1) |
set_linsolve_algo() |
parcel::krylov:: |
CAGMRES_Q_AUTO (0), CAGMRES_Q_EXPLICIT (1), CAGMRES_Q_IMPLICIT (2) |
set_explicit_q() |
parcel::krylov:: |
CONVERGED_RTOL (1), ITERATING (0), DIVERGED_ITS (-1), DIVERGED_NANORINF (-2), DIVERGED_BREAKDOWN (-3) |
get_converged_reason(), converged_reason_name() |