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

3 SYCL版PARCELクラス

 C++ の API を示す. 本章から parcel::krylov::ks_arnoldi までが C++ の章である. 言語によらない事項 (設定の意味と既定値, 定数の意味, 結果, 収束状態, MPI での扱い) は共通事項とソルバごとの収束判定に示し, C++ の章には C++ での名前, 書式, 例外, 精度の指定を示す. 各項目の欄は各項目の書式のとおりであり, 書式の欄は C++ の宣言 (テンプレート引数の既定値を含む) である.

 クラスは名前空間 parcel に属し, ソルバは parcel::krylov に属する (データ型の別名はグローバル名前空間にある. PARCELデータ型). ヘッダーファイル Include/parcel_sycl.hpp をインクルードすれば全クラスが利用できる. 本書に載せていない公開メンバ (parcel::comm::setQueue(), barrier(), parcel::matrix::queue(), comm(), 既定コンストラクタ, precon_param の *_is_set() など) は内部用である.

 設定関数と solver() の入口で主な値を検査し, 違反すると std::invalid_argument を投げる. 前提条件の欄には投げる例外の型を書く. 検査する値と例外の一覧は「設定の扱いと例外」に示す.

3.1 共通事項との対応

 共通事項の設定と C++ の設定関数の対応を示す. 既定値と意味は共通事項と同じである.

共通事項の結果 C++ の関数
収束状態 get_converged_reason(), is_converged(), converged_reason_name()
反復回数 get_iterations()
残差 get_residual()
真の残差 get_true_residual()
収束した固有対の数 get_ks_nconv()
内部線形ソルバの失敗回数 get_linsolve_failures()

 共通事項の定数の C++ での名前は定数に示す. 共通事項に無い C++ だけの機能は, 精度の指定 (PARCELデータ型, テンプレート引数) と, pgmres の前処理空間の解を返すモードである.