Global (Numerical)
Evaluate global quantities.
Syntax
model.result().numerical().create(<ftag>,"Global");
model.result().numerical(<ftag>).set(property,<value>);
model.result().numerical(<ftag>).getData();
model.result().numerical(<ftag>).getData(<expressionIndex>);
model.result().numerical(<ftag>).getImagData();
model.result().numerical(<ftag>).getImagData(<expressionIndex>);
model.result().numerical(<ftag>).isComplex();
model.result().numerical(<ftag>).isComplex(<outersolnum>);
model.result().numerical(<ftag>).getNData();
model.result().numerical(<ftag>).run();
Description
model.result().numerical().create(<ftag>,"Global") creates an evaluation feature with the name <ftag>.
Global is a feature made specifically for users of the COMSOL API and does not appear in the COMSOL Desktop. Global features support multiple expressions as well as some additional advanced properties not available in EvalGlobal.
result = model.result().numerical(<ftag>).getData() returns the real part of the result, recomputing the feature if necessary. result is a three-dimensional double matrix ordered result[expression][solnum][value].
model.result().numerical(<ftag>).getData(<expressionIndex>) returns the real part of the result for one expression, equivalent to result[expressionIndex].
result = model.result().numerical(<ftag>).getImagData() returns the imaginary part of the result, recomputing the feature if necessary. result is a three-dimensional double matrix ordered result[expression][solnum][value].
model.result().numerical(<ftag>).getImagData(<expressionIndex>) returns the imaginary part of the result for one expression, equivalent to result[expressionIndex].
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>).getNData() returns the number of points in the data vector.
The following properties are available:
none | parent | dataset name
The dataset this feature refers to. parent is only applicable if used in an evaluation group.
on | off
linpoint | harmonic | lintotal | lintotalavg | lintotalrms | lintotalpeak
on | off
on | off
manual | parent
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.
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
Eval, Interp, EvalPoint, EvalGlobal