pyvista.DataSetFilters.streamlines_from_source

pyvista.DataSetFilters.streamlines_from_source#

DataSetFilters.streamlines_from_source(
source: DataSet | _vtk.vtkDataSet,
vectors: str | None = None,
integrator_type: Literal[45, 2, 4] = 45,
integration_direction: Literal['both', 'backward', 'forward'] = 'both',
surface_streamlines: bool = False,
initial_step_length: float = 0.5,
step_unit: Literal['cl', 'l'] = 'cl',
min_step_length: float = 0.01,
max_step_length: float = 1.0,
max_steps: int = 2000,
terminal_speed: float = 1e-12,
max_error: float = 1e-06,
max_time: float | None = None,
compute_vorticity: bool = True,
rotation_scale: float = 1.0,
interpolator_type: Literal['point', 'cell', 'p', 'c'] = 'point',
progress_bar: bool = False,
max_length: float | None = None,
)[ソース]#

ソースメッシュのポイントからベクトルの流線を生成します．

デフォルトRunge-Kutta 2では，指定したインテグレータを使用して積分が実行されます．これにより，あらゆるタイプのデータセットを使用した積分がサポートされます．データセットにポリゴンや3角形などの2 Dセルが含まれていて surface_streamlines パラメータが使用されている場合，積分は2 Dセルによって定義されるサーフェス上に配置されるように制限されます．

パラメータ:
sourcepyvista.DataSet

ソースの点は流線の開始点を提供します．球とラインソースの両方がオーバーライドされます．

vectorsstr, optional

積分するアクティブベクトルフィールドの文字列名．

integrator_type{45, 2, 4}, default: 45

流線生成に使用する積分器のタイプです．デフォルトはRunge-Kutta 45です．認識されるソルバーは: RUNGE_KUTTA2 (2) ， RUNGE_KUTTA4 (4) および RUNGE_KUTTA45 (45) です．オプションは 2 ， 4 または 45 です．

integration_directionstr, default: "both"

流線を上流方向と下流方向のどちらに統合するかを指定します(または両方)．選択肢は 'both' ， 'backward' または 'forward' です．

surface_streamlinesbool, default: False

サーフェス上の流線を計算します．

initial_step_lengthfloat, default: 0.5

線積分に使用される最初のステップサイズで，ib長さ単位Lまたはセル長単位( step_unit パラメータを参照)を表します．RK45のような適応積分器の開始サイズか，RK 2とRK 4のような非適応積分器の一定/固定サイズのどちらか)．

step_unit{'cl', 'l'}, default: "cl"

均一積分ステップ単位．有効な単位は LENGTH_UNIT ('l') と CELL_LENGTH_UNIT ('cl') だけに制限されます．デフォルトは CELL_LENGTH_UNIT です．

min_step_lengthfloat, default: 0.01

線積分に使用される最小ステップサイズで，長さまたはセル長の単位で表されます．RK45のような適応積分器にのみ有効．

max_step_lengthfloat, default: 1.0

線積分に使用される最大ステップサイズで，長さまたはセル長の単位で表されます．RK45のような適応積分器にのみ有効．

max_stepsint, default: 2000

流線を積分するための最大ステップ数．

terminal_speedfloat, default: 1e-12

積分を終了する端子速度の値です．

max_errorfloat, 1e-6

流線積分全体で許容される最大エラー数．

max_timefloat, optional

Specify the maximum length of a streamline expressed in physical length.

バージョン 0.45.0 で非推奨: max_time parameter is deprecated. Use max_length instead. It will be removed in v0.48. Default for max_time changed in v0.45.0.

compute_vorticitybool, default: True

流線点での渦度計算 ． vtkRibbonFilter を使用して適切な流線リボンを生成するために必要．

rotation_scalefloat, default: 1.0

これを使用して，リボンがツイストするレートをスケールできます．

interpolator_typestr, default: "point"

ポイントまたはセルによる流線積分中にセルの位置を特定するために，速度フィールド補間のタイプを設定します．セルロケータはポイントロケータよりも堅牢です．オプションは 'point' または 'cell' ( 'p' および 'c' の省略形もサポートされています．)です．

progress_barbool, default: False

進行状況を示す進行状況バーを表示します．

max_lengthfloat, optional

Specify the maximum length of a streamline expressed in physical length. Default is 4 times the diagonal length of the bounding box of the source dataset.

戻り値:
pyvista.PolyData

流線．これにより，各セル(つまり，ポリライン)が流線を表すポリラインが出力として生成されます．各流線に関連付けられた属性値はセルデータに格納され，流線ポイントに関連付けられた属性値はポイントデータに格納されます．

例

流線 の例を参照してください．

目次