GfsParticle

From Gerris

(Difference between revisions)
Jump to: navigation, search
Revision as of 01:02, 22 March 2010
Delauxs (Talk | contribs)

← Previous diff
Revision as of 15:19, 17 July 2012
GeordieMcBain (Talk | contribs)
(general tidy and rewrite)
Next diff →
Line 1: Line 1:
-A [[GfsParticle]] is basically an inert Lagrangian particle.+A GfsParticle is the basic inert Lagrangian particle of the type that constitutes a [[GfsParticleList]]; each is characterised by an ID number (an [http://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint unsigned integer]) and an initial (X, Y, Z) position.
-It can be used as a particle type to define a list of Lagrangian particles ([[GfsParticleList]]).+
-Each [[GfsParticle]] is characterised by its id number (interger) and position (X,Y,Z).+
-The syntax within the [[GfsParticleList]] syntax is+Although GfsParticle is derived from [[GfsEvent]], it inherits neither its read nor write methods, so timing (start, end ...) is not specified individually but only for whole [[GfsParticleList]]s; thus the syntax in parameter files is:
- [[GfsParticleList]] ... [[GfsParticle]] { Id X Y Z } ...+ [[GfsParticleList]] *LIST {
 + start = 0.1 istart = 10 ( step = 1.2 | istep = 10 ) end = 0.4 iend = 123
 + } [[GfsParticle]] { ID X Y Z } ...
-where Id is the id number and X, Y and Z are the initial coordinates of the [[GfsParticle]].+Here the syntax of the optional name LIST and the timing parameters as for the GfsEvent that GfsParticleList is derived from. The (here elided) end of the line describes the [[GfsParticleForce]]s.
-Non-inert particles can be created using [[GfsParticulate]].+Particles with more properties can be created using the [[GfsParticulate]] subclass.
-The [[GfsParticle]] particle object is derived from [[GfsEvent]] but does not inherit of its read/write method i.e. timing (start, end ...) cannot be specified directly for a [[GfsParticle]] but has to be specify for the whole [[GfsParticleList]].+<examples/>
- +
-* [[GfsEvent]]+
-** [[GfsParticle]]+
-*** [[GfsParticulate]]+

Revision as of 15:19, 17 July 2012

A GfsParticle is the basic inert Lagrangian particle of the type that constitutes a GfsParticleList; each is characterised by an ID number (an unsigned integer) and an initial (X, Y, Z) position.

Although GfsParticle is derived from GfsEvent, it inherits neither its read nor write methods, so timing (start, end ...) is not specified individually but only for whole GfsParticleLists; thus the syntax in parameter files is:

GfsParticleList *LIST { 
   start = 0.1 istart = 10 ( step = 1.2 | istep = 10 ) end = 0.4 iend = 123 
} GfsParticle { ID X Y Z } ...

Here the syntax of the optional name LIST and the timing parameters as for the GfsEvent that GfsParticleList is derived from. The (here elided) end of the line describes the GfsParticleForces.

Particles with more properties can be created using the GfsParticulate subclass.


Personal tools
communication