snapshot2sequenceコマンドマニュアル

(The documentation of snapshot2sequence command)

Last Update: 2024/7/19

◆機能・用途(Purpose)

時刻毎に別々の3次元データファイルに格納されている波動場のデータ(スナップショット) から特定の位置での値を取り出して1つの時系列データ(波形)にする。
From data of wave field stored as separate 3-D data files (snapshots) at individual time steps, extract the values at a location to create a time series data (an waveform).

位置$(x,y,z)$と時刻$t$の関数である波動場$f(x,y,z,t)$を考える。一定の空間刻み$x=x_{min}+p\Delta t$, $y=y_{min}+q\Delta t$, $z=z_{min}+r\Delta t$ および時間刻み$t=t_{min}+k\Delta t$で$f(x,y,z,t)$が与えられているものとする。ここで$p$, $q$, $r$および$k$は非負の整数、 $\Delta x$, $\Delta y$, $\Delta z$, $\Delta t$は正の実数である。この$f(x,y,z,t)$をファイルに記録する方式として、時刻毎に別々のファイルに分割して位置の関数(3次元データ)として記録する方法と、位置毎に別々のファイルに分割して時刻の関数(時系列データ)として記録する方法が考えられる。このプログラムでは前者の方法で記録されたデータを後者の方法に変換する。但し、全ての地点での時系列データを作成するのではなく、ユーザが指定した特定の1地点での時系列データを作成する。
Consider a wave field $f(x,y,z,t)$, which is a function of location $(x,y,z)$ and time $t$. Suppose that the locations and times are sampled at constant intervals $x=x_{min}+p\Delta t$, $y=y_{min}+q\Delta t$, $z=z_{min}+r\Delta t$, and $t=t_{min}+k\Delta t$, where $p$, $q$, $r$, and $k$ are non-negative integers and $\Delta $, $\Delta y$, $\Delta z$, and $\Delta t$ are positive real numbers. The data of $f(x,y,z,t)$ may be recorded in files by two different methods: one is to divide the data by time steps and record as a function of location (a 3-D data) for each time step; the other is to divide the data by locations and record as a function of time (a time series data) for each location. This program converts data recorded by the former method to the latter one. However, this program does not create time series data at all locations; it creates a time series data at a location specified by the user.

◆ソースコード(Source code)

$YMAEDA_OPENTOOL_DIR/sequence/src/snapshot2sequence.c

◆使用方法(Usage)

コマンドライン引数でパラメータを指定する。パラメータの一覧を下表に示す。
Specify parameters by command-line arguments. The table below shows a list of parameters.

●「-」から始まらない引数 (Arguments not beginning with “-”)

このコマンドでは「-」から始まらない引数は存在しない。
This command does not have arguments not beginning with “-”.

●1つの「-」から始まる引数 (Arguments beginning with a single “-”)

このコマンドでは1つの「-」から始まる引数は存在しない。
This command does not have arguments beginning with a single “-”.

●「--パラメータ名=パラメータ値」の形式の引数 (Arguments of a form “--Parameter name=Parameter Value”)

「--パラメータ名=パラメータ値」の形式の引数は自由な順番で指定できる。「-」から始まらない引数の間に挿入しても良い。相反する指定がなされた場合には後の指定が優先される。デフォルト値を持つパラメータは省略できる。
Arguments of a form “--Parameter name=Parameter Value” can be placed in an arbitrary order. They can even be inserted between arguments not beginning with “-”. In case of conflicting options being specified, the latter option has a higher priority. Parameters that have default values can be omitted.

パラメータ名 Parameter name	意味 Meaning	可能なパラメータ値 Allowed parameter values	デフォルト値 Default value
inputfile_pattern	読み込む3次元データファイル名のパターンを表す文字列。 A string that represents a pattern of the file names of the 3-D data to read. ※ファイル名は時刻(秒)を表す文字列を含んでいなければならず、かつその部分以外は全ファイルで共通でなければならない。これにより、入力ファイル名は時刻を含むパターン文字列として与えることが可能になる。またファイルはymaeda_opentoolsの3次元データファイル形式 (独自のファイル形式参照) のいずれかでなければならない。 ∗ The file names must consist of a string that represents a time (s), and the other part of the file names must be same in all files to read. This requirement enables the file names to be expressed as a pattern string that includes time. The file format must be one of the formats for 3-D data in ymaeda_opentools (see Special file formats).	ファイル名のうちの時刻を表す部分を「:TIME:」に置き換えた文字列。例えばファイル名がsnapshot/t∗.3dbで∗の部分に時刻が入るならこのパラメータの値はsnapshot/t:TIME:.3dbとする。 A string obtained by replacing the time in the file names by “:TIME:”. For example, if the file names are snapshot/t∗.3db, where ∗ is time, then the value of this parameter is snapshot/t:TIME:.3db.	省略不可 Cannot be omitted
Ndigits	3次元データファイル名における時刻を表す文字列の小数部分の桁数。 The number of digits in the decimal part of the strings that represents a time in the 3-D data file names.	非負の整数。 A non-negative integer.	省略不可 Cannot be omitted
tmin	読み込むデータの先頭時刻$t_{min}$(s)。 The beginning time $t_{min}$ (s) of the data to read.	実数。 A real number.	0.0
tmax	読み込むデータの末尾時刻$t_{max}$(s)。 The end time $t_{max}$ (s) of the data to read.	$t_{min}$よりも大きな実数。 A real number greater than $t_{min}$.	省略不可 Cannot be omitted
tinc	読み込むデータの時間刻み$\Delta t$(s)。 The time stepping $\Delta t$ (s) of the data to read.	正の実数。$t_{max}-t_{min}$の約数でなければならない。 A positive real number that is a divisor of $t_{max}-t_{min}$.	省略不可 Cannot be omitted
outputfile	出力する時系列データファイル名。 A file name of the output time series data.	ファイル名を表す文字列。拡張子はymaeda_opentoolsの時系列データファイル形式 (独自のファイル形式参照) のいずれかでなければならない。 A string that represents a file name. The extension must be that for one of the time series data in ymaeda_opentools (see Special file formats).	省略不可 Cannot be omitted
x	時系列データを出力する地点の$x$座標。 The $x$-coordinate of the location where the time series data is to be created.	実数。3次元データの格子点でなければならない。 A real number. The coordinate must be at a grid node of the 3-D data.	省略不可 Cannot be omitted
y	時系列データを出力する地点の$y$座標。 The $y$-coordinate of the location where the time series data is to be created.	実数。3次元データの格子点でなければならない。 A real number. The coordinate must be at a grid node of the 3-D data.	省略不可 Cannot be omitted
z	時系列データを出力する地点の$z$座標。 The $z$-coordinate of the location where the time series data is to be created.	実数。3次元データの格子点でなければならない。 A real number. The coordinate must be at a grid node of the 3-D data.	省略不可 Cannot be omitted

◆動作(Behaviour)

パラメータtmin, tmax, tincで指定した時刻におけるパラメータinputfile_patternで指定した3次元データファイルを読み込み、それを元にパラメータx,y,zで指定した位置での時系列データを作成してパラメータoutputfileで指定したファイルに出力する。
Read 3-D data files specified by parameter inputfile_pattern at time steps specified by parameters tmin, tmax, and tinc, from which create a time series data at the location specified by parameters x, y, and z, and output the result into the file specified by parameter outputfile.

◆使用例(Example)

以下のファイルが存在するものとする。

snapshot/t0.00.3db (時刻$t=0.00$ sにおけるデータ)
snapshot/t0.05.3db (時刻$t=0.05$ sにおけるデータ)
snapshot/t0.10.3db (時刻$t=0.10$ sにおけるデータ)
snapshot/t0.15.3db (時刻$t=0.15$ sにおけるデータ)
…
snapshot/t100.00.3db (時刻$t=100.00$ sにおけるデータ)

これを元に位置$x=100$, $y=200$, $z=-300$での時系列データを作成し、ファイルwaveform.x100y200z-300.seq1に出力するには以下のコマンドを実行する。
Suppose that the files listed below are present:

snapshot/t0.00.3db (data at time $t=0.00$ s);
snapshot/t0.05.3db (data at time $t=0.05$ s);
snapshot/t0.10.3db (data at time $t=0.10$ s);
snapshot/t0.15.3db (data at time $t=0.15$ s);
…;
snapshot/t100.00.3db (data at time $t=100.00$ s).

To synthesize a time series data at a location $x=100$, $y=200$, $z=-300$ from these 3-D data and output the result into a file waveform.x100y200z-300.seq1, execute the command below.

snapshot2sequence --inputfile_pattern=snapshot/t:TIME:.3db --Ndigits=2 --tmax=100.0 --tinc=0.05 --outputfile=waveform.x100y200z-300.seq1 --x=100.0 --y=200.0 --z=-300.0

snapshot2sequenceコマンド マニュアル