oct-convert

Name ConvertEnd
Section Utilities::oct-convert
Type integer
Default 1

The last number of the filename or folder.

Name ConvertEnergyMax
Section Utilities::oct-convert
Type float
Default w_max

Maximum energy to output from Fourier transform.

Name ConvertEnergyMin
Section Utilities::oct-convert
Type float
Default 0.0

Minimum energy to output from Fourier transform.

Name ConvertEnergyStep
Section Utilities::oct-convert
Type float
Default $2\; \backslash pi\; /\; T$, where $T$ is the total propagation time

Energy step to output from Fourier transform. Sampling rate for the Fourier transform. If you supply a number equal or smaller than zero, then the sampling rate will be $2 \pi / T$, where $T$ is the total propagation time.

Name ConvertFilename
Section Utilities::oct-convert
Type string
Default “density”

Input filename. The original filename which is going to be converted in the format specified in OutputFormat. It is going to convert various files, it should only contain the beginning of the name. For instance, in the case of the restart files, it should be one space ' ‘.

Name ConvertFolder
Section Utilities::oct-convert
Type string

The folder name where the input files are. The default is td. if ConvertIterateFolder = true, otherwise restart.

Name ConvertFTMethod
Section Utilities::oct-convert
Type integer
Default FAST_FOURIER

Describes the method used to perform the Fourier Transform

Options:

• fast_fourier:
  Uses Fast Fourier Transform as implemented in the external library.
  
• standard_fourier:
  Uses polinomial approach to the computation of discrete Fourier Transform. It uses the same variable described in how to obtain spectrum from a time-propagation calculation.
  

Name ConvertHow
Section Utilities::oct-convert
Type integer
Default convert_format

Select how the mesh function will be converted.

Options:

• format:
  The format of the mesh function will be convert from the binary file.obf. The format of the output function is set by OutputHow variable.
  
• fourier_transform:
  A fourier transform of the mesh function will be computed. It requieres that ConvertStart and ConvertEnd have to be set.
  
• operation:
  Convert utility will generate a new mesh function constructed by linear combination of scalar function of different mesh functions,
  

Name ConvertIterateFolder
Section Utilities::oct-convert
Type logical
Default true

This variable decides if a folder is going to be iterated or the filename is going to be iterated.

Name ConvertOutputFilename
Section Utilities::oct-convert
Type string
Default “density”

Output filename. The name of the file in which the converted mesh function will be written in the format specified in OutputFormat.

Name ConvertOutputFolder
Section Utilities::oct-convert
Type string

The folder name where the output files will be write. The default is convert.

Name ConvertReadSize
Section Utilities::oct-convert
Type integer
Default mesh%np

How many points are read at once. For the parallel run this has not been yet tested, so it should be one. For the serial run, a number of 100-1000 will speed-up the execution time by this factor.

Name ConvertScalarOperation
Section Utilities::oct-convert
Type block

This variable is used to generate a new mesh function as a linear combination different mesh function having the same mesh. Each row defines an operation for for a single mesh function. The format of the block is the following:
‘variable name’ | ‘folder’ | ‘file’ | ‘operation’

Name ConvertStart
Section Utilities::oct-convert
Type integer

The starting number of the filename or folder. Default is 0 if ConvertIterateFolder = true, otherwise 1.

Name ConvertStep
Section Utilities::oct-convert
Type integer
Default 1

The padding between the filenames or folder.

Name ConvertSubtract
Section Utilities::oct-convert
Type logical
Default false

Decides if a reference file is going to be subtracted.

Name ConvertSubtractFilename
Section Utilities::oct-convert
Type string
Default density

Input filename. The file which is going to subtracted to rest of the files.

Name ConvertSubtractFolder
Section Utilities::oct-convert
Type string
Default .

The folder name which is going to be subtracted.