On this page |
このDOPには、パラメータの変数を使用してOpenCLカーネルを作成して実行するための一般的なインターフェースが用意されています。 また、パラメータのリストからカーネルのヘッダを自動的に生成する機能も用意されています。
パラメータ
Kernel
Kernel Name
読み込まれたプログラムを使って実行するOpenCLカーネルの名前。
Use Code Snippet
外部ディスクファイルではなく、Kernel Codeパラメータに用意されているコードを使用します。これは、より迅速に編集して、OpenCLマイクロソルバを作成することができます。
Kernel File
コンパイルするOpenCLプログラムファイルのパス。これは、ディスクファイルまたはアセットのパスを含めることができます。
Kernel Options
カーネルに対して希望するコンパイルフラグを指定します。
Note
Apple OSX OpenCLコンパイラは、カーネルオプション間に一個のスペースだけを必要とします!
Generate Kernel
必須のカーネル関数のプロトタイプを作成して、現在選択されているパラメータすべてを考慮します。 これをスターティングポイントとして使用したり、新しいパラメータを追加削除した時にインターフェースを更新することができます。
Recompile Kernel
ディスクからカーネルを読み込む時に、そのカーネルを、ソルブ毎に再生成されないようにキャッシュ化します。 これをオンにすると、強制的にカーネルの再読み込みと再コンパイルをします。 これは、#includeファイルが、変更されたコードを参照する時や、カーネルファイルを外部テキストエディタで変更した場合に役立ちます。
プロトタイプが完了している時は、これを常に無効にするべきです。
Options
Run Over
用意したOpenCLカーネルを一度に呼び出します。とはいえ、グローバルidの数は、この設定で制御されます。 最初のWriteableアトリビュートは、書き込み可にマークされた最初のバインドされたアトリビュートのサイズに設定されます。 すべてのフィールドは、フィールドの合計のボクセル数に設定されます。
Worksetsメソッドは、指定したDetailアトリビュートを使って、begin値とlength値のリストを指定します。 カーネルは、ゼロ以外のlength毎に一回呼び出されます。 グローバルidは、呼び出し毎に0からlength-1まで変化し、begin値を使用することで、バインドされたアトリビュート内のオフセットを調べることができます。
Note
グローバルidは、GPUで効率的に処理をするために切り上げられるので、常にget_global_id(0)
とバインドされたアトリビュートの実際の長さを比較してください。
Force Align
指定したフィールドの整列を強制的に出力グリッドに合わせます。このオプションを選択することで、各グリッドの値が出力グリッドの整列に合うように補間され、 フィールド整列とは無関係にカーネルを実行することができます。
Include Origin
入力/出力のグリッドの原点を含めます。
Include Size
入力/出力のグリッドのサイズを含みます。
Include Voxel Size
ボクセルのサイズを含めます。
Flush Attributes
アトリビュートに書き込んだ後は、他のソルバがジオメトリアトリビュートを要求するまで、その新しい値はGPU上に残ります。 アトリビュートをそこに残すことで効率性を上げることができます。 Flush Attributesを有効にすると、それらのアトリビュートを強制的にGPUからジオメトリメモリに明示的にコピーします。 これが必要となることはないでしょう。
Finish Kernels
Finish Kernelsが無効な時、OpenCLカーネルが次のソルバを続ける前に完了を待とうとしません。 これは、ソルバの結果が実際に必要になるまでOpenCLカーネルをバックグラウンドで走らせることができます。 単にデバッグするだけなら、エラーを正しい箇所で検出できるように、カーネルを必ず終了するようにするのに役立ちます。
Warn on Missing
boundアトリビュートが存在しない、且つ、任意としてマークしていない場合、計算は行なわれません。 通常では、これは予期しない時に警告を生成します。 しかし、静かに何もしない事が正しいアクションであるなら、このフラグを無効にすることで誤った警告を回避することができます。
Include Time
現行シミュレーション時間をパラメータとして含めます。
Include Simulation Frame
現行シミュレーションフレームをパラメータとして含めます。
Include Timestep
現行タイムステップをパラメータとして含めます。これは、OpenCLノードをGas Substepからトリガーした時にフルタイムステップ未満に指定できるので役立ちます。
Timescale
いくつかの処理では、タイムステップの累乗を知りたいことがあります。
カーネル内で再計算するのではなく、e^Timestep
に設定して、指数を事前計算させることができます。
Include Simplex Noise Data
<xnoise.h>のSimplexノイズ関数に渡すことができるOpaque Pointerを含めます。これによって、OpenCLカーネルからSimplexノイズとCurlノイズを生成できるようになります。
Worksets Geometry
workset
Detailアトリビュートを検索するDOP Geometryデータ。
Worksets Begin Attr.
各worksetのstart値を格納する整数配列Detailアトリビュート。
Worksets Length Attr.
各worksetのlength値を格納する整数配列Detailアトリビュート。 lengthがゼロのworksetは呼び出されません。
Detailアトリビュートで指定されたworksetのlengthとbeginの値が、バインドしたアトリビュートに対して正しいオフセットであるかどうかを確認するのは、あなたの役目であることに注意してください。 これらの値があなたの制御下から発生したものでない場合、デリファレンス(参照が指している値を取得)する前にそれらの値が正しいのか確認してください。
Use Single Workgroup if Possible
GPU上のworksetに対して実行する時、workset毎に別々にカーネルを実行するよりも、1つのカーネルコール内でそのGPU上で多くの小さなworksetを実行して、各worksetの後でそのカーネル内で同期化を行なった方が高速化することができます。
このオプションを有効にすると、一番大きなworksetがOpenCL GPUデバイス上の1つのワークグループ内に収まる場合、SINGLE_WORKGROUPプリプロセッサフラグが定義されて、 Worksets Begin と Worksets Length の配列全体がそのカーネルに渡されます。
そのカーネルが各worksetの最後に同期化するかどうかは、通常ではbarrier(CLK_MEM_GLOBAL_FENCE)
を使って決まります。
Generate Kernel ボタンによって生成されたコードには、この同期化のハンドリング方法が表示されます。
Bindings
OpenCL Parameters
OpenCLカーネル内の追加パラメータの数。
各パラメータを、固定の定数値にしたり、DOPネットワークを通して評価したり、フィールドまたはジオメトリアトリビュートから読み/書きすることができます。
Parameter Name
パラメータの名前。これは、Generate Kernel
ボタンで使用されますが、
そこで使用しない場合は、コメントとしてのみ存在します。実際のOpenCLカーネルへのバインドは、名前ではなくパラメータ順で行なわれます。
Parameter Type
作成してバインドするパラメータのタイプ。
Integer
定数の整数値で、事前計算されるチャンネル参照とエクスプレッションをバインドすることができます。
Float
定数の浮動小数点値。オプションで、それをタイムステップでスケールすることができます。
Float Vec4
4つの定数floatのタプルで、float4
OpenCLパラメータにバインドします。
Scalar Field
浮動小数点値のスカラーフィールド。そのフィールド名は、バインドされるScalar Field Dataです。書き込み可のフラグは、ポインタをOpenCLの定数としてマークするかどうか制御します。
Note
フィールドが書き込み可であれば、今度それがHoudiniで必要になった時にコピーされます。
Vector Field
ベクトル値のフィールド。そのフィールド名は、バインドされるVector Field Dataです。
Matrix Field
マトリックス値のフィールド。そのフィールド名は、バインドされるMatrix Field Dataです。
Ramp
スカラーランプ。OpenCLカーネル内のスプラインベースのランプを評価するのは複雑なので、代わりに、このランプが均一なfloat配列にサンプリングされます。
Ramp Size
パラメータは、使用するサンプルの数を制御します。
Attribute
アトリビュート。
Field
フィールドとしてバインドするDOPデータの名前。
フィールド用にあります。
Geometry
ジオメトリとしてバインドするDOPデータの名前。
アトリビュート用にあります。
Attribute
バインドするアトリビュート。オプションのフラグが設定されていない限りは、アトリビュートが見つからなかった時にエラーになります。
アトリビュート用にあります。
Class
アトリビュートのタイプ。最初の書き込み可のアトリビュートが反復順を決定することができるので、これは、OpenCLソルバで処理されるグローバルidの数を決定することができます。
バインドされたアトリビュートすべてが、同じタイプまたは同じジオメトリデータからのものである必要はありません。
アトリビュート用にあります。
Type
バインドするアトリビュートの種類。floatとintegerのアトリビュートが、すべてのエレメント値を順番に含んだ単一の配列としてバインドされます。 タプルは交互に配置されます。つまり、Pはxyzxyzxyzとしてバインドされます。
配列アトリビュートは2つの配列としてバインドされます。その1つの配列には、各エレメントの配列データのオフセットを含んでいます。そのため、オフセットのペアの差分が、そのエレメント配列長さになります。 2つ目の配列は、単一配列に連結されたすべてのエレメントの配列のデータです。
アトリビュート用にあります。
Size
バインドするアトリビュートのタプルサイズ。ゼロより大きい場合、そのアトリビュートは、このタプルサイズにしなければなりません。ゼロなら、自動的にバインドし、追加パラメータが生成されて、そのタプルサイズを保存します。
アトリビュート用にあります。
Readable
OpenCLカーネルが、このアトリビュートから読み込むかどうか決めます。設定しなかった場合は、それらのアトリビュート値がGPUにコピーされません。 これは、書き込み専用のアトリビュートが不要なコピーをしないようにするのに役立ちますが、初期化されていないデータが存在するのに注意が必要です。
アトリビュート用にあります。
Writeable
OpenCLカーネルが、このアトリビュートやフィールドに書き込むかどうか決めます。今度必要になる時にGPUからコピーされるように、GPUバージョンのアトリビュートやフィールドを、最新ではないとマークします。
フィールドとアトリビュート用にあります。
Optional
アトリビュートを不要としてマークします。そのアトリビュートがジオメトリ内に存在しなかった場合、エラーが起こるのではなく、#defineをカーネルオプションに設定して、そのアトリビュートを無効にします。 これはパラメータシグネチャも変更するので、構文を確認するには、 Generate Code ボタンを使用してください。
Note
パラメータ名が#define
で使用されるので、そのパラメータ名を変更すると、そのコードを変更する必要があります。
アトリビュート用にあります。
Ramp Size
ランプ用にあります。
出力
First Output
この出力のオペレーションは、このノードに接続している入力に依存します。 オブジェクトストリームがこのノードの入力であれば、その出力も入力と同じオブジェクトを含んだオブジェクトストリーム(しかし、取り付けられたこのノードのデータを持ちます)です。
オブジェクトストリームをこのノードに接続しなかった場合、その出力はデータ出力になります。 このデータ出力をApply Data DOPに接続したり、他のデータノードのデータ入力に直接接続することで、 このノードのデータをオブジェクトや他のデータに取り付けることができます。
ローカル変数
channelname
このDOPノードはData Optionsページの各チャンネルとパラメータに対して、チャンネルと同じ名前のローカル変数を定義します。 例えば、ノードにPositionのチャンネル(positionx、positiony、positionz)とオブジェクト名のパラメータ(objectname)があるとします。
そのノードには、positionx、positiony、positionz、objectnameの名前を持つローカル変数も存在します。これらの変数は、そのパラメータに対する前の値を評価します。
この前の値は、処理されているオブジェクトに追加されたデータの一部として常に保存されています。 これは、本質的には以下のようなdopfieldエクスプレッション関数のショートカットです:
dopfield($DOPNET, $OBJID, dataName, "Options", 0, channelname)
データがまだ存在しないなら、ゼロの値または空っぽの文字列が返されます。
DATACT
この値は、現在のデータが作成されたシミュレーション時間(変数STを参照)です。 このノードが新しいデータを作成せずに既存データを変更していれば、この値は現在のシミュレーション時間と同じにはなりません。
DATACF
この値は、現在のデータが作成されたシミュレーションフレーム(変数SFを参照)です。 このノードが新しいデータを作成せずに既存データを変更していれば、この値は現在のシミュレーションフレームと同じにはなりません。
RELNAME
この値は、データがリレーションシップ(例えば、Constraint Anchor DOPがConstraint DOPの2番目、3番目、4番目の入力に接続されている時)に追加されている時だけ設定されます。
この場合では、この値は、データが追加されているリレーションシップの名前に設定されます。
RELOBJIDS
この値は、データがリレーションシップ(例えば、Constraint Anchor DOPがConstraint DOPの2番目、3番目、4番目の入力に接続されている時)に追加されている時だけ設定されます。
この場合では、この値は、データが追加されているリレーションシップのAffected Objectsすべてに対するオブジェクトIDをスペース区切りにしたリストの文字列に設定されます。
RELOBJNAMES
この値は、データがリレーションシップ(例えば、Constraint Anchor DOPがConstraint DOPの2番目、3番目、4番目の入力に接続されている時)に追加されている時だけ設定されます。
この場合では、この値は、データが追加されているリレーションシップのAffected Objectsすべてに対するオブジェクト名をスペース区切りにしたリストの文字列に設定されます。
RELAFFOBJIDS
この値は、データがリレーションシップ(例えば、Constraint Anchor DOPがConstraint DOPの2番目、3番目、4番目の入力に接続されている時)に追加されている時だけ設定されます。
この場合では、この値は、データが追加されているリレーションシップのAffector Objectsすべてに対するオブジェクトIDをスペース区切りにしたリストの文字列に設定されます。
RELAFFOBJNAMES
この値は、データがリレーションシップ(例えば、Constraint Anchor DOPがConstraint DOPの2番目、3番目、4番目の入力に接続されている時)に追加されている時だけ設定されます。
この場合では、この値は、データが追加されているリレーションシップのAffector Objectsすべてに対するオブジェクト名をスペース区切りにしたリストの文字列に設定されます。
ST
この値は、ノードが評価されるシミュレーション時間です。
この値は、変数Tで表現される現在のHoudiniの時間と同じではなく、DOP Networkの Offset Time と Time Scale のパラメータの設定に依存しています。
この値は、シミュレーションの開始時間がゼロになるようになっています。つまり、シミュレーションの最初のタイムステップをテストする時は、$T == 0
や$FF == 1
を使うのではなくて、$ST == 0
のようなテストを使うのがベストです。
SF
この値は、ノードが評価されるシミュレーションフレーム(正確には、シミュレーションタイムステップ番号)です。
この値は、変数Fで表現される現在のHoudiniのフレーム番号と同じではなく、DOP Networkパラメータの設定に依存しています。代わりに、この値は、シミュレーション時間(ST)をシミュレーションタイムステップサイズ(TIMESTEP)で割算した値と同じです。
TIMESTEP
この値は、シミュレーションタイムステップのサイズです。この値は、1秒あたりのユニットで表現した値をスケールするのに役に立ちますが、タイムステップ毎に適用されます。
SFPS
この値は、TIMESTEPの逆数です。シミュレーション時間の1秒あたりのタイムステップ数です。
SNOBJ
これはシミュレーション内のオブジェクトの数です。Empty Objectノードなどのオブジェクトを作成するノードでは、この値は、オブジェクトが評価される度に値が増えます。
固有のオブジェクト名を確保する良い方法は、object_$SNOBJ
のようなエクスプレッションを使うことです。
NOBJ
この値は、このタイムステップ間で現行ノードで評価されるオブジェクトの数です。 この値は、多くのノードがシミュレーション内のオブジェクトすべてを処理しないので、SNOBJとは異なります。
この値は、ノードが各オブジェクトを続けて処理(例えば、Group DOP)しないなら0を返します。
OBJ
この値は、ノードで処理される特定のオブジェクトのインデックスです。 この値は、指定したタイムステップで常にゼロからNOBJ-1まで実行されます。 この値は、OBJIDやOBJNAMEなどのシミュレーション内の現行オブジェクトを識別せず、現在の処理順でのオブジェクトの順番を識別します。
この値は、オブジェクト毎に乱数を生成するのに役に立ちます。他には、処理別にオブジェクトを2,3のグループに分けるのに役に立ちます。 この値は、ノードがオブジェクトを続けて処理(例えば、Group DOP)しないなら-1を返します。
OBJID
この値は、処理されているオブジェクトの固有のオブジェクトIDです。 すべてのオブジェクトは、すべての時間のシミュレーション内のオブジェクトすべてで固有な整数値が割り当てられています。たとえオブジェクトが削除されても、そのIDは決して再利用されません。
オブジェクトIDは、指定したオブジェクトを固有なものと識別するために常に使われています。 オブジェクトIDは、オブジェクト毎に別々の処理をさせたいシミュレーションで非常に役に立ちます。 オブジェクト毎に固有の乱数を生成するのにも使われます。
この値は、dopfieldエクスプレッション関数を使って、オブジェクトの情報を検索するのにベストな方法です。 この値は、ノードがオブジェクトを続けて処理(例えば、Group DOP)しないなら-1を返します。
ALLOBJIDS
この文字列には、現行ノードで処理されているオブジェクトすべての固有のオブジェクトIDをスペース区切りにしたリストが含まれています。
ALLOBJNAMES
この文字列には、現行ノードで処理されているオブジェクトすべての名前をスペース区切りにしたリストが含まれています。
OBJCT
この値は、現行オブジェクトが作成された時のシミュレーション時間(変数STを参照)。
そのため、オブジェクトが現在のタイムステップで作成されたかどうかチェックするには、$ST == $OBJCT
のエクスプレッションが常に使われます。
この値は、ノードがオブジェクトを続けて処理(例えば、Group DOP)しないなら0を返します。
OBJCF
この値は、現行オブジェクトが作成された時のシミュレーションフレーム(変数SFを参照)。
この値は、OBJCT変数にdopsttoframeエクスプレッションを使ったものと等価です。この値は、ノードがオブジェクトを続けて処理(例えば、Group DOP)しないなら0を返します。
OBJNAME
これは、処理されているオブジェクトの名前を含む文字列の値です。
オブジェクト名は、シミュレーション内で固有であることが保証されていません。 しかし、オブジェクト名が固有になるように注意して名前を付けていれば、オブジェクトの識別は、オブジェクトIDよりも、オブジェクト名を指定するほうが簡単です。
オブジェクト名は、同じ名前を持つオブジェクトの数を仮想グループとして扱うこともできます。
"myobject"という名前のオブジェクトが20個あれば、DOPのActivationフィールドにstrcmp($OBJNAME, "myobject") == 0
を指定すると、DOPがその20個のオブジェクトのみを操作します。
この値は、ノードがオブジェクトを続けて処理(例えば、Group DOP)しないなら空っぽの文字列を返します。
DOPNET
これは、現在のDOP Networkのフルパスを含む文字列です。 この値は、ノードを含むDOP Networkのパスを知りたりDOPサブネットのデジタルアセットで非常に役に立ちます。
Note
ほとんどのダイナミクスノードには、そのノードのパラメータと同じ名前のローカル変数があります。 例えば、Positionノードでは、以下のエクスプレッションを記述することができます:
$tx + 0.1
これはオブジェクトをタイムステップ毎にX軸方向に0.1単位分移動させます。