Bidirectionally Coupled Particle Tracing

Bidirectionally Coupled Particle Tracing

The Bidirectionally Coupled Particle Tracing study step is a special case of the Time Dependent study step that is used to model bidirectionally coupled particle-field or fluid-particle interactions. It is available with the Particle Tracing Module. It is similar to the Time Dependent study step but has an additional section called Iterations, which determines the behavior of the iterative solver loop for self-consistently modeling particle-field interactions in the default solver sequence.

model.study(stdname).create(fname, "BidirectionallyCoupledParticleTracing");

model.study(stdname).feature(fname).set(pname,value);

The following properties are available.

Table 6-91: Properties for Study Settings
Property	Value	Default	Description
tlist	Numeric vector		Time list.
usertol	on \| off	off	Physics-controlled or user-defined tolerance.
rtol	Positive scalar	0.01	Relative tolerance, if usertol is on.
tunit	String	s	Time unit.

Table 6-92: 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-93: 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-94: Properties for Iterations Section
Property	Value	Default	Description
expr	String	1	Global expression used to compute relative error when method=convergence.
iter	Positive integer	5	Number of iterations of the solver loop when method=iterations.
maxiter	Positive integer	25	Maximum number of iterations in the solver loop when method=convergence.
method	convergence \| iterations	iterations	Choose whether termination of the solver loop is based on the convergence of a global variable or a fixed number of iterations.
miniter	Positive integer	1	Minimum number of iterations in the solver loop when method=convergence.
rtolterm	Positive real number	0.001	Relative tolerance for termination of the solver loop when method=convergence.
rtolthresh	Positive real number	1	Threshold used to avoid division by zero while computing the relative error when method=convergence.

Table 6-95: 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.
solnum	auto \| first \| last \| interp \| manual \| positive integer	auto	Solution selection of initial values for variables solved for.
storesel	Vector of strings		Selections defining which field data to store.
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.
usestoresel	all \| selection	all	Store fields in output.

Table 6-96: 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-97: 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.