[PATCH] Convert ParticlesDoc.txt to html

Mon Aug 23 16:10:43 UTC 2004

Richard Guenther wrote:

>As subject says.  Also adds common header to Layout.html.
>
>Ok?
>
>Richard.
>
>
>2004Aug23  Richard Guenther <richard.guenther at uni-tuebingen.de>
>
>	* docs/Layout.html: adjust background color, add head image.
>	docs/index.html: refer to ParticlesDoc.html.
>	docs/ParticlesDoc.html: new.
>	docs/ParticlesDoc.txt: remove.
>  
>
>------------------------------------------------------------------------
>
>
>--- /dev/null	Tue May 18 17:20:27 2004
>+++ ParticlesDoc.html	Mon Aug 23 13:13:27 2004
>@@ -0,0 +1,1520 @@
>+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
>+<html>
>+<head>
>+   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
>+   <meta name="GENERATOR" content="Mozilla/4.72 [en] (X11; U; Linux 2.2.14 i686) [Netscape]">
>+   <title>Layout and related classes</title>
>  
>
This title should probably be "POOMA Particles Documentation".

Other than that, everything looks great.  It is nice to have 
documentation of the particles.

>+</head>
>+<body background="back.gif" LINK="#505062" ALINK="#505062" VLINK="#be7c18">
>+
>+<CENTER><IMG SRC="banner.gif" ALT="POOMA banner" WIDTH=550 HEIGHT=100
>+ALIGN=bottom></CENTER>
>+
>+
>+<h1>POOMA Particles Documentation</h1>
>+
>+
>+<h2>Introduction</h2>
>+
>+<p>
>+Particles are primarily used in one of two ways in large scientific 
>+applications.  The first is to track sample particles using Monte 
>+Carlo techniques, for example, to gather statistics that describe the
>+conditions of a complex physical system.  Particles of this kind are
>+often referred to as "tracers".  The second is to perform direct
>+numerical simulation of systems that contain discrete point-like
>+entities such as ions or molecules.
>+
>+<p>
>+In both scenarios, the application contains one or more sets of
>+particles.  Each set has some data associated with it that describes
>+its members' characteristics, such as mass or momentum.  Particles
>+typically exist in a spatial domain, and they may interact directly 
>+with one another or with field quantities defined on that domain.
>+
>+<p>
>+This document gives an overview of POOMA's support for particles,
>+then discusses some implementation details.  The classes introduced in
>+this tutorial are illustrated by two short programs: one that tracks
>+particles under the influence of a simple one-dimensional harmonic
>+oscillator potential, and another that models particles bouncing off
>+the walls of a closed three-dimensional box.  Later on, we will show
>+how particles and fields can interact in a simulation code.
>+
>+
>+<h2>Overview</h2>
>+
>+<p>
>+POOMA's Particles class is a container for a heterogeneous collection 
>+of particle attributes.  The class uses dynamic storage for particle 
>+data (in the form of a set of POOMA DynamicArray objects), so that 
>+particles can be added or deleted as necessary.  It contains a layout 
>+object that manages the distribution of particle data across multiple 
>+patches, and it applies boundary conditions to particles when attribute 
>+data values exceed a prescribed range.  In addition, global functions 
>+are provided for interpolating data between particle and field element 
>+positions.
>+
>+<p>
>+Each Particles object keeps a list of pointers to its elements' 
>+attributes.  When an application wants to add or delete particles, it 
>+invokes a method on the Particles object, which delegates the call to 
>+the layout object for the contained attributes.  Particles also 
>+provides a member function called sync(), which the application
>+invokes in order to update the global particle count and numbering,
>+update the data distribution across patches, and apply the particle
>+boundary conditions.
>+
>+<p>
>  
>

-- 
Jeffrey D. Oldham
oldham at codesourcery.com