Surface
Create a surface plot.
Syntax
model.result(<pgtag>).create(<ftag>,"Surface");
model.result(<pgtag>).feature(<ftag>).set(property, <value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
 model.result(<pgtag>).create(<ftag>,"Surface") creates a surface plot feature named <ftag> belonging to the plot group <pgtag>.
Surface plots display a quantity as a colored 2D or 3D surface.
The following properties are available:
Table 7-93: Valid Property/Value Pairs for Surface Plots
Property
Value
Default
Description
color
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
red
The uniform color to use. Active when coloring is uniform.
coloring
colortable | uniform
colortable
How to color this surface.
colorlegend
on | off
on
Whether to show color legend, when coloring is set to colortable.
colortable
color table name
Rainbow
The color table to use when colormethod is set to colortable. See Color Tables for a list of color tables.
colortablerev
on | off
off
Whether to reverse to color table when colormethod is set to colortable.
colortablesym
on | off
off
Whether to symmetrize the color range around 0 when colormethod is set to colortable.
const
String array of property/value pairs
Empty
Parameters to use in the expressions.
customcolor
RGB-triplet
{1,0,0} or last used color.
The uniform color to use. Active when color is set to custom.
data
none | parent | data set name
parent
The data set this feature refers to.
descr
String
Model-dependent.
The description of the expression in expr. Is used in the automatic title.
descriptionintitle
on | off
on
Whether the title contribution should contain the description when titletype is custom.
differential
on | off
on
Whether the expression should be linearized at the linearization point. Applicable only if evalmethod is harmonic.
evalmethod
linpoint | harmonic | lintotal | lintotalavg | lintotalrms | lintotalpeak
harmonic
Applicable only for solutions with a stored linearization point. Controls if the linearization point, the perturbation, or a combination should be used when evaluating the expression.
expr
String
Model-dependent.
The expression to plot.
expressionintitle
on | off
off
Whether the title contribution should contain the expression when titletype is custom.
inheritcolor
Boolean
true
If inheritplot is not none: Determines if the color is inherited.
inheritdeformscale
Boolean
true
If inheritplot is not none: Determines if the deformation scale is inherited.
inheritheightscale
Boolean
true
If inheritplot is not none: Determines if height scale is inherited.
inheritplot
none | plot name
none
The plot that color, color range, height scale, and deformation scale are inherited from.
inheritrange
Boolean
true
If inheritplot is not none: Determines if the color and data ranges are inherited.
interp
double array
Time corresponding to last selected solnum for transient levels.
The time to use, for transient levels. Available when data is not parent and the underlying data is transient.
looplevel
array of nonnegative integers and strings
Last solution for transient or parametric solution for each level. Otherwise first solution for each level.
The index of the solution to use, per level, or interp, but only for transient solutions. Available when data is not parent and the underlying data has multiple solutions.
outersolnum
nonnegative integer
1
The index of the outer solutions to use. Applicable only for parametric sweep models.
prefixintitle
String
Empty
Added prefix to contribution to title.
rangecoloractive
on | off
off
Whether to use the manual color range specified in rangecolormin and rangecolormax. The color range specifies the minimum and maxim value in the plotted colors. Default is the minimum and maximum data values.
rangecolormax
double
Plot-dependent
The maximum color range value. Active when rangecoloractive is on.
rangecolormin
double
Plot-dependent
The minimum color range value. Active when rangecoloractive is on.
rangedatactive
on | off
off
Whether to use the manual data range specified in rangedatamin and rangedatamax. Values outside the data range is not plotted.
rangedatamax
double
Plot-dependent
The maximum data value. Active when rangedataactive is on.
rangedatamin
double
Plot-dependent
The minimum data value. Active when rangedataactive is on.
recover
off | pprint | ppr
off
The derivative recovery method (off, within domains, or everywhere).
refine
nonnegative integer
1
The element refinement to use, if resolution is set to manual. Bear in mind that this is the refinement used for the base data set, so the number of elements in the model can increase radically if the plot uses, for example, a revolve data set.
resolution
norefine | coarse | normal | fine | finer | extrafine | custom
normal
Controls the plot’s resolution. A finer setting results in a higher resolution by modifying the internally computed default refinement. Use custom to enter your own refinement in the refine property.
smooth
none | material | internal | everywhere | expression
internal
Smoothing settings. With material, smoothing is done inside material domains With internal, smoothing is done inside geometry domains. With expression, the smoothing is based on the expression in smoothexpr.
smoothexpr
String
dom
The expression to use for smoothing when smooth is set to expression.
solnum
nonnegative integer
Last solution for transient or parametric solution. Otherwise first solution.
The index of the solution to use. Available when data is not parent and the underlying data has multiple solutions.
solrepresentation
solnum | solutioninfo
solutioninfo
Indicates which method of selecting solutions is active.
suffixintitle
String
Empty
Added suffix to contribution to title.
t
double
Time corresponding to last selected solnum.
The time to use, for transient problems. Available when data is not parent and the underlying data is transient.
threshold
manual | none
none
Use a smoothing threshold.
thresholdvalue
double
0.1
Threshold value (0-1), if threshold is set to manual.
timeinterp
on | off
off
on if t is used to determine time steps, off if solnum is used.
title
String
The auto-title.
The title to use when titletype is manual.
titletype
auto | custom | manual | none
auto
auto if the title contribution should be computed automatically, possibly using the group’s customization. custom if the title contribution should be computed automatically, but customized. manual if the manual title contribution should be used (the title property). none if no title contribution should be used.
typeintitle
on | off
on
Whether the title contribution should contain the type when titletype is custom.
unit
String
Model-dependent
The unit to use for the expression in expr. If the old unit is not valid when the expression changes, the unit property is reset to default.
unitintitle
on | off
on
Whether the title contribution should contain the unit when titletype is custom.
wireframe
on | off
off
Whether to plot filled elements or only their edges.
Attributes
Deform, Filter, Height, AberrationHeight, HistogramHeight, TableHeight
Examples
Surface plot on 2D solution:
Code for Use with Java
DatasetFeature ds = model.result().dataset().create("dset1", "Solution");
ds.set("Solution", "sol1");
ResultFeature pg = result().create("pg1",2);
pg.set("data","dset1");
pg.create("surf1","Surface");
pg.feature("surf1").set("expr", "3*u");
Code for Use with MATLAB
ds = model.result.dataset.create('dset1', 'Solution');
ds.set('Solution', 'sol1');
ResultFeature pg = result().create('pg1',2);
pg.set('data','dset1');
pg.create('surf1','Surface');
pg.feature('surf1').set('expr', '3*u');
Surface plot on cut plane in 3D using a Thermal color table:
Code for Use with Java
result().dataset().create("cp1", "CutPlane");
 
ResultFeature pg2 = result().create("pg2",3);
pg2.create("surf2","Surface");
pg2.feature("surf2").set("data", "cp1");
pg2.feature("surf1").set("expr", "2*u");
pg2.feature("surf1").set("colortable", "Thermal");
 
pg2.run();
Code for Use with MATLAB
result.dataset.create('cp1', 'CutPlane');
 
pg2 = result.create('pg2',3);
pg2.create('surf2','Surface');
pg2.feature('surf2').set('data', 'cp1');
pg2.feature('surf1').set('expr', '2*u');
pg2.feature('surf1').set('colortable', 'Thermal');
 
pg2.run;
See Also
Volume