COMSOL 6.2 - Global (Numerical)

model.result().numerical(<ftag>).set(property,<value>);

model.result().numerical(<ftag>).getData(<expressionIndex>);

model.result().numerical(<ftag>).getImagData(<expressionIndex>);

model.result().numerical(<ftag>).isComplex(<outersolnum>);

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.

Table 7-51: Valid Properties for Global Evaluation.
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.
descr	String array		Descriptions for the expressions to evaluate.
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 evaluate.
complexfun	on \| off	on	Use complex-valued functions with real input.
matherr	on \| off	off	Error for undefined operation or variable.
outersolnum	nonnegative integer	1	The index of the outer solutions to use. Applicable only for parametric sweep models.
phase	double	0	Evaluate solution at this angle, given in degrees.
solnum	nonnegative integer array	All solutions	The solutions to use.
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.
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.

Table 7-51: Valid Properties for Global Evaluation.

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.

descr

String array

Descriptions for the expressions to evaluate.

differential

on | off

Whether the expression should be linearized at the linearization point. Applicable only if evalmethod is harmonic.

evalmethod

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 evaluate.

complexfun

on | off

Use complex-valued functions with real input.

matherr

on | off

off

Error for undefined operation or variable.

outersolnum

nonnegative integer

The index of the outer solutions to use. Applicable only for parametric sweep models.

phase

double

Evaluate solution at this angle, given in degrees.

solnum

nonnegative integer array

All solutions

The solutions to use.

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.

double array

Empty

The times to use. Available when the underlying solution is transient.

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.