MaxVolume, MaxSurface, MaxLine, MinVolume, MinSurface, MinLine
Find extremal values (maximum or minimum).
Syntax
model.result().numerical().create(<ftag>,"MaxVolume");
model.result().numerical().create(<ftag>,"MinVolume");
model.result().numerical().create(<ftag>,"MaxSurface");
model.result().numerical().create(<ftag>,"MinSurface");
model.result().numerical().create(<ftag>,"MaxLine");
model.result().numerical().create(<ftag>,"MinLine");
model.result().numerical(<ftag>).selection(...);
model.result().numerical(<ftag>).set(property, <value>);
model.result().numerical(<ftag>).getReal();
model.result().numerical(<ftag>).getReal(<columnwise>);
model.result().numerical(<ftag>).getReal(<outersolnum>);
model.result().numerical(<ftag>).getReal(<columnwise>,<outersolnum>);
model.result().numerical(<ftag>).getImag();
model.result().numerical(<ftag>).getImag(<allocate>, <columnwise>);
model.result().numerical(<ftag>).getImag(<outersolnum>);
model.result().numerical(<ftag>).getImag(<allocate>, <columnwise>,<outersolnum>);
model.result().numerical(<ftag>).isComplex();
model.result().numerical(<ftag>).isComplex(<outersolnum>);
model.result().numerical(<ftag>).computeResult();
model.result().numerical(<ftag>).setResult();
model.result().numerical(<ftag>).appendResult();
 
When added to an evaluation group, replace numerical(<ftag>) with evaluationGroup(<ftag>).
Description
model.result().numerical().create(<ftag>,"MaxVolume") creates a volume maximum feature with the name <ftag>, and similarly for "MinVolume".
model.result().numerical().create(<ftag>,"MaxSurface") creates a surface maximum feature with the name <ftag>, and similarly for "MinSurface".
model.result().numerical().create(<ftag>,"MaxLine") creates a line maximum feature with the name <ftag>, and similarly for "MinLine".
model.result().numerical(<ftag>).getReal() returns the real result, recomputing the feature if necessary. Data is ordered such that one row contains data for all solution numbers. This is identical to (columnwise) when columnwise is false. If columnwise is true, the ordering is the opposite: each column contains the values for all solution numbers.
model.result().numerical(<ftag>).getImag(allocate, columnwise) returns the imaginary part of complex result, recomputing the feature if necessary. If allocate is true, a zero-valued matrix is allocated even when the result is real. getImag() uses allocate true and columnwise false.
model.result().numerical(<ftag>).isComplex() returns true if the result is complex. The resulting value is a scalar, which true if any of the expressions in an array is complex-valued.
model.result().numerical(<ftag>).isComplex(<outersolnum>) returns true if the result is complex for the given outer solution. <outersolnum> is applicable only for parametric sweep solutions and is the index of each outer parametric solution.
model.result().numerical(<ftag>).computeResult() returns the matrix of data that the setResult method adds to a table. The matrix includes data only, not the parameter columns, and it does not use any table-specific settings.
model.result().numerical(<ftag>).setResult() and model.result().numerical(<ftag>).appendResult() evaluates the feature and set or append the result in the table indicated by the table property.
The following properties are available:
Table 7-72: Valid Property/Value Pairs for Maximum and Minimum
name
Value
Default
Description
const
String array of property/value pairs
Empty
Parameters to use in the expressions.
data
none | parent | dataset name
First compatible dataset
The dataset this feature refers to. parent is only applicable if used in an evaluation group.
dataseries
average | integral | maximum | minimum | none | rms | stddev | variance
none
The transformation that is applied to the data series formed by the evaluation.
dataseriescumulative
true | false
false
Make the table values as a cumulative integration, when dataseries is set to integral.
dataseriesmethod
auto | integration | summation
auto
The method to use for the data series: automatic, integration, or summation.
descr
String array
Model-dependent
The descriptions of the expressions in expr. Is used in the automatic title.
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 array
Model-dependent
The expressions to plot.
includepos
true | false
false
Include the coordinates for the positions of the maximum and minimum.
innerinput
all | first | last | manual | manualindices | interp
all
How to input the solution to use. manual indicates that solnum is used. manualindices indicates that solnumindices is used. interp indicates that t is used.
interp
double row matrix
Empty on all levels.
The times to use, for transient levels. Available when data is not parent and the underlying data is transient.
intorder
nonnegative integer
4
The integration order to use when points is set to integration.
localzphys
array
0
The local z-coordinates, when locdef is set to physical.
localzrel
array of -1–1 numbers
0
The local relative z-coordinates, when locdef is set to relative.
locdef
reference | physical | relative
reference
The location definition, if locinput is set to manual: a reference surface, physical z-coordinate, or a relative z-coordinate. Only available when using a Layered Material or Shell dataset. Not available for MaxVolume and MinVolume.
locinput
fromdataset | manual
fromdataset
The location input: from the dataset or manual. Only available when using a Layered Material or Shell dataset. Not available for MaxVolume and MinVolume.
looplevel
integer row matrix
All solutions on all levels
The solutions to use, per level.
looplevelindices
integer row matrix
Empty
An alternative way to specify the solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when looplevelinput is manualindices on a level.
looplevelinput
String array with all | first | last | manual | manualindices | interp on each level
all on all levels
How to input the solution to use, per level. manual on a level indicates that looplevel is used on that level. manualindices on a level indicates that looplevelindices is used on that level. interp on a level indicates that interp is used on that level.
normalization
first | last | maximum | none
none
The normalization of the columns that is applied to the data series formed by the evaluation.
obj
abs | real
real
The function of each real or complex number that is maximized/minimized.
outerinput
all | first | last | manual | manualindices
all
How to input the outer solutions to use. Applicable only for parametric sweep models. manual indicates that outersolnum is used. manualindices indicates that outersolnumindices is used.
outersolnum
nonnegative integer array
1
The index of the outer solutions to use. Applicable only for parametric sweep models. Since the various outer solutions can have different number of solnum, the solnum property is not used.
outersolnumindices
String or integer array
Empty
An alternative way to specify the outer solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when outerinput is manualindices.
points
lagrange | node | integration
lagrange
The evaluation points for the maximum or minimum: Lagrange points, node points, or integration points (Gauss points).
prependcoords
true | false
false
Prepend the position of the maximum and minimum values.
refine
positive integer
5
The Lagrange order (number of refinements) to use when points is set to lagrange. Bear in mind that this is the refinement used for the base dataset, so the number of elements in the model can increase radically if the plot uses, for example, a revolve dataset.
solnum
nonnegative integer array
All solutions
The solutions to use.
solnumindices
String or integer array
Empty
An alternative way to specify the solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when innerinput is manualindices.
solrepresentation
solnum | solutioninfo
solutioninfo
Indicates which method of selecting solutions is active.
solutionparams
manual | parent
manual
If data is a local dataset with nontrivial data and the feature is part of an evaluation group, specify solutions manually or take them from the parent evaluation group.
t
double array
Empty
The times to use. Available when the underlying solution is transient.
table
new | table name
new
The table to use when calling setResult() or appendResult(). new indicates that a new table is created.
tablecols
inner | outer | data | level1
data
Whether to use inner or outer solutions as columns in the table when calling setResult() or appendResult(). Applicable only for parametric sweep models. The level values (level1, level2, and so on) are the levels in the parametric sweep.
timeinterp
on | off
off
on if t is used to determine time steps; off if solnum is used.
unit
String array
Model-dependent
The units to use for the expressions in expr. If the old unit is not valid when the expression changes, the unit property is reset to default.
See Also
AvVolume, AvSurface, AvLine, IntVolume, IntSurface, IntLine