Input URI
{base url} + db/WVLD |
---|
Active Methods
POST, GET, PUT, DELETE |
---|
JSON Schema
Details
"WVLD": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"NAME": {
"description": "WaveLoadName",
"type": "string"
},
"DESC": {
"description": "Description",
"type": "string"
},
"bSTLD": {
"description": "UseStaticLoadGeneration",
"type": "boolean"
},
"bTHIS": {
"description": "UseTimeHistoryLoadGeneration",
"type": "boolean"
},
"NAME_THIS": {
"description": "TimeHistoryLoadCaseName",
"type": "string"
},
"VERT_COORD": {
"description": "VerticalCoordinate",
"type": "string"
},
"DENSITY": {
"description": "WaterWeightDensity",
"type": "number"
},
"DEPTH": {
"description": "WaterDepth",
"type": "number"
},
"COEF": {
"description": "Drag&InertiaCoefficients",
"type": "object",
"properties": {
"TYPE": {
"description": "Type",
"type": "string"
},
"COEF_S": {
"description": "Coefficientssarray",
"type": "array",
"items": {
"type": "object",
"properties": {
"GRUP": {
"description": "StructureGroupName",
"type": "string"
},
"DIA": {
"description": "Diameter",
"type": "number"
},
"DRAG_COEF_X": {
"description": "DragCoefficientX",
"type": "number"
},
"DRAG_COEF_Y": {
"description": "DragCoefficientY",
"type": "number"
},
"DRAG_COEF_Z": {
"description": "DragCoefficientZ",
"type": "number"
},
"INER_COEF_X": {
"description": "InertiaCoefficientX",
"type": "number"
},
"INER_COEF_Y": {
"description": "InertiaCoefficientY",
"type": "number"
},
"INER_COEF_Z": {
"description": "InertiaCoefficientZ",
"type": "number"
}
}
}
},
"COEF_R": {
"description": "Coefficientsrarray",
"type": "array",
"items": {
"type": "object",
"properties": {
"GRUP": {
"description": "StructureGroupName",
"type": "string"
},
"DIA": {
"description": "Diameter",
"type": "number"
},
"DRAG_COEF_X": {
"description": "DragCoefficientX",
"type": "number"
},
"DRAG_COEF_Y": {
"description": "DragCoefficientY",
"type": "number"
},
"DRAG_COEF_Z": {
"description": "DragCoefficientZ",
"type": "number"
},
"INER_COEF_X": {
"description": "InertiaCoefficientX",
"type": "number"
},
"INER_COEF_Y": {
"description": "InertiaCoefficientY",
"type": "number"
},
"INER_COEF_Z": {
"description": "InertiaCoefficientZ",
"type": "number"
}
}
}
},
"bOVER": {
"description": "OverrideCoefficientswithStructureGroup",
"type": "boolean"
},
"OVER_S": {
"description": "OverrideCoefficientssarray",
"type": "array",
"items": {
"type": "object",
"properties": {
"GRUP": {
"description": "StructureGroupName",
"type": "string"
},
"DIA": {
"description": "Diameter",
"type": "number"
},
"DRAG_COEF_X": {
"description": "DragCoefficientX",
"type": "number"
},
"DRAG_COEF_Y": {
"description": "DragCoefficientY",
"type": "number"
},
"DRAG_COEF_Z": {
"description": "DragCoefficientZ",
"type": "number"
},
"INER_COEF_X": {
"description": "InertiaCoefficientX",
"type": "number"
},
"INER_COEF_Y": {
"description": "InertiaCoefficientY",
"type": "number"
},
"INER_COEF_Z": {
"description": "InertiaCoefficientZ",
"type": "number"
}
}
}
},
"OVER_R": {
"description": "OverrideCoefficientsrarray",
"type": "array",
"items": {
"type": "object",
"properties": {
"GRUP": {
"description": "StructureGroupName",
"type": "string"
},
"DIA": {
"description": "Diameter",
"type": "number"
},
"DRAG_COEF_X": {
"description": "DragCoefficientX",
"type": "number"
},
"DRAG_COEF_Y": {
"description": "DragCoefficientY",
"type": "number"
},
"DRAG_COEF_Z": {
"description": "DragCoefficientZ",
"type": "number"
},
"INER_COEF_X": {
"description": "InertiaCoefficientX",
"type": "number"
},
"INER_COEF_Y": {
"description": "InertiaCoefficientY",
"type": "number"
},
"INER_COEF_Z": {
"description": "InertiaCoefficientZ",
"type": "number"
}
}
}
}
}
},
"CHAR": {
"description": "WaveCharacteristics",
"type": "object",
"properties": {
"THEORY": {
"description": "TheoryType",
"type": "string"
},
"FUNC": {
"description": "FunctionOrder",
"type": "integer"
},
"DIR": {
"description": "WaveDirection",
"type": "number"
},
"HEIGHT": {
"description": "WaveHeight",
"type": "number"
},
"CHAR_TYPE": {
"description": "WaveLength/WavePeriod",
"type": "string"
},
"LENGTH": {
"description": "Length",
"type": "number"
},
"PERIOD": {
"description": "Period",
"type": "number"
},
"K_FACTOR": {
"description": "KinematicsFactor",
"type": "number"
},
"SURFACE_V": {
"description": "CurrentSurfaceVelocity",
"type": "number"
},
"BOTTOM_Y": {
"description": "CurrentBottomVelocity",
"type": "number"
}
}
},
"PROF": {
"description": "CurrentProfile",
"type": "object",
"properties": {
"CUR_DIR": {
"description": "CurrentDirection",
"type": "number"
},
"CUR_FACTOR": {
"description": "CurrentBlockageFactor",
"type": "number"
},
"GRID_DATA": {
"description": "GridData",
"type": "array",
"items": {
"type": "object",
"properties": {
"D": {
"description": "Elevation",
"type": "number"
},
"V": {
"description": "Velocity",
"type": "number"
}
}
}
}
}
},
"FLOOD_GRUP": {
"description": "FloodCondition",
"type": "array",
"items": {
"type": "string"
}
},
"GROWTH": {
"description": "MarineGrowth",
"type": "array",
"items": {
"type": "object",
"properties": {
"Z": {
"description": "Elevation",
"type": "number"
},
"T": {
"description": "Thickness",
"type": "number"
}
}
}
},
"GRID_X": {
"description": "GridXsize",
"type": "integer"
},
"GRID_Z": {
"description": "GridYsize",
"type": "integer"
},
"USERGRID": {
"description": "UserDefinedGridData",
"type": "array",
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"X": {
"description": "X",
"type": "number"
},
"Z": {
"description": "Z",
"type": "number"
},
"ELEV": {
"description": "Elevation",
"type": "number"
},
"VX": {
"description": "Vx",
"type": "number"
},
"VCX": {
"description": "Vcx",
"type": "number"
},
"VT": {
"description": "Vt",
"type": "number"
},
"VZ": {
"description": "Vz",
"type": "number"
},
"AX": {
"description": "Ax",
"type": "number"
},
"AZ": {
"description": "Az",
"type": "number"
}
},
"maxItems": 73
},
"maxItems": 20
}
},
"TRAJ": {
"description": "TrajectoryGridData",
"type": "array",
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"X": {
"description": "X",
"type": "number"
},
"Z": {
"description": "Z",
"type": "number"
},
"ELEV": {
"description": "Elevation",
"type": "number"
},
"VX": {
"description": "Vx",
"type": "number"
},
"VCX": {
"description": "Vcx",
"type": "number"
},
"VT": {
"description": "Vt",
"type": "number"
},
"VZ": {
"description": "Vz",
"type": "number"
},
"AX": {
"description": "Ax",
"type": "number"
},
"AZ": {
"description": "Az",
"type": "number"
}
},
"maxItems": 73
},
"maxItems": 10
}
},
"bSELFW": {
"description": "UseSelfWeight",
"type": "boolean"
},
"bBUOYANT": {
"description": "UseBuoyancyLoad",
"type": "boolean"
},
"CREST": {
"description": "CrestCriticalPosition",
"type": "string"
},
"UNIT": {
"description": "CrestPositionUnit",
"type": "string"
},
"INITAL_POS": {
"description": "InitialPosition",
"type": "number"
},
"STEP": {
"description": "IncreaseStep",
"type": "number"
},
"POS": {
"description": "NumberofPositions",
"type": "integer"
}
}
}
}
Examples
Wave Loads
"Assign": {
"1": {
"NAME": "TEST1",
"DESC": "",
"bSTLD": true,
"bTHIS": false,
"NAME_THIS": "",
"VERT_COORD": "GLOBAL_Z",
"DENSITY": 10,
"DEPTH": 10,
"COEF": {
"TYPE": "CONST",
"COEF_S": [
{
"GRUP": "",
"DIA": 0.013,
"DRAG_COEF_X": 0,
"DRAG_COEF_Y": 0.65,
"DRAG_COEF_Z": 0.65,
"INER_COEF_X": 0,
"INER_COEF_Y": 1.65,
"INER_COEF_Z": 1.65
}
],
"COEF_R": [
{
"GRUP": "",
"DIA": 0.013,
"DRAG_COEF_X": 0,
"DRAG_COEF_Y": 0.65,
"DRAG_COEF_Z": 0.65,
"INER_COEF_X": 0,
"INER_COEF_Y": 1.65,
"INER_COEF_Z": 1.65
}
],
"bOVER": false,
"OVER_S": [
{
"GRUP": "",
"DIA": 0,
"DRAG_COEF_X": 0,
"DRAG_COEF_Y": 0.65,
"DRAG_COEF_Z": 0.65,
"INER_COEF_X": 0,
"INER_COEF_Y": 1.65,
"INER_COEF_Z": 1.65
}
],
"OVER_R": [
{
"GRUP": "",
"DIA": 0,
"DRAG_COEF_X": 0,
"DRAG_COEF_Y": 0.65,
"DRAG_COEF_Z": 0.65,
"INER_COEF_X": 0,
"INER_COEF_Y": 1.65,
"INER_COEF_Z": 1.65
}
]
},
"CHAR": {
"THEORY": "AIRY",
"FUNC": 1,
"DIR": 0,
"HEIGHT": 2,
"CHAR_TYPE": "PERIOD",
"LENGTH": 36.58115359112376,
"PERIOD": 5,
"K_FACTOR": 0.85,
"SURFACE_V": 1,
"BOTTOM_Y": 0
},
"PROF": {
"CUR_DIR": 0,
"CUR_FACTOR": 1,
"GRID_DATA": [
{
"D": 0,
"V": 2
},
{
"D": 10,
"V": 2
}
]
},
"FLOOD_GRUP": [],
"GROWTH": [],
"GRID_X": 73,
"GRID_Z": 20,
"USERGRID": [
[
{
"X": 0,
"Z": 0,
"ELEV": 10.999999999999998,
"VX": 0.46611591251822093,
"VCX": 1.9999999999999998,
"VT": 2.466115912518221,
"VZ": 0,
"AX": 0,
"AZ": 0
},
{
"X": 0.5080563698912746,
"Z": 0,
"ELEV": 10.996194698091744,
"VX": 0.4643422007468476,
"VCX": 1.9999999999999998,
"VT": 2.4643422007468474,
"VZ": 0,
"AX": 0.04781033826731333,
"AZ": 0
}
],
[
{
"X": 0,
"Z": 0.6315789473684209,
"ELEV": 0,
"VX": 0.46886137836547037,
"VCX": 1.9999999999999998,
"VT": 2.46886137836547,
"VZ": 0,
"AX": 0,
"AZ": -0.059587324982965595
},
{
"X": 0.5080563698912746,
"Z": 0.6315789473684209,
"ELEV": 0,
"VX": 0.4670772192676694,
"VCX": 1.9999999999999998,
"VT": 2.467077219267669,
"VZ": 0.00441575086277806,
"AX": 0.048111030297930554,
"AZ": -0.059345050577191534
}
],
[
{
"X": 0,
"Z": 1.2631578947368418,
"ELEV": 0,
"VX": 0.47713011800289007,
"VCX": 1.9999999999999998,
"VT": 2.47713011800289,
"VZ": 0,
"AX": 0,
"AZ": -0.11973183458159217
},
{
"X": 0.5080563698912746,
"Z": 1.2631578947368418,
"ELEV": 0,
"VX": 0.47531449385436797,
"VCX": 1.9999999999999998,
"VT": 2.4753144938543676,
"VZ": 0.008883520087762302,
"AX": 0.049016648597539646,
"AZ": -0.11924443173271622
}
],
[
{
"X": 0,
"Z": 1.8947368421052626,
"ELEV": 0,
"VX": 0.491019538713367,
"VCX": 1.9999999999999998,
"VT": 2.491019538713367,
"VZ": 0,
"AX": 0,
"AZ": -0.18099043562139414
},
{
"X": 0.5080563698912746,
"Z": 1.8947368421052626,
"ELEV": 0,
"VX": 0.48915106112571083,
"VCX": 1.9999999999999998,
"VT": 2.489151061125711,
"VZ": 0.013455938823090603,
"AX": 0.050537861517275816,
"AZ": -0.18025216263367277
}
],
[
{
"X": 0,
"Z": 2.5263157894736836,
"ELEV": 0,
"VX": 0.5106932604428185,
"VCX": 1.9999999999999998,
"VT": 2.5106932604428187,
"VZ": 0,
"AX": 0,
"AZ": -0.24391915274789258
},
{
"X": 0.5080563698912746,
"Z": 2.5263157894736836,
"ELEV": 0,
"VX": 0.5087499184043227,
"VCX": 1.9999999999999998,
"VT": 2.5087499184043227,
"VZ": 0.01818687100749593,
"AX": 0.05269258922680228,
"AZ": -0.2429213126289284
}
]
],
"bSELFW": true,
"bBUOYANT": true,
"CREST": "MXM",
"UNIT": "PHASE",
"INITAL_POS": 0,
"STEP": 10,
"POS": 3
}
}
}
Specifications
No. | Description | Key | Value Type | Default | Required | |
---|---|---|---|---|---|---|
1 |
Wave Load Name |
"NAME" |
String |
- |
Required |
|
2 |
Description |
"DESC" |
String |
Blank |
Optional |
|
3 |
Use Static Load Generation |
"bSTLD" |
Boolean |
- |
- |
|
4 |
Use Time History Load Generation |
"bTHIS" |
Boolean |
- |
- |
|
5 |
Time History Load Case Name |
"NAME_THIS" |
String |
- |
- |
|
6 |
Vertical Coordinate • Global Y: "GLOBAL_Y" • Global Z: "GLOBAL_Z" |
"VERT_COORD" |
String |
- |
- |
|
7 |
Water Weight Density |
"DENSITY" |
Number |
- |
- |
|
8 |
Water Depth |
"DEPTH" |
Number |
- |
- |
|
9 |
Drag & Inertia Coefficients |
"COEF" |
Array |
- |
- |
|
(1) |
Type • Constant • Linear Interpolation |
"TYPE" |
String |
- |
- |
|
(2) |
Coefficients S Array • Insert data as object |
"COEF_S" |
Array |
- |
- |
|
i. Structural Group Name |
"GRUP" |
String |
- |
- |
||
ii. Diameter |
"DIA" |
Number |
- |
- |
||
iii. Drag Coefficient X |
"DRAG_COEF_X" |
Number |
- |
- |
||
iv. Drag Coefficient Y |
"DRAG_COEF_Y" |
Number |
- |
- |
||
v. Drag Coefficient Z |
"DRAG_COEF_Z" |
Number |
- |
- |
||
vi. Inertia Coefficient X |
"INER_COEF_X" |
Number |
- |
- |
||
vii. Inertia Coefficient Y |
"INER_COEF_Y" |
Number |
- |
- |
||
viii. Inertia Coefficient Z |
"INER_COEF_Z" |
Number |
- |
- |
||
(3) |
Coefficients R Array • Insert data as object |
"COEF_R" |
Array |
- |
- |
|
i. Structural Group Name |
"GRUP" |
String |
- |
- |
||
ii. Diameter |
"DIA" |
Number |
- |
- |
||
iii. Drag Coefficient X |
"DRAG_COEF_X" |
Number |
- |
- |
||
iv. Drag Coefficient Y |
"DRAG_COEF_Y" |
Number |
- |
- |
||
v. Drag Coefficient Z |
"DRAG_COEF_Z" |
Number |
- |
- |
||
vi. Inertia Coefficient X |
"INER_COEF_X" |
Number |
- |
- |
||
vii. Inertia Coefficient Y |
"INER_COEF_Y" |
Number |
- |
- |
||
viii. Inertia Coefficient Z |
"INER_COEF_Z" |
Number |
- |
- |
||
(4) |
Override Coefficients with Structure Group |
"bOVER" |
Boolean |
- |
- |
|
(5) |
Override Coefficients S Array • Insert data as object |
"OVER_S" |
Array |
- |
- |
|
i. Structural Group Name |
"GRUP" |
String |
- |
- |
||
ii. Diameter |
"DIA" |
Number |
- |
- |
||
iii. Drag Coefficient X |
"DRAG_COEF_X" |
Number |
- |
- |
||
iv. Drag Coefficient Y |
"DRAG_COEF_Y" |
Number |
- |
- |
||
v. Drag Coefficient Z |
"DRAG_COEF_Z" |
Number |
- |
- |
||
vi. Inertia Coefficient X |
"INER_COEF_X" |
Number |
- |
- |
||
vii. Inertia Coefficient Y |
"INER_COEF_Y" |
Number |
- |
- |
||
viii. Inertia Coefficient Z |
"INER_COEF_Z" |
Number |
- |
- |
||
(6) |
Override Coefficients R Array • Insert data as object |
"OVER_R" |
Array |
- |
- |
|
i. Structural Group Name |
"GRUP" |
String |
- |
- |
||
ii. Diameter |
"DIA" |
Number |
- |
- |
||
iii. Drag Coefficient X |
"DRAG_COEF_X" |
Number |
- |
- |
||
iv. Drag Coefficient Y |
"DRAG_COEF_Y" |
Number |
- |
- |
||
v. Drag Coefficient Z |
"DRAG_COEF_Z" |
Number |
- |
- |
||
vi. Inertia Coefficient X |
"INER_COEF_X" |
Number |
- |
- |
||
vii. Inertia Coefficient Y |
"INER_COEF_Y" |
Number |
- |
- |
||
viii. Inertia Coefficient Z |
"INER_COEF_Z" |
Number |
- |
- |
||
10 |
Wave Characteristics |
"CHAR" |
Object |
- |
- |
|
(1) |
Theory Type |
"THEORY" |
String |
- |
- |
|
(2) |
Function Order |
"FUNC" |
Integer |
- |
- |
|
(3) |
Wave Direction |
"DIR" |
Number |
- |
- |
|
(4) |
Wave Height |
"HEIGHT" |
Number |
- |
- |
|
(5) |
Wave Length / Wave Period |
"CHAR_TYPE" |
String |
- |
- |
|
(6) |
Length |
"LENGTH" |
Number |
- |
- |
|
(7) |
Period |
"PERIOD" |
Number |
- |
- |
|
(8) |
Kinematics Factor |
"K_FACTOR" |
Number |
- |
- |
|
(9) |
Current Surface Velocity |
"SURFACE_V" |
Number |
- |
- |
|
(10) |
Current Bottom Velocity |
"BOTTOM_Y" |
Number |
- |
- |
|
11 |
Current Profile |
"PROF" |
Object |
- |
- |
|
(1) |
Current Direction |
"CUR_DIR" |
Number |
- |
- |
|
(2) |
Current Blockage Factor |
"CUR_FACTOR" |
Number |
- |
- |
|
(3) |
Grid Data • Insert data as object |
"GRID_DATA" |
Array |
- |
- |
|
i. Elevation |
"D" |
Number |
- |
- |
||
ii. Velocity |
"V" |
Number |
- |
- |
||
12 |
Flood Condition |
"FLOOD_GRUP" |
Array |
- |
- |
|
13 |
Marine Growth • Insert data as object |
"GROWTH" |
Array |
- |
- |
|
(1) |
Elevation |
"Z" |
Number |
- |
- |
|
(2) |
Velocity |
"T" |
Number |
- |
- |
|
14 |
Grid X Size |
"GRID_X" |
Integer |
- |
- |
|
15 |
Grid Y Size |
"GRID_Z" |
Integer |
- |
- |
|
16 |
User Defined Grid Data • Insert data as object • Row[Column[Data]] |
"USERGRID" |
Array |
- |
- |
|
(1) |
Horizontal Axis |
"X" |
Number |
- |
- |
|
(2) |
Vertical Axis |
"Z" |
Number |
- |
- |
|
(3) |
Elevation |
"ELEV" |
Number |
- |
- |
|
(4) |
Horizontal Velocity |
"VX" |
Number |
- |
- |
|
(5) |
Current Horizontal Velocity |
"VCX" |
Number |
- |
- |
|
(6) |
Total Horizontal Velocity (VC + VCX) |
"VT" |
Number |
- |
- |
|
(7) |
Vertical Velocity |
"VZ" |
Number |
- |
- |
|
(8) |
Horizontal Acceleration |
"AX" |
Number |
- |
- |
|
(9) |
Vertical Acceleration |
"AZ" |
Number |
- |
- |
|
17 |
Use Self Weight |
"bSELFW" |
Boolean |
- |
- |
|
18 |
Use Buoyancy Load |
"bBUOYANT" |
Boolean |
- |
- |
|
19 |
Crest Critical Position |
"CREST" |
String |
- |
- |
|
20 |
Crest Position Unit |
"UNIT" |
String |
- |
- |
|
21 |
Initial Position |
"INITAL_POS" |
Number |
- |
- |
|
22 |
Increase Step |
"STEP" |
Number |
- |
- |
|
23 |
Number of Positions |
"POS" |
Integer |
- |
- |