Deform

Add a deformation attribute to a plot.

Syntax

model.result(<pgtag>).feature(<ftag>).create(<atag>,"Deform");

model.result(<pgtag>).feature(<ftag>).feature(<atag>).set(property, <value>);

Description

model.result(<pgtag>).feature(<ftag>).create(<atag>,"Deform") creates a deformation attribute feature with the name <atag>, belonging to the feature <ftag>.

Deformation attributes deform the coordinates of a plot feature according to an expression (typically the displacement in a structural mechanics model). The deformation attribute can be added to arrow plots, contour plots, isosurface plots, particle plots, slice plots, streamline plots, surface plots, volume plots, and mesh plots.

The following properties are available:

Table 7-20: Valid Property/Value Pairs for Deform

Property	Value	Default	Description
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
maxreldeformexpr	String	"0,1"	Maximum relative deformation as a fraction of the mean size of the geometry’s bounding box.
prefixintitle	String	Empty	Added prefix to contribution to title
scale	positive double	Model-dependent	The scale factor for the deformation
scaleactive	on | off	off	Whether to use the automatically computed scale, or the scale in the scale property.
suffixintitle	String	Empty	Added suffix to contribution to title
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.

See Also

Color, Height, HistogramHeight, TableHeight, ArrowVolume, ArrowSurface, ArrowLine, Contour, Contour, Isosurface, Line, Mesh, Particle, ParticleMass, ScatterVolume, ScatterSurface, Slice, Streamline, Surface, Volume.