Plot.1dCommand: Difference between revisions

From Flooxs
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
= Plot.1d =
= Plot1d =


plot.1d - plot a one dimensional cross section
plot1d - plot a one-dimensional line through the simulation solid


== Synposis ==
== Synposis ==
Line 7: Line 7:
=== plot.1d ===
=== plot.1d ===


  [ x=<n> ][ y=<n> ][ z=<n> ]
  [ graph=<c> ]
  [ boundary ] [ clear ]
[ xlab==<c>] [ylab==<c>] [title==<c>]
  [ max=<numeric list> ] [ min=<numeric list> ]
[ xvalue=<n> ][ yvalue=<n> ][ zvalue=<n> ]
[ color = <s> ] [ symb = <s> ]
  [ clear ] [add ]
[ label=<s> ] [ log ] [ ylab =<s>]
  [ penstyle=<c> ]
[ xmax=<n> ] [ xmin=<n> ] [ ymax=<n> ] [ ymin=<n> ]
[ log ]
[ name=<c> ]
[ leg.left | leg.center | leg.right ]
[ leg.top | leg.middle | leg.bottom ]


== Description ==
== Description ==


The plot.1d statement allows the user to plot cross sections vertically or horizontally through the device. The statement has options to provide for initialization of the graphics device and plotting of axis. The statement can optionally draw vertical lines whenever a material boundary is crossed.
The plot1d statement allows the user to plot a cross-sectional line vertically, horizontally, or front to back through the device. The statement has options for the plotting of axes.


; x, y, z
; graph
: These parameters specifies the constant values of a line to perform sectioning along in microns. In one dimension, these parameters are not necessary. In two dimensions, only one of x or y can be specified for a given device. Specifying x will produce a horizontal slice through the device and y will specify a vertical slice. An easy way to remember is that the cross section is taken at the constant value specified. For a three dimensional simulation, two of these three must be specified.
: This string allows the graph to be named. Any graphs using the same name will be plotted on the same [[WindowCommand|window]] pane.  This enables multiples lies to put on the same plot surface.
; boundary
; xlab
: This parameter specifies that any material boundaries that are crossed should be drawn in as vertical lines on the plot. It defaults false.
: Change the default horizontal axis label
; ylab
Change the default vertical axis label
; title
: Change the title on the graph
; xvalue, yvalue, zvalue
: These parameters specify the constant values of a line to perform sectioning along in microns. In one dimension, these parameters are not necessary. In two dimensions, only one of x or y can be specified for a given device. Specifying x will produce a horizontal slice through the device and y will specify a vertical slice. An easy way to remember is that the cross-section is taken at the constant value specified. For a three dimensional simulation, two of these three must be specified.
; clear
; clear
: The clear parameter specifies whether the graphics screen should be cleared before the the graph is drawn. If true, the screen is cleared. It defaults true.
: The clear parameter specifies whether the graphics screen should be cleared before the graph is drawn. If true, the screen is cleared. It defaults false.
; max
; add
: This command takes a list of numeric values which will be the ends of the x and y axis, respectively. The first argument is x and the second is the y value. A single value will always be interperted as the x value. The default is the maximum extent of the current structure.
: Add a new line to the plot and break from the previous line.
; min
; xmin, max
: This command takes a list of numeric values which will be the ends of the x and y axis, respectively. The first argument is x and the second is the y value. A single value will always be interperted as the x value. The default is the minimum extent of the current structure.
: These parameters allow the user to specify the limits of the x-axis of the plot.
; color
; ymin, ymax
: This parameter specifies the line color for the plot. It can be any color supported by the X11 hardware and named in the color data base.
: These parameters allow the user to specify the limits of the y-axis of the plot.
; symb
; penstyle
: This parameter allows the user to specify a symbol type to be drawn on the cross sectional line. Each point is drawn with the specified symbol. Symb=0 means no symbol should be drawn. It defaults to no symbol. Whatever character is entered is placed at each data point on the plot.
: This parameter specifies the pen-type for the plot. Pens can be defined to have width, color, and a symbol using the [[PenCommand|pen command]].
; label
; log
: Specify that we want the plot to be semi-log.
; name
: This parameter allows the user to specify the name of the line in the legend box of the plot window. The default is the name of the current data set.
: This parameter allows the user to specify the name of the line in the legend box of the plot window. The default is the name of the current data set.
; log
; leg.left | leg.center | leg.right
: Specify that we want the plot to have a log scale axis
: These boolean parameters allow the user to specify the horizontal position of the legend.
; ylab
; leg.top | leg.middle | leg.bottom
: Change the default vertical axis label
: These boolean parameters allow the user to specify the vertical position of the legend.


== Examples ==
== Examples ==


  plot.1d x.v=1.0 symb=1 clear
  plot1d graph=p1d xv=1.0


This command will clear the screen, draw a set of axes, and draw the data along a horizontal cross section at x=1.0 um. Each point will be drawn with symbol 1. <tt></tt>
This command will clear the pane named p1d or create it if it doesn't exist, draw a set of axes, and draw the data along a horizontal cross-section at x=1.0 um.  


  plot.1d x.v=2.0 clear=f lab = Lateral
  plot1d xv=2.0 clear=f lab = Lateral


This command draws a horizontal cross section at x=2.0 um on the previous set of axis. The line is labeled Lateral in the legend.
This command draws a horizontal cross-section at x=2.0 um on the previous set of axis. The line is labeled Lateral in the legend.


== Bugs and Missing Features ==
sel z=Econd
plot1d graph=Bands name=Econd
sel z=Eval
plot1d graph=Bands name=Eval
sel z=Qfn
plot1d graph=Bands name=Qfn
sel z=Qfp
plot1d graph=Bands name=Qfp


Use of this command and the [interface.html interface], [interp.html interpolate], and [BLTplot.html blt window commands] commands provides a fairly complete way to examine data in one dimension.
This set of commands will draw the conduction band, valence band, and electron and hole quasi-Fermi levels for a one-dimensional simulation.


== See Also ==
== See Also ==


[[SliceCommand]], [[SelectCommand]]
[[SelectCommand]] [[PenCommand]] [[WindowCommand]]

Revision as of 15:13, 16 June 2020

Plot1d

plot1d - plot a one-dimensional line through the simulation solid

Synposis

plot.1d

[ graph=<c> ]
[ xlab==<c>] [ylab==<c>] [title==<c>]
[ xvalue=<n> ][ yvalue=<n> ][ zvalue=<n> ]
[ clear ] [add ]
[ penstyle=<c> ]
[ xmax=<n> ] [ xmin=<n> ] [ ymax=<n> ] [ ymin=<n> ]
[ log ]
[ name=<c> ]
[ leg.left | leg.center | leg.right ]
[ leg.top | leg.middle | leg.bottom ]

Description

The plot1d statement allows the user to plot a cross-sectional line vertically, horizontally, or front to back through the device. The statement has options for the plotting of axes.

graph
This string allows the graph to be named. Any graphs using the same name will be plotted on the same window pane. This enables multiples lies to put on the same plot surface.
xlab
Change the default horizontal axis label
ylab

Change the default vertical axis label

title
Change the title on the graph
xvalue, yvalue, zvalue
These parameters specify the constant values of a line to perform sectioning along in microns. In one dimension, these parameters are not necessary. In two dimensions, only one of x or y can be specified for a given device. Specifying x will produce a horizontal slice through the device and y will specify a vertical slice. An easy way to remember is that the cross-section is taken at the constant value specified. For a three dimensional simulation, two of these three must be specified.
clear
The clear parameter specifies whether the graphics screen should be cleared before the graph is drawn. If true, the screen is cleared. It defaults false.
add
Add a new line to the plot and break from the previous line.
xmin, max
These parameters allow the user to specify the limits of the x-axis of the plot.
ymin, ymax
These parameters allow the user to specify the limits of the y-axis of the plot.
penstyle
This parameter specifies the pen-type for the plot. Pens can be defined to have width, color, and a symbol using the pen command.
log
Specify that we want the plot to be semi-log.
name
This parameter allows the user to specify the name of the line in the legend box of the plot window. The default is the name of the current data set.
leg.left | leg.center | leg.right
These boolean parameters allow the user to specify the horizontal position of the legend.
leg.top | leg.middle | leg.bottom
These boolean parameters allow the user to specify the vertical position of the legend.

Examples

plot1d graph=p1d xv=1.0

This command will clear the pane named p1d or create it if it doesn't exist, draw a set of axes, and draw the data along a horizontal cross-section at x=1.0 um.

plot1d xv=2.0 clear=f lab = Lateral

This command draws a horizontal cross-section at x=2.0 um on the previous set of axis. The line is labeled Lateral in the legend.

sel z=Econd
plot1d graph=Bands name=Econd
sel z=Eval
plot1d graph=Bands name=Eval
sel z=Qfn
plot1d graph=Bands name=Qfn
sel z=Qfp
plot1d graph=Bands name=Qfp

This set of commands will draw the conduction band, valence band, and electron and hole quasi-Fermi levels for a one-dimensional simulation.

See Also

SelectCommand PenCommand WindowCommand