GfsParticleList

From Gerris

Revision as of 15:00, 1 August 2012 GeordieMcBain (Talk | contribs) (clarified syntax, noted importance of specifying istep=1) ← Previous diff		Current revision Popinet (Talk | contribs) (GfsParticleList is derived from GfsEventList)
Line 1:		Line 1:
	[[GfsParticleList]] in the [[particulates]] module is used to define a list of discrete point-particles that drift in or move through the flow.		[[GfsParticleList]] in the [[particulates]] module is used to define a list of discrete point-particles that drift in or move through the flow.
-	The syntax in parameter depends on the type of discrete point-particles and is either:	+	The syntax in parameter file is:
-	[ [[GfsEvent]] ] [[GfsParticle]] {	+	[ [[GfsEventList]] ] {
-	1 X1 Y1 Z1	+	[ [[GfsParticleForce]] ]
-	2 X2 Y2 Z2	+	[ [[GfsParticleForce]] ]
-	...	+	...
-	} {}	+
-		+
-	or	+
-		+
-	[ [[GfsEvent]] ] [[GfsParticulate]] {	+
-	1 X1 Y1 Z1 M1 Vol1 U1 V1 W1 Fx1 Fy1 Fz1	+
-	2 X2 Y2 Z2 M2 Vol2 U2 V2 W2 Fx2 Fy2 Fz2	+
-	...	+
-	} {	+
-	[ [[GfsForceDrag]] ]	+
-	[ [[GfsForceLift]] ]	+
-	[ [[GfsForceBuoy]] ]	+
	}		}
-	In either case Xi, Yi, and Zi are the initial coordinates of the i-th particle and the [[GfsEvent]] timing parameters of the [[GfsParticleList]] control the discretization of the motion; the latter will generally include setting <code>istep = 1</code> so that the particles move in time with the fluid.	+	where the parameter block is optional and defines a list of forces acting on the particles.
	If (as a [[GfsEvent]]), the GfsParticleList is named, e.g.		If (as a [[GfsEvent]]), the GfsParticleList is named, e.g.
-	GfsParticleList *LP ...	+	GfsParticleList *LP ...
	the status of the particles in list can be saved to FILE; e.g.		the status of the particles in list can be saved to FILE; e.g.
-	[[GfsOutputObject]] { istep = 1 } FILE LP	+	[[GfsOutputObject]] { istep = 1 } FILE LP
	<examples/>		<examples/>

---

Current revision

GfsParticleList in the particulates module is used to define a list of discrete point-particles that drift in or move through the flow.

The syntax in parameter file is:

[ GfsEventList ] {
 [ GfsParticleForce ]
 [ GfsParticleForce ]
 ...
}

where the parameter block is optional and defines a list of forces acting on the particles.

If (as a GfsEvent), the GfsParticleList is named, e.g.

GfsParticleList *LP ...

the status of the particles in list can be saved to FILE; e.g.

GfsOutputObject { istep = 1 } FILE LP