3.7.8.4.7. Sweep Plots of Coefficients

The "SweepCoeff" class of subfigure is used to plot one or more force or moment coefficients (or other database coefficient) for a sweep of cases. For example, it can be used to plot normal force coefficient versus Mach number for cases having the same angle of attack and sideslip angle. If the sweep including this subfigure have CarpetEqCons or CarpetTolCons specified, the plots on each page (i.e. for each sweep) will be divided into multiple lines as divided by the carpet constraints.

S: dict

Dictionary of settings for SweepCoeff subfigure

Type: {"PlotCoeff"} | str

Subfigure type

Header: {""} | str

Heading placed above subfigure (bold, italic)

Position: "t" | "c" | {"b"}

Vertical alignment of subfigure

Alignment: "left" | {"center"}

Horizontal alignment

Width: {0.5} | float

Width of subfigure as a fraction of page text width

FigWidth: {6.0} | float

Width of figure internally to Python; affects aspect ratio of figure and font size when integrated into report; decrease this parameter to make text appear larger in report

FigHeight: {4.5} | float

Similar to FigWidth and primarily used to set aspect ratio

Component: {"entire"} | str | list

Component or list of components to plot, must be name(s) of components defined in Config.xml

Coefficient: "CA" | "CY" | {"CN"} | "CLL" | "CLM" | "CLN" | list

Force or moment coefficient(s) to plot, any database value

StandardDeviation: {0.0} | float

If nonzero, plot the value StandardDeviation above and below the mean value at each point

MinMax: true | {false}

Whether or not to plot minimum and maximum value over iterative history

Format: {"pdf"} | "svg" | "png" | str

Format of graphic file to save

DPI: {150} | int

Resolution (dots per inch) if saved as a raster format

LineOptions: {{"color": "k", "marker": ["^","s","o"]}} | dict

Plot options for the plot value; options are passed to matplotlib.pyplot.plot(), and lists are cycled through, so the default plots the first line with a "^" marker, etc.

TargetOptions: {{"color": "r", "marker": ["^","s","o"]}} | dict

Plot options for target value plot if the data book contains a target for the current component and coefficient

MinMaxOptions: {{"facecolor":"g", "alpha":0.4, "lw":0}} | dict

Options for plot of min/max value over iterative window, passed to matplotlib.pyplot.fill_between()

StDevOptions: {{"facecolor":"b", "alpha":0.35, "lw":0}} | dict

Plot options for standard deviation plots; options are passed to matplotlib.pyplot.fill_between()

PlotTypeMinMax: {"FillBetween"} | "ErrorBar"

Method for plotting range of values for min/max values

PlotTypeUncertainty: "FillBetween" | {"ErrorBar"}

Method for plotting range of values for sampling error

PlotTypeStDev: {"FillBetween"} | "ErrorBar"

Method for plotting range of values for standard deviation plot

ShowMu: {True} | False

Prints value of mean value in upper right corner of plot

ShowSigma: True | {False}

Prints value of standard deviation in upper left corner

ShowDelta: True | {False}

Prints value of fixed width in upper right corner

MuFormat: {"%.4f"} | str

Format flag for value of mean printed via ShowMu

SigmaFormat: {"%.4f"} | str

Format flag for value of mean printed via ShowSigma

DeltaFormat: {"%.4f"} | str

Format flag for value of mean printed via ShowDelta