Eval

Evaluate expressions in domains.

Syntax

model.result().numerical().create(<ftag>,"Eval");

model.result().numerical(<ftag>).selection(...);

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>).getCoordinates();

model.result().numerical(<ftag>).getElements();

model.result().numerical(<ftag>).getVertexElements();

model.result().numerical(<ftag>).run();

Description

model.result().numerical().create(<ftag>,"Eval") creates an evaluation feature with the name <ftag>.

Eval is a feature made specifically for users of the COMSOL API and does not appear in the COMSOL Multiphysics GUI. It is used to evaluate results directly on the solution.

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][coordinates].

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][coordinates].

model.result().numerical(<ftag>).getImagData(<expressionIndex>) returns the imaginary 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.

model.result().numerical(<ftag>).getCoordinates() returns node point coordinates.

model.result().numerical(<ftag>).getElements() returns indices to columns in p of a simplex mesh.

model.result().numerical(<ftag>).getVertexElements() returns indices to mesh elements for each point.

The following properties are available:

Table 7-23: Valid Property/Value Pairs for Evaluation

name	Value	Default	Description
const	String array of property/value pairs	Empty	Parameters to use in the expressions.
data	none | data set name	First compatible data set	The data set this feature refers to. Only solution and particle data sets are supported.
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.
gporder	poitive integer	1	If pattern is gauss: The Gauss point order.
matherr	on | off	off	Error for undefined operation or variable.
outersolnum	non-negative integer	1	The index of the outer solutions to use. Applicable only for parametric sweep models.
refine	auto | integer	auto	Refinement of elements for evaluation points.
recover	off | pprint | ppr	off	The derivative recovery method (off, within domains, or everywhere).
pattern	gauss | lagrange	lagrange	Specifies if evaluation takes place in Lagrange points or in Gauss points.
phase	double	0	Evaluate solution at this angle, given in degrees.
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.
t	double array	Empty	The times to use. Available when the underlying solution is transient.
threshold	manual | none	none	Use a smoothing threshold.
thresholdvalue	double	0.1	Threshold value (0-1), if threshold is set to manual.
phase	double	0	Evaluate solution at this angle, given in degrees.
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

Interp, Global (numerical), EvalPoint, EvalGlobal