Skip to content

Commit 3005af7

Browse files
BrodiePearsonBrodiePearson
authored
Update calculate_structure_function_3d.py
Homogenizing names across calculate and generate functions
1 parent a5b0e36 commit 3005af7

File tree

1 file changed

+40
-25
lines changed

1 file changed

+40
-25
lines changed

‎src/fluidsf/calculate_structure_function_3d.py

Lines changed: 40 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ def calculate_structure_function_3d( # noqa: D417, C901
1919
boundary="periodic-all",
2020
):
2121
"""
22-
Calculate structure function, either advective or traditional.
22+
Calculate structure functions, including advective structure functions.
2323
Supports velocity-based structure functions and scalar-based structure functions.
2424
2525
Parameters
@@ -64,59 +64,74 @@ def calculate_structure_function_3d( # noqa: D417, C901
6464
The returned dictionary may contain the following keys, with some keys
6565
removed if the structure function is not calculated:
6666
67-
**SF_velocity_x**: The velocity-based advective structure function in the
67+
**SF_velocity_x**: The advective velocity structure function in the
6868
x direction.
6969
70-
**SF_velocity_y**: The velocity-based advective structure function in the
70+
**SF_velocity_y**: The advective velocity structure function in the
7171
y direction.
7272
73-
**SF_velocity_z**: The velocity-based advective structure function in the
73+
**SF_velocity_z**: The advective velocity structure function in the
7474
z direction.
7575
76-
**SF_scalar_x**: The scalar-based advective structure function in the x
76+
**SF_scalar_x**: The advective scalar structure function in the x
7777
direction.
7878
79-
**SF_scalar_y**: The scalar-based advective structure function in the y
79+
**SF_scalar_y**: The advective scalar structure function in the y
8080
direction.
8181
82-
**SF_scalar_z**: The scalar-based advective structure function in the z
82+
**SF_scalar_z**: The advective scalar structure function in the z
8383
direction.
8484
85-
**SF_LL_x**: The traditional structure function LL in the x direction.
85+
**SF_LL_x**: The second-order longitudinal velocity structure function
86+
in the x direction.
8687
87-
**SF_LL_y**: The traditional structure function LL in the y direction.
88+
**SF_LL_y**: The second-order longitudinal velocity structure function
89+
in the y direction.
8890
89-
**SF_LL_z**: The traditional structure function LL in the z direction.
91+
**SF_LL_z**: The second-order longitudinal velocity structure function
92+
in the z direction.
9093
91-
**SF_TT_x**: The traditional structure function TT in the x direction.
94+
**SF_TT_x**: The second-order transverse velocity structure function
95+
in the x direction.
9296
93-
**SF_TT_y**: The traditional structure function TT in the y direction.
97+
**SF_TT_y**: The second-order transverse velocity structure function
98+
in the y direction.
9499
95-
**SF_TT_z**: The traditional structure function TT in the z direction.
100+
**SF_TT_z**: The second-order transverse velocity structure function
101+
in the z direction.
96102
97-
**SF_SS_x**: The traditional structure function SS in the x direction.
103+
**SF_SS_x**: The second-order scalar structure function in the x direction.
98104
99-
**SF_SS_y**: The traditional structure function SS in the y direction.
105+
**SF_SS_y**: The second-order scalar structure function in the y direction.
100106
101-
**SF_SS_z**: The traditional structure function SS in the z direction.
107+
**SF_SS_z**: The second-order scalar structure function in the z direction.
102108
103-
**SF_LLL_x**: The traditional structure function LLL in the x direction.
109+
**SF_LLL_x**: The third-order longitudinal velocity structure function
110+
in the x direction.
104111
105-
**SF_LLL_y**: The traditional structure function LLL in the y direction.
112+
**SF_LLL_y**: The third-order longitudinal velocity structure function
113+
in the y direction.
106114
107-
**SF_LLL_z**: The traditional structure function LLL in the z direction.
115+
**SF_LLL_z**: The third-order longitudinal velocity structure function
116+
in the z direction.
108117
109-
**SF_LTT_x**: The traditional structure function LTT in the x direction.
118+
**SF_LTT_x**: The third-order longitudinal-transverse-transverse velocity
119+
structure function in the x direction.
110120
111-
**SF_LTT_y**: The traditional structure function LTT in the y direction.
121+
**SF_LTT_y**: The third-order longitudinal-transverse-transverse velocity
122+
structure function in the y direction.
112123
113-
**SF_LTT_z**: The traditional structure function LTT in the z direction.
124+
**SF_LTT_z**: The third-order longitudinal-transverse-transverse velocity
125+
structure function in the z direction.
114126
115-
**SF_LSS_x**: The traditional structure function LSS in the x direction.
127+
**SF_LSS_x**: The third-order longitudinal-scalar-scalar structure function
128+
in the x direction.
116129
117-
**SF_LSS_y**: The traditional structure function LSS in the y direction.
130+
**SF_LSS_y**: The third-order longitudinal-scalar-scalar structure function
131+
in the y direction.
118132
119-
**SF_LSS_z**: The traditional structure function LSS in the z direction.
133+
**SF_LSS_z**: The third-order longitudinal-scalar-scalar structure function
134+
in the z direction.
120135
"""
121136
inputs = {
122137
"u": u,

0 commit comments

Comments
 (0)