Skip to content

Home > User Interface > Results Processing > Batch Post-Processing > Batch Files Format

Batch files format

General file format

Each batch file contains a number of post-processing instructions related to a single analysis or a list of analyses.

The batch files starts with keywords used to specify the names of your simulation files, optional settings for the outputs, and the number of post- processing requests. The file format is illustrated below :

[BEGIN_ANALYSES_LIST]
ANALYSIS_NAME_01
ANALYSIS_NAME_02
ANALYSIS_NAME_03
...
[END_ANALYSES_LIST]
[RESET_DSS_FILES_RESULTS] NO
[SAVE_OUTPUT_TEXT_FILES] YES
NUMBER_OF_GRAPHIC_REQUESTS
[BEGIN_GRAPH]
...
[END_GRAPH]
[BEGIN_GRAPH]
...
[END_GRAPH]
... etc.

[BEGIN_ANALYSES_LIST] and [END_ANALYSES_LIST]:

These keywords are used to specify the list of analysis files to be post- processed using the script file. The names of all analyses to be considered must be located between these 2 keywords. The script must always start with the [BEGIN_ANALYSES_LIST] keyword. Note that for SQL export only one analysis per file could be set.

[RESET_DSS_FILES_RESULTS]:

This keyword is used to specify whether the contents of the DSS simulation files is to be emptied before the post-processing tasks as defined in the script file are run. Possible values are YES and NO. In case the value is set to YES, the DSS file will only include the results as defined in the script file upon completion of post-processing. In case the value is set to NO, requested results will be added to the pre-existing contents of the DSS file.

[SAVE_OUTPUT_TEXT_FILES]:

This keyword is used to specify whether the results are to be stored into text files in addition to the DSS file. Possible values are YES and NO.

Note

The name of your batch file does not require any special file extension.

Available graphics results

Each set of instructions defines between [BEGIN_GRAPH] and [END_GRAPH] defines one graphical request. Theses can be split into four types, as follows :

  • Time Evolution: to get time history plots of any variable.

    [TYPE] TEV
[OBJECT] Name of the object defined in the DeepLines document
if the object is a line:
  [CURV_ABS] List of curvilinear abscissa separated by ;
else:
  [POSITION] Name of the fairlead of the object or COG
if the initial and final times are directly defined through numerical values:
  [TIME_FLAG] BEGINEND
  [TIME_BEGIN] Beginning time or SIMULATION_BEGINING
  [TIME_END] Ending time or SIMULATION_ENDING
else if the initial and final times are defined through a number of last wave periods:
  [TIME_FLAG] LASTPERIODS
  [NB_PERIODS] Real value which corresponds to the number of periods
[VARIABLE] Type of the requested result (see result type section)
if the type of the result is LINE GAP:
  [SECOND_OBJECT] Name of the second line as defined in the DeepLines document
  [CONTROL_POINT] Integer which corresponds to the number of control point
else if the type of he result is STRESS:
  [SECTION_POINT] Integer which corresponds to the number of section point
if the type of analysis is frequency domain:
  [PERIOD_NUMBER] Period number to be considered. Type 0 to get all periods.
else if the analysis is modal:
  [MODE_NUMBER] Mode number
[STAT_ONLY] Statistics only if value > 0
[OUTPUT_FILE_NAME] Result file name (if AUTO is specified, the name is automatically generated).

  • Step Evolution: to get step evolution plots of any variable.

    [TYPE] SEV
[OBJECT] Name of the object defined in the DeepLines document
if the object is a line :
  [CURV_ABS] List of curvilinear abscissa separated by ;
else:
  [POSITION] Name of the fairlead of the object or COG
[STEP_BEGIN] Beginning step or SIMULATION_BEGINING
[STEP_END] Ending step or SIMULATION_ENDING
[VARIABLE] Type of the requested result (See result type section)
if the type of the result is LINE GAP:
  [SECOND_OBJECT] Name of the second line as defined in the DeepLines document
  [CONTROL_POINT] integer which corresponds to the number of control point
else if the type of he result is STRESS:
  [SECTION_POINT] integer which corresponds to the number of section point
[STAT_ONLY] Statistics only if value > 0
[OUTPUT_FILE_NAME] Result file name (if AUTO is specified, the name is automatically generated).

  • Dynamic Snapshot: to get the spatial distribution of any variable at a given time.

    [TYPE] TSN
[OBJECT] Name of the object defined in the DeepLines document
[TIME] List of times separated by ;
[VARIABLE] Type of the requested result (See result type section)
if the type of the result is LINE GAP:
  [SECOND_OBJECT] Name of the second line as defined in the DeepLines document
  [CONTROL_POINT] integer which corresponds to the number of control point
else if the type of he result is STRESS:
  [SECTION_POINT] integer which corresponds to the number of section point
if the type of analysis is frequency domain:
  [PERIOD_NUMBER] Period number to be considered. Type 0 to get all periods.
else if the analysis is modal:
  [MODE_NUMBER] Mode number
[STAT_ONLY] Statistics only if value > 0
[TDP_ONLY] TDP only if value > 0
[OUTPUT_FILE_NAME] Result file name (if AUTO is specified, the name is automatically generated).

  • Static Snapshot: to get the spatial distribution of any variable at a given static step.

    [TYPE] SSN
[OBJECT] Name of the object defined in the DeepLines document
[STEP] List of integers separated by ;.
[VARIABLE] Type of the requested result (See result type section)
if the type of the result is LINE GAP:
  [SECOND_OBJECT] Name of the second line as defined in the DeepLines document
  [CONTROL_POINT] integer which corresponds to the number of control point
else if the type of he result is STRESS:
  [SECTION_POINT] integer which corresponds to the number of section point
[STAT_ONLY] Statistics only if value > 0
[TDP_ONLY] TDP only if value > 0
[OUTPUT_FILE_NAME] Result file name (if AUTO is specified, the name is automatically generated).

  • Envelop : to get the envelop of any variable over a given time period. 

    [TYPE] ENV
[OBJECT] Name of the object defined in the DeepLines document
if the initial and final times are directly defined through numerical values:
  [TIME_FLAG] BEGINEND
  [TIME_BEGIN] Beginning time or SIMULATION_BEGINING
  [TIME_END] Ending time or SIMULATION_ENDING
else if the initial and final times are defined through a number of last wave periods:
  [TIME_FLAG] LASTPERIODS
  [NB_PERIODS] Real value which corresponds to the number of periods
[ABSCISSA_BEGIN] Begin abscissa
[ABSCISSA_END] End abscissa
[VARIABLE] Type of the requested result (See result type section)
if the type of the result is LINE GAP:
  [SECOND_OBJECT] Name of the second line as defined in the DeepLines document
  [CONTROL_POINT] integer which corresponds to the number of control point
else if the type of he result is STRESS:
  [SECTION_POINT] integer which corresponds to the number of section point
if the type of analysis is frequency domain:
  [PERIOD_NUMBER] Period number to be considered. Type 0 to get all periods.
else if the analysis is modal:
  [MODE_NUMBER] Mode number
[STAT_ONLY] Statistics only if value > 0
[OUTPUT_FILE_NAME] Result file name (if AUTO is specified, the name is automatically generated).

  • Wave Evolution

    [TYPE] TWA
[OBJECT] Name of the wave object defined in the DeepLines document
[POSITION_X] Real which corresponds to the X position
[POSITION_Y] Real which corresponds to the Y position
if the initial and final times are directly defined through numerical values:
  [TIME_FLAG] BEGINEND
  [TIME_BEGIN] Real value which corresponds to the beginning time
  [TIME_END] Real value which corresponds to the ending time
else if the initial and final times are defined through a number of last wave periods:
  [TIME_FLAG] LASTPERIODS
  [NB_PERIODS] Real value which corresponds to the number of periods
[VARIABLE] Type of the requested result (See result type section)
if the type of analysis is frequency domain:
  [PERIOD_NUMBER] Period number to be considered. Type 0 to get all periods.
else if the analysis is modal:
  [MODE_NUMBER] Mode number
[STAT_ONLY] Statistics only if value > 0
[OUTPUT_FILE_NAME] Result file name (if AUTO is specified, the name is automatically generated).

  • RMS: to get spectral curve snapshot of any variable.

    [TYPE] RMS
[OBJECT] Name of the object defined in the DeepLines model
[TIME] List of times separated by ;
[TIME_BEGIN] Beginning time
[TIME_END] Ending time
[IS_REGULAR] YES or NO
[IS_PERIOD] YES or NO
[NB_PERIOD] Periods number
[VARIABLE] Type of the requested result (See result type section)
if the type of the result is LINE GAP:
  [SECOND_OBJECT] Name of the second line as defined in the DeepLines document
  [CONTROL_POINT] integer which corresponds to the number of control point
else if the type of he result is STRESS:
  [SECTION_POINT] integer which corresponds to the number of section point
if the type of analysis is frequency domain:
  [PERIOD_NUMBER] Period number to be considered. Type 0 to get all periods.
else if the analysis is modal:
  [MODE_NUMBER] Mode number
[PERIODOGRAM_PARAM_BEGIN]
[WINDOW_LENGTH] Default: 1024
[WINDOW_TYPE] Rectangle, Bartlett, Triangle, Hanning, Hamming or Blackman. Default: Hanning
[OVERLAP_RATE] Overlapping rate. Default: 50
[PERIODOGRAM_PARAM_END]
[STAT_ONLY] Statistics only if value > 0
[OUTPUT_FILE_NAME] Result file name (if AUTO is specified, the name is automatically generated).

  • Response Spectrum: to get spectral curve response spectrum of any variable.

    [TYPE] RSP
[OBJECT] Name of the object defined in the DeepLines document for the primary variable of the RAO (usually wave elevation)
if the object is a line:
  [CURV_ABS] List of curvilinear abscissa separated by ;
else if the object is a floater:
  [POSITION] Name of the fairlead of the object or COG
[TIME_BEGIN] Beginning time or SIMULATION_BEGINING
[TIME_END] Ending time or SIMULATION_ENDING
[VARIABLE] Type of the requested result (See result type section)
if the type of the result is LINE GAP:
  [SECOND_OBJECT] Name of the second line as defined in the DeepLines document
  [CONTROL_POINT] integer which corresponds to the number of control point
else if the type of he result is STRESS:
  [SECTION_POINT] integer which corresponds to the number of section point
if the type of analysis is frequency domain:
  [PERIOD_NUMBER] Period number to be considered. Type 0 to get all periods.
else if the analysis is modal:
  [MODE_NUMBER] Mode number
[PERIODOGRAM_PARAM_BEGIN]
[WINDOW_LENGTH] Default: 1024
[WINDOW_TYPE] Rectangle, Bartlett, Triangle, Hanning, Hamming or Blackman. Default: Hanning
[OVERLAP_RATE] Overlapping rate. Default: 50
[PERIODOGRAM_PARAM_END]
[STAT_ONLY] Statistics only if value > 0
[OUTPUT_FILE_NAME] Result file name (if AUTO is specified, the name is automatically generated).

  • RAO: to get RAO of any variable.

    [TYPE] RAO
[OBJECT1] Name of the object for the primary variable of the RAO (usually wave elevation)
if the object is a line:
  [CURV_ABS] List of curvilinear abscissa separated by ;
else if the object is a floater:
  [POSITION] Name of the fairlead of the object or COG
[TIME_BEGIN] Beginning time or SIMULATION_BEGINING
[TIME_END] Ending time or SIMULATION_ENDING
[VARIABLE1] Type of the requested result (See result type section)
if the type of he primary result is STRESS
  [SECTION_POINT1] integer which corresponds to the number of section point
[OBJECT2] Name of the object for the secondary variable of the RAO.
if the object is a line:
  [CURV_ABS] List of reals separated by ;
else:
  [POSITION] Name of the fairlead of the object or COG
[VARIABLE2] Type of the requested result (See result type section)
if the type of he primary result is STRESS
  [SECTION_POINT2] integer which corresponds to the number of section point
[PERIODOGRAM_PARAM_BEGIN]
[WINDOW_LENGTH] Default: 1024
[WINDOW_TYPE] Rectangle, Bartlett, Triangle, Hanning, Hamming or Blackman. Default: Hanning
[OVERLAP_RATE] Overlapping rate. Default: 50
[PERIODOGRAM_PARAM_END]
[STAT_ONLY] Statistics only if value > 0
[OUTPUT_FILE_NAME] Result file name (if AUTO is specified, the name is automatically generated).

Note

The order of the different keywords must be respected.

Specific keywords for database output

If the export format is SQLite database, for all graph types, the following keywords can be used:

[COEFF] The result will be multiplied by this real value, if [FUNCTION] was not filled.
[TABLE_NAME] Name of a specific table to export the variable in a dedicated table.
[FUNCTION] Name of a Python function. The current variable is the result of the call to this Python function.
You have to fill the [TABLE_NAME] when more than 2000 columns are used in auto created tables.

In the case where the [FUNCTION] name is present, the [COEFF] value is passed at the last argument of the Python function.

More information can be found in 10_Export_SQL examples.

More details about the Python function specified with the [FUNCTION] keyword can be found in the How to define your functions section.

Types of results

The different types of results which can be requested are listed in the tables below :

Type of result Position Displacement Velocity
Name of variables POSITIONABS DISPABS VELOCITYABS
POSITIONX DISPX VELOCITYX
POSITIONY DISPY VELOCITYY
POSITIONZ DISPZ VELOCITYZ
THETAABS DISPRX VELOCITYRX
THETAX DISPRY VELOCITYRY
THETAY DISPRZ VELOCITYRZ
THETAZ DISPHOR VERTVELOCITYWRTSEA
VERTPOSITIONWRTSEA DISPHORAZ VELOCITYHOR
TDP_ABSCISSA VELOCITYHORAZ
TDP_LYING_LENGTH
Type of result Acceleration Curvature Strain
Name of variables ACCELERATIONABS CURVABS STRAINSHEARABS
ACCELERATIONX CURVGLOBX STRAINAXIAL
ACCELERATIONY CURVGLOBY STRAINTORSION
ACCELERATIONZ CURVGLOBZ STRAINGLOBX
ACCELERATIONRX CURVGLOBVEC STRAINGLOBY
ACCELERATIONRY CURVLOC1 STRAINGLOBZ
ACCELERATIONRZ CURVLOC2 STRAINGLOBVEC
VERTACCELERATIONWRTSEA CURVLOC3 STRAINLOC1
ACCELERATIONHOR CURVLOCVEC STRAINLOC2
ACCELERATIONHORAZ STRAINLOC3
STRAINLOCVEC
Type of result Stress Force Moment
Name of variables STRESSAXIAL FORCESHEARABS MOMENTBEND
STRESSRADIAL TENSIONEFFECT MOMENTTORSION
STRESSHOOP TENSIONEFFECTMAINTUBE MOMENTLOC1
STRESSAXIALBENDEXTERNAL TRUETENSION MOMENTLOC2
STRESSAXIALBENDINTERNAL FORCELOC1 MOMENTLOC3
STRESSBENDEXTERNAL FORCELOC2 MOMENTGLOBX
STRESSBENDINTERNAL FORCELOC3 MOMENTGLOBY
STRESSVONMISESEXTERNAL FORCEGLOBX MOMENTGLOBZ
STRESSVONMISESINTERNAL FORCEGLOBY REACTION_MOMENT_ABS
FORCEGLOBZ REACTION_MOMENT_X
REACTION_FORCE_ABS REACTION_MOMENT_Y
REACTION_FORCE_X REACTION_MOMENT_Z
REACTION_FORCE_X REACTION_MOMENT_Z
REACTION_FORCE_Y REACTION_MOMENT_LOCX
REACTION_FORCE_Z REACTION_MOMENT_LOCY
REACTION_FORCE_LOCX REACTION_MOMENT_LOCZ
REACTION_FORCE_LOCY REACMOMENTTHOR
REACTION_FORCE_LOCZ REACMOMENTTHORAZ
REACFORCETHOR
REACFORCETHORAZ
Type of result Vertical Angle Built-in angle Line gap
Name of variables VERTANGLEABS BUILTINABS LINEGAPMEANABS
VERTANGLEAROUNDX BUILTINAROUNDX LINEGAPMEANX
VERTANGLEAROUNDY BUILTINAROUNDY LINEGAPMEANY
VERTANGLEXAROUNDZ BUILTINZPROJ LINEGAPMEANZ
LINEGAPDIAMABS
LINEGAPDIAMX
LINEGAPDIAMY
LINEGAPDIAMZ
Type of result Wave Auxiliary lines
Name of variables WAVEELEVATION AUXILIARYEFFECTIVETENS
WAVEVELOCITYX AUXILIARYAXIALSTRESS
WAVEVELOCITYY AUXILIARYRADIALSTRESS
WAVEVELOCITYZ AUXILIARYCIRCUMSTRESS
WAVEACCELERATIONX AUXILIARYAXIALBENDINGSTRESS
WAVEACCELERATIONY AUXILIARYBENDINGSTRESS
AUXILIARYVONMISESSTRESS
Type of result Contact
Name of variables CONTACT_ENERGY
VERTICAL_REACTION
AXIAL_FRICTION_FORCE
LATERAL_FRICTION_FORCE
FRICTION_MOMENT
TRENCH_RESISTANCE
Type of result DNV code checks
Name of variables DNVF101ALSNORM
DNVF101ALSHIGH
DNVF101ALSLOW
DNVF101ULSNORM
DNVF101ULSHIGH
DNVF101ULSLOW
DNVF201ALSNORM
DNVF201ALSHIGH
DNVF201ALSLOW
DNVF201ULSNORM
DNVF201ULSHIGH
DNVF201ULSLOW
GetNV96VONMISESSTRESS
GetNV96AXIALSTRESS
GetNV96HOOPSTRESS
DNV81EXTERNAL
DNV81INTERNAL