2222
2323
2424class Ocean :
25- def ocdata (self , val1 = "" , val2 = "" , val3 = "" , val14 = "" , ** kwargs ):
25+ def ocdata (
26+ self ,
27+ val1 : str = "" ,
28+ val2 : str = "" ,
29+ val3 : str = "" ,
30+ val4 : str = "" ,
31+ val5 : str = "" ,
32+ val6 : str = "" ,
33+ val7 : str = "" ,
34+ val8 : str = "" ,
35+ val9 : str = "" ,
36+ val10 : str = "" ,
37+ val11 : str = "" ,
38+ val12 : str = "" ,
39+ val13 : str = "" ,
40+ val14 : str = "" ,
41+ ** kwargs ,
42+ ):
2643 """Defines an ocean load using non-table data.
2744
28- APDL Command: OCDATA
45+ APDL Command: `` OCDATA``
2946
3047 Parameters
3148 ----------
@@ -34,14 +51,14 @@ def ocdata(self, val1="", val2="", val3="", val14="", **kwargs):
3451
3552 Notes
3653 -----
37- The OCDATA command specifies non-table data that defines the ocean
54+ The `` OCDATA`` command specifies non-table data that defines the ocean
3855 load, such as the depth of the ocean to the mud line, the ratio of
3956 added mass over added mass for a circular cross section, or the wave
4057 type to apply. The terms VAL1, VAL2, etc. are specialized according to
4158 the input set required for the given ocean load.
4259
43- The program interprets the data input via the OCDATA command within the
44- context of the most recently issued OCTYPE command.
60+ The program interprets the data input via the `` OCDATA`` command within the
61+ context of the most recently issued `` OCTYPE`` command.
4562
4663 Input values in the order indicated.
4764
@@ -52,19 +69,19 @@ def ocdata(self, val1="", val2="", val3="", val14="", **kwargs):
5269 For a better understanding of how to set up a basic ocean type, see
5370 Figure: 5:: Basic Ocean Data Type Components .
5471
55- DEPTH -- The depth of the ocean (that is, the distance between the mean
72+ `` DEPTH`` -- The depth of the ocean (that is, the distance between the mean
5673 sea level and the mud line). The water surface is assumed to be level
5774 in the XY plane, with Z being positive upwards. This value is required
5875 and must be positive.
5976
60- MATOC -- The material number of the ocean. This value is required and
77+ `` MATOC`` -- The material number of the ocean. This value is required and
6178 is used to input the required density. It is also used to input the
62- viscosity if the Reynolds number is used (OCTABLE).
79+ viscosity if the Reynolds number is used (`` OCTABLE`` ).
6380
64- KFLOOD -- The inside-outside fluid-interaction key:
81+ `` KFLOOD`` -- The inside-outside fluid-interaction key:
6582
66- For beam subtype CTUBE and HREC used with BEAM188 or BEAM189 and ocean
67- loading, KFLOOD is always set to 1.
83+ For beam subtype `` CTUBE`` and `` HREC`` used with BEAM188 or BEAM189 and ocean
84+ loading, `` KFLOOD`` is always set to 1.
6885
6986 Cay -- The ratio of added mass of the external fluid over the mass of
7087 the fluid displaced by the element cross section in the y direction
@@ -73,7 +90,7 @@ def ocdata(self, val1="", val2="", val3="", val14="", **kwargs):
7390 element moves in the element y direction during a dynamic analysis.
7491
7592 If no value is specified, and the coefficient of inertia CMy is not
76- specified (OCTABLE), both values default to 0.0.
93+ specified (`` OCTABLE`` ), both values default to 0.0.
7794
7895 If no value is specified, but CMy is specified, this value defaults to
7996 Cay = CMy - 1.0.
@@ -90,7 +107,7 @@ def ocdata(self, val1="", val2="", val3="", val14="", **kwargs):
90107 Cay.
91108
92109 If no value is specified, and the coefficient of inertia CMz is not
93- specified (OCTABLE), both values default to 0.0.
110+ specified (`` OCTABLE`` ), both values default to 0.0.
94111
95112 If no value is specified, but CMz is specified, this value defaults to
96113 Cay = CMz - 1.0.
@@ -115,31 +132,31 @@ def ocdata(self, val1="", val2="", val3="", val14="", **kwargs):
115132
116133 Two example cases for Zmsl are:
117134
118- A structure with its origin on the sea floor (Zmsl = DEPTH).
135+ A structure with its origin on the sea floor (Zmsl = `` DEPTH`` ).
119136
120- A tidal change (tc) above the mean sea level (Zmsl = tc, and DEPTH
121- becomes DEPTH + tc)
137+ A tidal change (tc) above the mean sea level (Zmsl = tc, and `` DEPTH``
138+ becomes `` DEPTH`` + tc)
122139
123- Ktable -- The dependency of VAL1 on the OCTABLE command:
140+ Ktable -- The dependency of VAL1 on the `` OCTABLE`` command:
124141
125- KWAVE -- The incident wave type:
142+ `` KWAVE`` -- The incident wave type:
126143
127- THETA -- Angle of the wave direction θ from the global Cartesian X axis
144+ `` THETA`` -- Angle of the wave direction θ from the global Cartesian X axis
128145 toward the global Cartesian Y axis (in degrees).
129146
130- WAVELOC (valid when KWAVE = 0 through 3, and 101+) -- The wave location
147+ `` WAVELOC`` (valid when `` KWAVE`` = 0 through 3, and 101+) -- The wave location
131148 type:
132149
133- SPECTRUM (valid when KWAVE = 5 through 7) -- The wave spectrum type:
150+ `` SPECTRUM`` (valid when `` KWAVE`` = 5 through 7) -- The wave spectrum type:
134151
135- KCRC -- The wave-current interaction key.
152+ `` KCRC`` -- The wave-current interaction key.
136153
137- Adjustments to the current profile are available via the KCRC constant
154+ Adjustments to the current profile are available via the `` KCRC`` constant
138155 of the water motion table. Typically, these options are used only when
139156 the wave amplitude is large relative to the water depth, such that
140157 significant wave-current interaction exists.
141158 """
142- command = f"OCDATA,{ val1 } { val2 } { val3 } { val14 }
159+ command = f"OCDATA,{ val1 } { val2 } { val3 } { val4 } , { val5 } , { val6 } , { val7 } , { val8 } , { val9 } , { val10 } , { val11 } , { val12 } , { val13 } , { val14 }
143160 return self .run (command , ** kwargs )
144161
145162 def ocdelete (self , datatype = "" , zonename = "" , ** kwargs ):
0 commit comments