Plot.2dCommand: Difference between revisions

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


plot.2d - plot a two dimensional xy picture
plot2d - plot a two-dimensional XY picture


== Synopsis ==
== Synopsis ==
Line 7: Line 7:
=== plot.2d ===
=== plot.2d ===


   
  [ graph = <c> ]
  [ (x = <n>) | (y = <n>) | (z = <n>) ]
[ clear ]
  [ max=<numeric list> ] [ min=<numeric list> ]
[ xlab==<c>] [ylab==<c>] [title==<c>]
[ clear ] [ fill ] [ Gas ]
  [ (xvalue = <n>) | (yvalue = <n>) | (zvalue = <n>) ]
[ boundary ] [ col.bound = <s> ]
  [ xmax=<n> ] [ xmin=<n> ] [ ymax=<n> ] [ ymin=<n> ]
  [ grid ] [ col.grid=<s> ]
  [ bound ] [ grid ] [ mater ] [ colors ]
  [ vector = <c> ] [ vleng=<n> ] [ vmax=<n> ]
[ contact ] [ pen = <c> ]
   
  [ lines = <i> ] [ levels = <i> ] [ colorbar ] [units = <c> ][ labels ]
[ aspect ]  


== Description ==
== Description ==


The plot.2d statement allows the user to prepare a two dimensional xy plot. This command is usually used to look at material boundaries and grids, however, it can also be used to plot a flow field. Generally, this command is dne immediately before a [contour.html contour] command so that the isoconcentration lines are plotted in context with the structure. This command while return an error for a one-dimensional simulation.
The plot.2d statement allows the user to prepare a two-dimensional XY plot. This command is usually used to look at material boundaries and grids, however, it can also be used to plot contours of a selected variable.  


; x, y, z
; graph
: For a two-dimensional simulation, these parameters are unnecessary. In three-dimensions, one of these three must be specified to indicate the cut line through the structure.
: 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.
; max
; xlab
: 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.
: Change the default horizontal axis label
; min
; ylab
: 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.
Change the default vertical axis label
; title
: Change the title on the graph
; xvalue, yvalue, zvalue
: These parameters specify the constant values of a plane to perform sectioning along in microns. In two dimensions, these parameters are not necessary. In three dimensions, only one of xvalue, yvalue, or zvalue can be specified for a given device. Specifying xvalue will produce a horizontal slice through the device and yvalue will specify a vertical slice. An easy way to remember is that the cross-section is taken at the constant value 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 to 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.
; fill
; xmin, max
: The fill parameter specifies that the device should be drawn with the proper aspect ratio. If fill is false, the device will be drawn with the proper aspect ratio. When true, the device will be expanded to fill the screen. It defaults to false.
: These parameters allow the user to specify the limits of the x-axis of the plot.
; gas
; ymin, ymax
: This parameter specifies that the grid in the gas should also be plotted. It defaults false, so no gas grid is shown.
: These parameters allow the user to specify the limits of the y-axis of the plot.
; boundary
; boundary
: This parameter specifies that the device outline and material interfaces should be drawn. It defaults to false.
: This parameter specifies that the device outline and material interfaces should be drawn. It defaults to false.
; col.bound
: Use this color to draw the boundary in. Any legal x11 color may be specified.
; grid
; grid
: The grid parameter specifies that the numerical grid the problem was solved on should be drawn. It defaults to false.
: The grid parameter specifies that the numerical grid the problem was solved on should be drawn. It defaults to false.
; col.grid
; mater, color
: Use this color to draw the grid in. Any legal x11 color may be specified.
: Color the specified material the value of the color.
; vector
; aspect
: The vector parameter takes a vector field name as an argument. This indcates arrows proportional to the size of the vector and in the direction of the vector at each node. This option does not yet work for three-dimensional simulations.
: The aspect parameter specifies that the device should be drawn with the proper aspect ratio of the size of the slice. If aspect is true, the device will be drawn with the proper aspect ratio. When false, the device will be expanded to fill the screen. It defaults to true.
; vleng
; contact, pen
: The length of the vectors is scaled so that the maximum vector has length vleng, specified in microns. The default is 0.1um.
: Draw the contact on the plot with the specified [[PenCommand|pen type]].
; vmax
; levels, line, colorbar, units, labels
: Use this as the maximum velocity instead of searching for it.
: These parameters control color contours of the [[SelectCommand|selected]] plot variable. Levels control the number of shades employed between blue and red.  Lines will draw black isobar lines on the plot.  These can be used together or separately.  Colorbar will add a labeled color bar to the right of the plot and units controls the legend written underneath the color bar.  Labels will add a numeric value to the lines drawn.


== Examples ==
== Examples ==


  plot.2d grid   
  plot2d grid  graph=p2d


This command will draw the triangular grid and axis. Each material will plotted in a different color.
This command will draw the grid and axis. Each material will be plotted in a different color.


  plot.2d bound min ={2 5}
  plot2d bound xmin = 2 ymin = 5 graph=p2d


This command will draw the material interfaces with the maximum x and y values of 2.0 and 5.0 um.
This command will draw the material interfaces with the maximum x and y values of 2.0 and 5.0 um.


  plot.2d bound
  plot2d bound graph=p2d


This command will draw the material interfaces and place symbols at each coordinate in the mesh.
This command will draw the material interfaces and place symbols at each coordinate in the mesh.


  plot.2d contact=Gate
  plot2d contact=Gate graph = p2d pen=G


This command will draw the contact interfaces and place symbols at each coordinate in the mesh.
This command will draw the contact interface for the Gate using pen style G.


  plot.2d vector=Velocity vlen=0.1 !clear
  plot.2d levels = 100 colorbar graph = p2d


This command will plot the Velocity vector field. The maximum arrow drawn will have length of 0.1um. The plot surface will not be cleared.
This command will provide a color plot with color bar on the graph p2d.
 
== Bugs and Missing Features ==
 
None.


= See Also =
= See Also =


[[boundCommand]], [[sliceCommand]], [[contourCommand]], [[selectCommand]]
[[selectCommand]] [[penCommand|pen]]

Revision as of 21:23, 17 June 2020

Plot2d

plot2d - plot a two-dimensional XY picture

Synopsis

plot.2d

[ graph = <c> ] 
[ clear ] 
[ xlab==<c>] [ylab==<c>] [title==<c>]
[ (xvalue = <n>) | (yvalue = <n>) | (zvalue = <n>) ]
[ xmax=<n> ] [ xmin=<n> ] [ ymax=<n> ] [ ymin=<n> ]
[ bound ] [ grid ] [ mater ] [ colors ]
[ contact ] [ pen = <c> ]
[ lines = <i> ] [ levels = <i> ] [ colorbar ] [units = <c> ][ labels ]
[ aspect ]  

Description

The plot.2d statement allows the user to prepare a two-dimensional XY plot. This command is usually used to look at material boundaries and grids, however, it can also be used to plot contours of a selected variable.

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 plane to perform sectioning along in microns. In two dimensions, these parameters are not necessary. In three dimensions, only one of xvalue, yvalue, or zvalue can be specified for a given device. Specifying xvalue will produce a horizontal slice through the device and yvalue will specify a vertical slice. An easy way to remember is that the cross-section is taken at the constant value 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.
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.
boundary
This parameter specifies that the device outline and material interfaces should be drawn. It defaults to false.
grid
The grid parameter specifies that the numerical grid the problem was solved on should be drawn. It defaults to false.
mater, color
Color the specified material the value of the color.
aspect
The aspect parameter specifies that the device should be drawn with the proper aspect ratio of the size of the slice. If aspect is true, the device will be drawn with the proper aspect ratio. When false, the device will be expanded to fill the screen. It defaults to true.
contact, pen
Draw the contact on the plot with the specified pen type.
levels, line, colorbar, units, labels
These parameters control color contours of the selected plot variable. Levels control the number of shades employed between blue and red. Lines will draw black isobar lines on the plot. These can be used together or separately. Colorbar will add a labeled color bar to the right of the plot and units controls the legend written underneath the color bar. Labels will add a numeric value to the lines drawn.

Examples

plot2d grid  graph=p2d

This command will draw the grid and axis. Each material will be plotted in a different color.

plot2d bound xmin = 2 ymin = 5 graph=p2d

This command will draw the material interfaces with the maximum x and y values of 2.0 and 5.0 um.

plot2d bound graph=p2d

This command will draw the material interfaces and place symbols at each coordinate in the mesh.

plot2d contact=Gate graph = p2d pen=G

This command will draw the contact interface for the Gate using pen style G.

plot.2d levels = 100 colorbar graph = p2d

This command will provide a color plot with color bar on the graph p2d.

See Also

selectCommand pen