Skip to content

Commit 52ef256

Browse files
Update calculate_structure_function_2d.py
1 parent a0bd664 commit 52ef256

File tree

1 file changed

+29
-17
lines changed

1 file changed

+29
-17
lines changed

src/fluidsf/calculate_structure_function_2d.py

Lines changed: 29 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ def calculate_structure_function_2d( # noqa: D417, C901
1616
boundary="periodic-all",
1717
):
1818
"""
19-
Calculate structure function, either advective or traditional.
19+
Calculate structure functions, including advective structure functions.
2020
Supports velocity-based structure functions and scalar-based structure functions.
2121
2222
Parameters
@@ -55,41 +55,53 @@ def calculate_structure_function_2d( # noqa: D417, C901
5555
The returned dictionary may contain the following keys, with some keys
5656
removed if the structure function is not calculated:
5757
58-
**SF_advection_velocity_x**: The advection velocity structure function
58+
**SF_advection_velocity_x**: The advective velocity structure function
5959
in the x direction.
6060
61-
**SF_advection_velocity_y**: The advection velocity structure function
61+
**SF_advection_velocity_y**: The advective velocity structure function
6262
in the y direction.
6363
64-
**SF_advection_scalar_x**: The scalar structure function in the x
64+
**SF_advection_scalar_x**: The advective scalar structure function in the x
6565
direction.
6666
67-
**SF_advection_scalar_y**: The scalar structure function in the y
67+
**SF_advection_scalar_y**: The advective scalar structure function in the y
6868
direction.
6969
70-
**SF_LL_x**: The traditional structure function LL in the x direction.
70+
**SF_LL_x**: The second-order longitudinal velocity structure function
71+
in the x direction.
7172
72-
**SF_LL_y**: The traditional structure function LL in the y direction.
73+
**SF_LL_y**: The second-order longitudinal velocity structure function
74+
in the y direction.
7375
74-
**SF_TT_x**: The traditional structure function TT in the x direction.
76+
**SF_TT_x**: The second-order transverse velocity structure function
77+
in the x direction.
7578
76-
**SF_TT_y**: The traditional structure function TT in the y direction.
79+
**SF_TT_y**: The second-order transverse velocity structure function
80+
in the y direction.
7781
78-
**SF_SS_x**: The traditional structure function SS in the x direction.
82+
**SF_SS_x**: The second-order scalar structure function
83+
in the x direction.
7984
80-
**SF_SS_y**: The traditional structure function SS in the y direction.
85+
**SF_SS_y**: The second-order scalar velocity structure function
86+
in the y direction.
8187
82-
**SF_LLL_x**: The traditional structure function LLL in the x direction.
88+
**SF_LLL_x**: The third-order longitudinal velocity structure function
89+
in the x direction.
8390
84-
**SF_LLL_y**: The traditional structure function LLL in the y direction.
91+
**SF_LLL_y**: The third-order longitudinal velocity structure function
92+
in the y direction.
8593
86-
**SF_LTT_x**: The traditional structure function LTT in the x direction.
94+
**SF_LTT_x**: The third-order longitudinal velocity structure function
95+
in the x direction.
8796
88-
**SF_LTT_y**: The traditional structure function LTT in the y direction.
97+
**SF_LTT_y**: The third-order longitudinal-transverse-transverse velocity
98+
structure function in the y direction.
8999
90-
**SF_LSS_x**: The traditional structure function LSS in the x direction.
100+
**SF_LSS_x**: The third-order longitudinal-scalar-scalar structure function
101+
in the x direction.
91102
92-
**SF_LSS_y**: The traditional structure function LSS in the y direction.
103+
**SF_LSS_y**: The third-order longitudinal-scalar-scalar structure function
104+
in the y direction.
93105
"""
94106
inputs = {
95107
"u": u,

0 commit comments

Comments
 (0)