FLASH3.3 Release API

ROBODoc 4.99 manual

Generated from /asc/home/flashdocs/FLASH3_33/source/Particles/Particles_initPositions.F90 with ROBODoc v4.99.8 on Wed Oct 20 17:16:47 2010

TABLE OF CONTENTS


[Functions] source/Particles/Particles_initPositions

[top][index]

NAME

    Particles_initPositions

SYNOPSIS

    Particles_initPositions( integer, INTENT(in) :: myPE,
                             logical, INTENT(inout) :: partPosInitialized,
                             logical, INTENT(out) :: updateRefine)

DESCRIPTION

    Initialize particle locations.  There are the versions currently
    available. 

      Lattice creates particles which are evenly distributed in space
      WithDensity creates particles distributed according to the global
         distribution of density.
      FromFile reads them in from a file

ARGUMENTS

  myPE : My processor ID

  partPosInitialized : boolean. Upon entry it is true if all particles have been
            successfully intialized, and there is no need for further
            action. Upon exit it has is true if it successfully initialized
            all the particles locally.
            The routine for configuring the initial AMR grid
            "gr_expandDomain" determines if all particles initialization
            was globally successful. 
            When AMR is not being used, or when refinement based upon
            Particles is turned off, this routine is called directly 
            from Driver_initFlash with partPosInitialized set to .false. so that
            particles are initialized. In such instances, the value
            at output has no meaning.          
 updateRefine : is true if the routine wished to retain the already
                initialized particles instead of reinitializing them
                as the grid refine.

PARAMETERS

    Each initialization version has parameters.  See the Config files