GfsParticleList

From Gerris

Revision as of 17:17, 19 July 2012 GeordieMcBain (Talk | contribs) (added automatic <examples/> tag (hoping there'll be some examples one day)) ← Previous diff		Revision as of 15:00, 1 August 2012 GeordieMcBain (Talk | contribs) (clarified syntax, noted importance of specifying istep=1) Next diff →
Line 1:		Line 1:
-	The [[GfsParticleList]] is used in the [[particulates]] module to define a list of discrete point-particles that drift with 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 is:	+	The syntax in parameter depends on the type of discrete point-particles and is either:
-	[ [[GfsEvent]] ] GfsParticle {	+	[ [[GfsEvent]] ] [[GfsParticle]] {
	1 X1 Y1 Z1		1 X1 Y1 Z1
	2 X2 Y2 Z2		2 X2 Y2 Z2
Line 9:		Line 9:
	} {}		} {}
-	where Xi, Yi, and Zi are the initial coordinates of the i-th particle.	+	or
-	The step or istep [[GfsEvent]] parameters of the [[GfsParticleList]] control the discretization of the motion.	+	[ [[GfsEvent]] ] [[GfsParticulate]] {
-		+	1 X1 Y1 Z1 M1 Vol1 U1 V1 W1 Fx1 Fy1 Fz1
-	For discrete masses with inertia and subject to forces, replace [[GfsParticle]] with [[GfsParticulate]], for which the syntax is:	+	2 X2 Y2 Z2 M2 Vol2 U2 V2 W2 Fx2 Fy2 Fz2
-		+	...
-	[ [[GfsEvent]] ] [[GfsParticulate]] {	+	} {
-	1 X1 Y1 Z1 MASS1 VOLUME1 Vx1 Vy1 Vz1 Fx1 Fy1 Fz1	+
-	2 X2 Y2 Z2 MASS2 VOLUME2 Vx2 Vy2 Vz2 Fx2 Fy2 Fz2	+
-	...	+
-	} {	+
	[ [[GfsForceDrag]] ]		[ [[GfsForceDrag]] ]
	[ [[GfsForceLift]] ]		[ [[GfsForceLift]] ]
	[ [[GfsForceBuoy]] ]		[ [[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.
	If (as a [[GfsEvent]]), the GfsParticleList is named, e.g.		If (as a [[GfsEvent]]), the GfsParticleList is named, e.g.
Line 29:		Line 27:
	GfsParticleList *LP ...		GfsParticleList *LP ...
-	the status of the particles in list LP can be saved to FILE with [[GfsOutputObject]]; 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/>

---

Revision as of 15:00, 1 August 2012

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:

[ GfsEvent ] GfsParticle {  
  1 X1 Y1 Z1
  2 X2 Y2 Z2
  ...
} {}

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 istep = 1 so that the particles move in time with the fluid.

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