Ray Tracing
The Ray Tracing study step is a special case of the Time Dependent study step. It includes additional options for computing ray paths. The Ray Tracing study step is available with the Acoustics Module or the Ray Optics Module.
Syntax
model.study(stdname).create(fname, "RayTracing");
model.study(stdname).feature(fname).set(pname,value);
Description
Study step.
The following properties are available.
Table 6-145: Properties for Study Settings.
Property
Value
Default
Description
charvel
String
c_const
Group velocity used to convert path lengths to solution times when timestepspec=specifylength.
llist
Numeric vector
 
List of path lengths when timestepspec=specifylength.
lunit
String
m
Length unit when timestepspec=specifylength.
raystopcond
nostop | noactive | rayintensity
 
Automatic stop condition in the default solver sequence.
rtol
Positive scalar
0.01
Relative tolerance, if usertol is on.
thresholdintensity
String
1[W/m^2]
Threshold intensity for automatic stop conditions when raystopcond=rayintensity.
timestepspec
specifytime | specifylength
specifytime
Determines whether the time intervals are entered directly or in terms of a path length.
tlist
Numeric vector
 
Time list when timestepspec=specifytime.
tunit
String
s
Time unit when timestepspec=specifytime.
usertol
on | off
off
Physics-controlled or user-defined tolerance.
Table 6-146: Properties for Plot Results While Solving.
Property
Value
Default
Description
plot
on | off
off
Plot while solving.
plotgroup
String
default
Plot group to use for plot while solving.
probefreq
pout | psteps
pout
Where to update probes.
probes
Vector of strings
 
Probes to use when probesel=manual.
probesel
all | none | manual
all
Probes to compute.
plotfreq
tout | tsteps
tout
Where to update plot.
Table 6-147: Properties for Physics and Variables Selection.
Property
Value
Default
Description
activate
String Map
 
See Physics and Variables Selection.
activateCoupling
String Map
 
See Physics and Variables Selection.
activaterom
String Map
 
See Physics and Variables Selection.
disabledcommon
Reference Array
 
See Physics and Variables Selection.
disabledcoordinatesystems
Reference Array
 
See Physics and Variables Selection.
disabledcoupling
Reference Array
 
See Physics and Variables Selection.
disabledpair
Reference Array
 
See Physics and Variables Selection.
disabledphysics
Reference Array
 
See Physics and Variables Selection.
disabledreduced
Reference Array
 
See Physics and Variables Selection.
disabledvariables
Reference Array
 
See Physics and Variables Selection.
disableFrameControl
Reference Array
 
See Physics and Variables Selection.
discretization
String Map
 
See Physics and Variables Selection.
equationform
String Map
 
See Physics and Variables Selection.
equationform_freq
String Map
 
See Physics and Variables Selection.
equationform_freq_src
String Map
 
See Physics and Variables Selection.
reconstructors
String Map
 
See Physics and Variables Selection.
useadvanceddisable
on | off
off
See Physics and Variables Selection.
Table 6-148: Properties for Values of Dependent Variables.
Property
Value
Default
Description
initmethod
init | sol
init
Method for initial values for variables solved for.
initstudy
String
 
Reference to study or "zero" for zero solution.
manualsolnum
Vector of integers
[1]
Index to solution for initial value for variables solved for.
notlistsolnum
Vector of integers
[1]
Indices to selected solutions for values for variables not solved for.
notmanualsolnum
Vector of integers
[1]
Indices to solutions for values for variables not solved for.
notsolmethod
init | sol
init
Method for values for variables not solved for.
notsolnum
auto | all | first | last | from_list | interp | manual | positive integer
auto
Solution selection for values for variables not solved for.
notstudy
String
 
Reference to study or "zero" for zero solution.
nott
String
 
Specify time for interpolated solution of values for variables not solved for.
outputInterface
The interfaces to use as key
 
An output property for the physics interfaces in the output. It can be used as keys while setting the outputmap and outputselectionmap.
outputmap
String Map
 
See Store in Output for possible options and defaults (this property corresponds to the Output column). Possible values are physics, all, none, or selection.
outputselectionmap
String Map
 
A semicolon-separated string array of the output selections (specified with tags).
solnum
auto | first | last | interp | manual | positive integer
auto
Solution selection of initial values for variables solved for.
t
String
 
Specify time for interpolated solution of initial value for variables solved for.
useinitsol
on | off
off
User-controlled initial values for variables solved for.
usesol
on | off
off
User-controlled values for variables not solved for.
See setEntry() for information about setting the values for a property that uses a String Map. If you use the set(pname,value) method, you have to provide all alternating property name and property value pairs.
Table 6-149: Property for Mesh selection.
Property
Value
Default
Description
mesh
Vector of strings
 
Select meshes for geometries. The length of the vector is two times the number of geometries. Example value when two geometries geom1 and geom2 are available is: new String[]{"geom1","mesh1","geom2", "mesh2"}.
Table 6-150: Properties for Mesh Adaptation and Study Extensions.
Property
Value
Default
Description
adapgeom
String
 
Name of geometry to use.
adaption
on | off
off
Adaptive mesh refinement.
adaptselection
selection
all()
The selection for the adaptation (the default is the entire geometry). See Selections.
autoremesh
on | off
off
Automatic remeshing.
autoremeshgeom
String
 
Name of geometry to use.
plistarr
Real matrix
 
List of parameter values. One row of values per parameter name.
pname
Vector of strings
 
Parameter names.
punit
Vector of strings
 
Parameter units.
sweeptype
filled | sparse
sparse
Sweep type: a filled or a sparse sweep.
useparam
on | off
off
Auxiliary sweep.