waterPMLコマンドの出力ファイル

スナップショット

◆共通事項 (Common features)

• パラメータsnapshot_grid, snapshot_placeの指定に基づいて 各時刻での速度場のスナップショットが出力される。 なおsnapshot_grid=noneとした場合はスナップショットは出力されない。
  The snapshots of the velocity field at each time sample are created based on parameters snapshot_grid and snapshot_place. The snapshots are not included in the output in case of snapshot_grid=none.
  
  
• スナップショットはパラメータoutput_dirで指定したディレクトリ内の snapshotサブディレクトリの下に出力される。 出力ディレクトリは自動的に作成される。
  The snapshots are created under the subdirectory snapshot below the directory specified by parameter output_dir. The output directories are automatically created.
  
  
• 波形はymaeda_opentoolsの3次元データファイル形式の1つである3db形式 (独自のファイル形式参照) により出力される。
  The 3db format, which is one of the file formats for 3D-data in ymaeda_opentools (see Special file formats), is used for the output snapshots.
  
  

◆パラメータsnapshot_placeの効果 (Effects of parameter snapshot_place)

• waterPMLコマンドでは食い違い格子を用いており、 変数毎に定義される位置が異なる。 速度の\(x_i\)方向成分\(V_i\) (\(i=0,1,2\))は 格子セルの中心点から\(x_i\)方向にセルのサイズの半分だけずれた位置 (すなわち\(x_i\)軸に直交する格子セル境界面の中心点)で 定義されている(図1)。
  The waterPML command uses a staggered grid, so that different variables are defined at different locations. The \(x_i\) component of the velocity \(V_i\), where \(i=0,1,2\), is defined at the locations that are by the half cell size dislocated along the \(x_i\) direction from the centers of grid calls, i.e., the centers of the boundary planes of grid cells perpendicular to the \(x_i\) axis (Fig. 1).
  
  
• snapshot_place=dの場合、 元々の定義位置(図1)での速度\(V_i\)がそのまま出力される。 この場合、\(V_x\), \(V_y\), \(V_z\)で 出力される位置や空間範囲が異なることになる。
  In case of snapshot_place=d, the velocities \(V_i\) at their original definition points (Fig. 1) are directly written in the snapshots. In this case, the locations and spatial extents of \(V_x\), \(V_y\), and \(V_z\) in the outputs are different with each other.
  
  
• snapshot_place=cの場合、 格子セルの両側での\(V_i\) (図1)を平均することで 格子セル中心点での\(V_i\)を求め、 その値が出力される。 \(V_x\), \(V_y\), \(V_z\)で出力される位置や空間範囲は共通である。
  In case of snapshot_place=c, the value of \(V_i\) at the center of each grid cell is computed by averaging the values of \(V_i\) at the both sides of the cell (Fig. 1). These averaged \(V_i\) are written in the snapshots. The locations and spatial extents of \(V_x\), \(V_y\), and \(V_z\) in the outputs are same.
  
  

図1. 格子セルと速度の定義点の関係。 Fig. 1. The definition points of velocities relative to a grid cell.

◆snapshot_grid=wholeの場合 (In case of snaphsot_grid=whole)

• 計算領域(物理領域とPML領域)の 全ての格子セル中心点(snapshot_place=cの場合) あるいは速度定義点(snapshot_place=dの場合) での速度\(V_i\) (\(i=0,1,2\))が出力される。
  The velocities \(V_i\) (\(i=0,1,2\)) at the centers of all grid cells (in case of snapshot_place=c) or at all velocity definition points (in case of snapshot_place=d) in the computational volume (both the physical and PML volumes) are included in the outputs.
  
  
• 出力ファイル名は 「whole.V成分名.t時刻.3db」となる。 ここで成分名は「x」「y」「z」のいずれかであり、 時刻は小数点以下4桁の実数表記(%.4f)が用いられる。
  The output file name is “whole.Vcomponent name.ttime.3db”, where component name is “x”, “y”, or “z” and time is expressed as a real number with four digits in the decimal part (%.4f).
  
  

◆snapshot_grid=allの場合 (In case of snaphsot_grid=all)

• 物理領域内の全ての格子セル中心点(snapshot_place=cの場合) あるいは速度定義点(物理領域とPML領域の境界面上を含む; snapshot_place=dの場合) での速度\(V_i\) (\(i=0,1,2\))が出力される。
  The velocities \(V_i\) (\(i=0,1,2\)) at the centers of all grid cells in the physical volume (in case of snapshot_place=c) or at all velocity definition points in the physical volume and on the boundaries between physical and PML volumes (in case of snapshot_place=d) are included in the outputs.
  
  
• 出力ファイル名は 「all.V成分名.t時刻.3db」となる。 ここで成分名は「x」「y」「z」のいずれかであり、 時刻は小数点以下4桁の実数表記(%.4f)が用いられる。
  The output file name is “all.Vcomponent name.ttime.3db”, where component name is “x”, “y”, or “z” and time is expressed as a real number with four digits in the decimal part (%.4f).
  
  

◆snapshot_grid=specifyの場合 (In case of snaphsot_grid=specify)

• 設定ファイル で指定した領域(直方体/地表面/水面)ごとに 別々のファイルに出力される。
  The snapshots for different regions (rectangular-solid volumes or ground/water surfaces), specified in the configuration file, are written into separate output files.
  
  
• 出力ファイル名は 「スナップショット名.V成分名.t時刻.3db」となる。 ここで成分名は「x」「y」「z」のいずれかであり、 時刻は小数点以下4桁の実数表記(%.4f)が用いられる。 スナップショット名は 設定ファイル においてパラメータsnapnameで指定した名前である。
  The output file name is “snapshot name.Vcomponent name.ttime.3db”, where component name is “x”, “y”, or “z” and time is expressed as a real number with four digits in the decimal part (%.4f). The snapshot name is the name specified by parameter snapname in the configuration file.
  
  

●出力範囲 (Output range)

• スナップショット出力の空間範囲は 設定ファイル においてパラメータxrange, yrange, zrangeで定義される。 しかし厳密にはこの範囲がそのまま用いられるわけではない。 その様子を図2に示す。
  The spatial extent of the output snapshot is defined by parameters xrange, yrange, and zrange in the configuration file. However, the output range is not exactly identical to this extent, as shown in Fig. 2.
  
  
• 図2において赤枠が パラメータxrange, yrange, zrangeで定義される スナップショット出力の空間範囲を表す。
  The red rectangle in Fig. 2 shows the spatial extent of the snapshot output defined by parameters xrange, yrange, and zrange.
  
  
• 実際の出力範囲は格子セル単位で決まる。 中心点が赤枠の範囲に入っている格子セル(図2の濃い茶色)が出力対象セルとなる。 例えば図2において上から2列目のセルは 中心点が赤枠の範囲に入っているので出力対象になる。 また下から3列目のセルは 中心点が赤枠の範囲外にあるので出力対象にはならない。 左から4列目のセルは中心点がちょうど赤枠の外縁と一致している。 このようなセルも出力対象になる。
  The actual output range is determined in the basis of grid cells. A grid cell is included in the output if its center is in the range of the red rectangle. The dark brown cells in Fig. 2 are the output cells. In this example, the 2nd top cells are included in the output as their centers are in the red rectangle, while the 3rd bottom cells are not included in the output as their centers are outside of the red rectangle. The centers of the 4th left cells are just on the outer boundary of the red rectangle; in this case, the cells are also included in the output.
  
  
• snapshot_place=cの場合、 上でリストアップした格子セル中心点での 速度\(V_i\) (\(i=0,1,2\))が出力される。
  In case of snapshot_place=c, the velocities \(V_i\) (\(i=0,1,2\)) at the center of the grid cells listed above are written in the output snapshots.
  
  
• snapshot_place=dの場合、 上でリストアップした格子セルに接する速度定義点での\(V_i\) が出力される。 図2において濃い青で示した矢印が出力範囲に含まれる速度である。 左から4列目や上から2列目の速度定義点は赤枠の外にあるが、 これらが接する格子セルの中心点が赤枠内にあるので出力に含まれる。
  In case of snapshot_place=d, the velocities \(V_i\) at their definition points that are in contact with the grid cells listed above are included in the output. The dark blue arrows in Fig. 2 show the velocities that are included in the output. The 4th left and 2nd top arrows are outside of the red rectangle but are included in the output because these arrows contact with a grid cell that is in the red rectangle.
  
  
• パラメータxrange, yrange, zrangeで指定される範囲が狭く、 格子セルの中心点を1つも含まない場合には そのスナップショットは出力されない。
  A snapshot is not created if the range specified by parameters xrange, yrange, and zrange is so narrow that no grid cell has its center within the range.
  
  

図2. パラメータxrange, yrange, zrangeで定義されるスナップショットの出力範囲を 赤枠のように設定した場合に 実際に出力対象になる格子セルおよび速度(濃色)。 Fig. 2. Relation between parameters xrange, yrange, and zrange and the actual output. If the parameters point to the spatial extent shown by the red frame, the grid cells and velocities shown by dark colors are included in the actual outputs.

●出力に用いられる地点 (Locations used for the output)

• スナップショットにおける格子点の刻みは 設定ファイル においてパラメータxinc, yinc, zincで指定する。 その値が\(\Delta x\), \(\Delta y\), \(\Delta z\)と異なる (これらの整数倍である)場合、 速度\(V_i\)は空間方向に間引いて出力される。 例えばxinc\(=2\Delta x\)であれば \(V_i\)は\(x\)方向に関して2サンプルおきに出力される。
  The grid node intervals of the snapshot are specified by parameters xinc, yinc, and zinc in the configuration file. If they are different from (i.e., integer multiples of) \(\Delta x\), \(\Delta y\), \(\Delta z\), the velocities \(V_i\) are resampled in space before the output. For example, if xinc\(=2\Delta x\), every 2 samples of \(V_i\) along the \(x\)-direction are included in the output.
  
  
• 具体的な出力地点は以下のように決まる。 パラメータxincで指定されるスナップショットの\(x\)方向の出力地点の間隔を \(\Delta x_{snapshot}\)とする。 snapshot_place=cの場合、 \[\begin{equation} x=x_0+\Delta x/2+n\Delta x_{snapshot} \label{eq.output_location} \end{equation}\] と表される地点での速度が出力される。 ここで\(n\)は整数。 \(\Delta x_{snapshot}\)は\(\Delta x\)の整数倍であるので、 (\ref{eq.output_location})式を満たす地点は格子セルの中心点である。
  The output points are determined as follows. Let \(\Delta x_{snapshot}\) be the output interval of the snapshot along the \(x\)-direction specified by parameter xinc. In case of snapshot_place=c, the velocities at locations given by Eq. (\ref{eq.output_location}), where \(n\) is an integer, are included in the output. Because \(\Delta x_{snapshot}\) is an integer multiple of \(\Delta x\), the locations that satisfy Eq. (\ref{eq.output_location}) are at the center of a grid cell.
  
  
• snapshot_place=dの場合、 \(x\)方向の速度\(V_x\)の出力地点の\(x\)座標は (\ref{eq.output_location})式で与えられる地点の中間地点となる。 \(y\)方向の速度\(V_y\)、\(z\)方向の速度\(V_z\)については (\ref{eq.output_location})式で与えられる地点で出力される。
  In case of snapshot_place=d, the \(x\)-component velocities \(V_x\) at the mid-points of the \(x\)-coordinates given by Eq. (\ref{eq.output_location}) are included in the output; the \(y\)- and \(z\)-component velocities \(V_y\) and \(V_z\) are written at the locations given by Eq. (\ref{eq.output_location}).
  
  
• \(y\), \(z\)方向についても同様の考え方で出力地点が決まる。
  The output points along the \(y\)- and \(z\)-directions are determined in the same manner.
  
  
• 3サンプルに1つの割合で出力する場合の出力地点を図3に示す。 濃い茶色は中心点が(\ref{eq.output_location})式を満たす格子セルであり、 snapshot_place=cの場合にはこれらのセルでの速度が出力される。 一方、snapshot_place=dの場合には濃い青色で示した速度が出力される。
  Fig. 3 shows the output points in case of outputting the velocities at every 3 samples. Dark brown shows the grid cells whose centers satisfy Eq. (\ref{eq.output_location}). In cases of snapshot_place=c, the velocities at these cells are included in the output. In case of snapshot_place=d, the velocities shown by dark blue are included in the output.
  
  

図3. 3サンプルに1つの割合で出力する場合の出力地点。 濃い茶色はsnapshot_place=cの場合に速度を出力する格子セルを表し、 一番左下のセルが出力対象であることがポイントである。 濃い青の矢印はsnapshot_place=dの場合に出力する速度を表し、 濃い茶色のセルのちょうど中間地点が出力対象になっていることがポイントである。 Fig. 3. The output locations in case of outputting every 3 samples. The dark brown colors show the grid cells where the velocities are included in the output in case of snapshot_place=c; note that the bottom left cell is included in the output. The dark blue arrows show the velocities included in the output in case of snapshot_place=d, which are located at the mid-points of the dark brown cells.