Particle.f90 File Reference

Go to the source code of this file.

Data Types
type	particlemodule::particletype
	Particle tracked by the PRT model. More...
type	particlemodule::particlestoretype
	Structure of arrays to store particles. More...

Modules
module	particlemodule

Enumerations
enum	{   particlemodule::active = 1 , particlemodule::term_boundary = 2 , particlemodule::term_weaksink = 3 , particlemodule::term_no_exits = 5 ,   particlemodule::term_stopzone = 6 , particlemodule::term_inactive = 7 , particlemodule::term_unreleased = 8 , particlemodule::term_no_exits_sub = 9 ,   particlemodule::term_timeout = 10 }
	Particle status enumeration. More...
enum	{   particlemodule::release = 0 , particlemodule::exit = 1 , particlemodule::timestep = 2 , particlemodule::terminate = 3 ,   particlemodule::weaksink = 4 , particlemodule::usertime = 5 }
	Particle event enumeration. More...

Functions/Subroutines
subroutine	particlemodule::create_particle (particle)
	Create a new particle. More...
subroutine	particlemodule::create_particle_store (store, np, mempath)
	Allocate particle store. More...
subroutine	particlemodule::destroy (this, mempath)
	Destroy particle store after use. More...
subroutine	particlemodule::resize (this, np, mempath)
	Reallocate particle storage to the given size. More...
subroutine	particlemodule::get (this, particle, imdl, iprp, ip)
	Load a particle from the particle store. More...
subroutine	particlemodule::put (this, particle, ip)
	Save a particle's state to the particle store. More...
subroutine	particlemodule::transform_coords (this, xorigin, yorigin, zorigin, sinrot, cosrot, invert)
	Transform particle coordinates. More...
subroutine	particlemodule::reset_transform (this)
	Reset particle coordinate transformation properties. More...
subroutine	particlemodule::get_model_coords (this, x, y, z)
	Return the particle's model coordinates, inverting any applied transformation if needed. The particle's state is not altered. More...
integer function	particlemodule::num_stored (this)
	Return the number of particles. More...

Variables
integer, parameter	particlemodule::max_level = 4
	Tracking "levels" (1: model, 2: cell, 3: subcell). A level identifies the domain through which a tracking method is responsible for moving a particle. Methods each operate on a particular level, delegating among more methods as appropriate for finer-grained levels. More...