Structure for the Vortex Lattice Surface tuple = ("Name of Surface", "Value"). "Name of surface defines the name of the surface in which the data should be applied.
The "Value" can either be a JSON String dictionary (see Section JSON String Dictionary) or a single string keyword string (see Section Single Value String).
JSON String Dictionary
If "Value" is a JSON string dictionary (eg. "Value" = {"numChord": 5, "spaceChord": 1.0, "numSpan": 10, "spaceSpan": 0.5}) the following keywords ( = default values) may be used:
-
groupName = "(no default)"
Single or list of capsGroup names used to define the surface (e.g. "Name1" or ["Name1","Name2",...]. If no groupName variable is provided an attempted will be made to use the tuple name instead;
-
noKeyword = "(no default)"
"No" type. Options: NOWAKE, NOALBE, NOLOAD.
-
numChord = 10
The number of chordwise horseshoe vortices placed on the surface.
-
spaceChord = 0.0
The chordwise vortex spacing parameter.
-
numSpanTotal = 0
Total number of spanwise horseshoe vortices placed on the surface. The vorticies are 'evenly' distributed across sections to minimize jumps in spacings. numpSpanPerSection must be zero if this is set.
-
numSpanPerSection = 0
The number of spanwise horseshoe vortices placed on each section the surface. The total number of spanwise vorticies are (numSection-1)*numSpanPerSection. The vorticies are 'evenly' distributed across sections to minimize jumps in spacings. numSpanTotal must be zero if this is set.
-
spaceSpan = 0.0
The spanwise vortex spacing parameter.
-
yMirror = False
Mirror surface about the y-direction.
Single Value String
If "Value" is a single string the following options maybe used: