Frame Parameters

This section expands on frame suite set up sliding frame for water wading applications.

The frame suite was developed in order to address the use case of water wading, specifically the case where the vehicle is entering a body of water under a specified angle and moving through an arbitrarily long channel. The basic idea behind the frame suite is to have a simple set of parameters that define the setup, for example, define the road, water depth and domain boundary behavior, yet maintain high computational efficiency and simplify pre-processing.
framesuite
{
    frame_obj_phase                          2
    frame_fluid_phase                        1
    frame_road_phase                         3
    frame_road_profile_file_name             road_profile.txt
    frame_road_path_file_name                road_path.txt
    frame_road_stencil_clip_height           -0.4
    frame_fluid_height                       -0.6
    frame_lock_mode                          0
    frame_min_bc_overlay                     "3 0 0"
    frame_max_bc_overlay                     "3 0 0"
    frame_freeze_layer_length                0.05
    frame_sponge_layer_length                0.05
    frame_freezesponge_min_bc_clip           "1 1"
    frame_freezesponge_max_bc_clip           "1 1"
    frame_freezesponge_min_bc_height         "-0.6 -0.6"
    frame_freezesponge_max_bc_height         "-0.6 -0.6"
}
frame_obj_phase
The phase of interest to be followed by the frame (car body).
The body which is followed must be defined as a MOVINGWALL.
frame_fluid_phase
Fluid phase ID (water) which is spawned as the frame moves.
frame_road_phase
Road phase ID (road) which is spawned as the frame moves.
The road phase which is spawned must be defined as a MOVINGWALL.
frame_road_profile_file_name
Absolute or relative path to the file containing road top profile in YZ plane.
The file consists of two columns of the form Y Z where Y coordinate is strictly increasing.
frame_road_path_file_name
Absolute or relative path to the file containing road path in XZ plane.
This is a two column file of the form X Z where X coordinate is strictly increasing.
frame_road_stencil_clip_height
Absolute Z coordinate above which the spawned road particles are removed.
Unit: [m]
Default: 0.0
frame_fluid_height
Absolute Z coordinate below which the fluid spawns.
This means the fluid depth in Z direction is the difference between frame_fluid_height and minimum Z value in frame_road_path_file_name file.
Unit: [m]
Default: 0.0
frame_lock_mode
The mode in which the frame follows the phase of interest in XZ plane.
Set to 0 to follow the translation of the phase of interest in X direction only (lock to line).
Set to 1 to translate in both X and Z directions (lock to point).
Options: 0 / 1
Default: 0
frame_min_bc_overlay
The layout of additional internal layers at the frame domain boundaries lying on the minimum planes in X, Y and Z directions.
The command is a vector representing the minimum X, Y and Z boundaries. For example "0 0 0" implies that no layers are applied on any of the minimum domain boundaries.
0
No additional layers are applied.
1
Only freeze layers are added.
2
Only sponge layers are added.
3
Both freeze and sponge layers are applied with freeze layer being the outer layer.
Options: 0, 1, 2 and 3
Default: "0 0 0"
frame_max_bc_overlay
The layout of additional internal layers at the frame domain boundaries lying on the maximum planes in X, Y and Z directions.
The command is a vector representing the maximum X, Y and Z boundaries. For example "0 0 0" implies that no layers are applied on any of the maximum domain boundaries.
0
No additional layers are applied.
1
Only freeze layers are added.
2
Only sponge layers are added.
3
Both freeze and sponge layers are applied with freeze layer being the outer layer.
Options: 0, 1, 2 and 3
Default: "0 0 0"
frame_freeze_layer_length
Absolute length of the freeze layer in a direction perpendicular to the relevant bounding plane pointing toward the computational domain. Has no effect when non-positive. Has no effect on directions of frame_min_bc_overlay and/or frame_max_bs_overlay when these command values are set to 0 or 2.
Unit: [m]
Default: 0.0
frame_sponge_layer_length
Absolute length of the freeze layer in a direction perpendicular to the relevant bounding plane pointing toward the computational domain. Has no effect when non-positive. Has no effect on directions of frame_min_bc_overlay and/or frame_max_bs_overlay when these command values are set to 0 or 1.
Unit: [m]
Default: 0.0
frame_freezesponge_min_bc_clip
Freeze and sponge layer clip height selection mode in Z direction for X = C and Y = C minimum bounding planes, respectively. Therefore, this command has a 2-value vector of the form "0 0". Set to 0 to cover entire plane height in Z. Set to 1 to limit the freeze and sponge layer in absolute Z direction to below frame_fluid_height +0.5*dx. Set to 2 to specify a custom height using frame_freezesponge_min_bc_height.
Default: "0 0"
frame_freezesponge_max_bc_clip
Freeze and sponge layer clip height selection mode in Z direction for X = C and Y = C maximum bounding planes, respectively. Therefore, this command has a 2-value vector of the form "0 0". Set to 0 to cover entire plane height in Z. Set to 1 to limit the freeze and sponge layer in absolute Z direction to below frame_fluid_height +0.5*dx. Set to 2 to specify a custom height using frame_freezesponge_max_bc_height.
Default: "0 0"
frame_freezesponge_min_bc_height
The absolute Z coordinate in X = C and Y = C minimum bounding planes, respectively, above which freeze and sponge layers are applied. Only active when the relevant frame_freezesponge_min_bc_clip is set to 2.
Unit: [m]
Default: "0.0 0.0"
frame_freezesponge_max_bc_height
The absolute Z coordinate in X = C and Y = C maximum bounding planes, respectively, below which freeze and sponge layers are applied. Only active when the relevant frame_freezesponge_max_bc_clip is set to 2.
Unit: [m]
Default: "0.0 0.0"