model.probe()

Create and defined properties for probes, which you can add to a model to monitor some quantity (real or complex-valued number) during a time-dependent, frequency-domain, or parametric simulation.

Syntax

model.probe().create(<tag>, type);

model.probe(<tag>).model(<mtag>);

model.probe(<tag>).set(property,<value>);

model.probe(<tag>).create(<etag>, etype);

model.probe(<tag>).feature(<etag>).set(eproperty,<evalue>);

model.probe(<tag>).feature(<etag>).getAllowedPropertyValues(property);

model.probe(<tag>).genResult(String sol)

Description

model.probe().create(<tag>, type) creates a probe of type type with tag <tag>.

model.probe(<tag>).model(<mtag>) sets the model node to <mtag>.

model.probe(<tag>).set(property,<value>) set property to <value>.

model.probe(<tag>).selection(...) sets the selection for the probe. This is possible for the probes of the types Domain, Boundary, and Edge.

model.probe(<tag>).create(<etag>, etype) creates a point probe expression of type etype and tag <tag>.

model.probe(<tag>).feature(<etag>).set(eproperty,<evalue>) sets the property eproperty on the point probe expression <etag>.

model.probe(<tag>).feature(<etag>)).getAllowedPropertyValues(property) returns the set of allowed values for a property if the set is a finite set of strings; otherwise, it returns null.

model.probe(<tag>).genResult(String sol) where sol is a solver sequence tag. This function prepares for using a probe while solving or during postprocessing. The command is invoked automatically when a solver or study is run from the COMSOL Desktop for all active probes but needs to be invoked explicitly when run through the API. The function genResult(String sol) sets up result features for evaluating the corresponding probe using the solver sequence sol. If null is used, the default solver sequence for a solution data set is used. When sol is none then the corresponding probe solution data set does not refer to any solver sequence. This means, for example, that the current model is used for selections used for this probe. When a solver sequence is run, then solution to use for the probes is always reset to use the current solver.

Boundary Probes, Domain Probes, Edge Probes, Global Variable Probes, and Probe Point Expressions

Probes can be of the following types:.

Table 2-66: Probe Types

Type	Description
Boundary	Probe that defines a value as an integral, maximum, minimum, or average over boundaries.
Domain	Probe that defines a value as an integral, maximum, minimum, or average over domains.
Edge	Probe that defines a value as an integral, maximum, minimum, or average over edges (in 3D).
GlobalVariable	Probe that defines a value using a global variable.
PointExpr	Probe that defines a value by interpolation of an expression in a probe point. The probe point is defined by the parent, a DomainPoint or a BoundaryPoint.

Boundary Point Probes and Domain Point Probes

Probe points can be of the following types:

Table 2-67: Probe point Types

Type	Description
BoundaryPoint	Defines a probe coordinate on a boundary in 3D.
DomainPoint	Defines a probe coordinate in a domain.

Probes take the following properties:

Table 2-68: Probe properties

name	Value	Default	Description
descr	string		Description of the probe. Used for model.result().
descractive	on | off	off	Manual control of description.
expr	string		The expression defining the probe.
frame	string	spatial frame	Frame used for defining the probe.
intorder	Integer	4	Integration order (DomainProbe and BoundaryProbe).
intsurface	Boolean	false	Compute surface integral for1D axisymmetric DomainProbe and 2D axisymmetric BoundaryProbe average and integral probe types.
intvolume	Boolean	false	Compute volume integral for 2D axisymmetric DomainProbe average and integral probe types.
method	integration | summation	integration	Method used (DomainProbe and BoundaryProbe).
probename	string	probe tag	Probe variable name.
table	string	default	Table to use for probe evaluation.
type	average | maximum | minimum | integral	average	Type of probe (DomainProbe and BoundaryProbe).
unit	string	unit of expr	Unit for the probe. Used for model.result().
window	string	default	The plot window to use for the probe.

A probe point of the type DomainPoint takes the following properties:

Table 2-69: Probe properties

name	Value	Default	Description
bndsnap1	on|off	off	Snap to nearest point (1D).
bndsnap2	on|off	off	Snap to nearest boundary point (2D).
bndsnap3	on|off	off	Snap to nearest boundary point (3D).
coords	Matrix of doubles		Probe coordinates.
depthpointnormal	double	0	Depth along line defined by the pointnormal method.
depthpointdirection	double	0	Depth along line defined by the pointdirection method.
depthtwopoints	double	0	Depth along line defined by the twopoints method.
dimension	1 | 2 | 3	3	The spatial dimension in which the point resides.
first	Double array		The coordinates of the first point on the probe line.
method	pointnormal | pointdirection | twopoints | none	pointnormal	Line entry method.
second	Double array		The coordinates of the second point (for method=twopoints)
twopointscurrent	first | second	first	Point selector (for method=twopoints)

A probe point of BoundaryPoint types take the following properties:

Table 2-70: Probe properties

name	Value	Default	Description
coords	Double array	0,0,0	Probe coordinates.
rawcoords	Double array	0,0,0	Full precision probe coordinates.
snapcoords	Double array	0,0,0	The boundary-snapped coordinates.