Scrambler  1
ParticleInfoOps Module Reference

Module containing particle operations for info structures. More...

List of all members.

Public Member Functions

subroutine, public BondiAccretionRate (Particle, Info)
subroutine BondiAccretion (Info, Particle)

Private Member Functions

Auxilliary module routines
subroutine CalcMomentContributions (Info, Particle, mS, offset)
 Calculate contributions to particles moments for info structure from region defined by mS.
subroutine CalcGridParticleOverlaps (Info, Particle, mTs, nOverlaps, offsets, nGhost)
 Calculates overlaps between a grid and a particle.
LOGICAL function ParticleInGrid (Particle, Info, ipos)
 Determine if a particle is inside of a grid and return the index of the host cell.

Main Info Routines

subroutine, public SinkSetErrFlag (Info)
 Set err flags around sink particles.
subroutine, public CalcMoment (Particle, Info, lGhost)
 Calculates a grids contribution to the moments of Particle.
subroutine, public CheckForNewParticle (Info)
 Checks a grid for new particles.
subroutine, public DoAccretion (Info)
 Calculate accretion onto sink particles - including ghost regions - but don't accumulate contributions from ghost zones.
subroutine, public GetGasForce (Particle, Info)
 Calculates the gas force and it's first derivatives at the particles position using the gas potential within the grid.
subroutine SelfGravAccretion (Info, Particle)

Detailed Description

Module containing particle operations for info structures.

Definition at line 32 of file particle_info_ops.f90.


Member Function/Subroutine Documentation

subroutine, public SinkSetErrFlag ( TYPE(InfoDef)  Info)

Set err flags around sink particles.

Parameters:
InfoInfo structure

Definition at line 51 of file particle_info_ops.f90.

subroutine, public CalcMoment ( TYPE(ParticleDef)  Particle,
TYPE(InfoDef)  Info,
LOGICAL  lGhost 
)

Calculates a grids contribution to the moments of Particle.

Parameters:
ParticleParticle
InfoInfo structure
lGhostInclude contributions from ghost cells?

Definition at line 89 of file particle_info_ops.f90.

subroutine, public CheckForNewParticle ( TYPE(InfoDef)  Info)

Checks a grid for new particles.

Parameters:
InfoInfo structure

Definition at line 125 of file particle_info_ops.f90.

subroutine, public BondiAccretionRate ( TYPE(ParticleDef)  Particle,
TYPE(InfoDef)  Info 
)

Definition at line 295 of file particle_info_ops.f90.

subroutine, public DoAccretion ( TYPE(InfoDef)  Info)

Calculate accretion onto sink particles - including ghost regions - but don't accumulate contributions from ghost zones.

Parameters:
InfoInfo structure

Definition at line 346 of file particle_info_ops.f90.

subroutine SelfGravAccretion ( TYPE(InfoDef)  Info,
TYPE(ParticleDef), pointer  Particle 
) [private]

Definition at line 363 of file particle_info_ops.f90.

subroutine BondiAccretion ( TYPE(InfoDef)  Info,
TYPE(ParticleDef)  Particle 
)

Definition at line 516 of file particle_info_ops.f90.

subroutine, public GetGasForce ( TYPE(ParticleDef)  Particle,
TYPE(InfoDef)  Info 
)

Calculates the gas force and it's first derivatives at the particles position using the gas potential within the grid.

Need to populate Particlegas_accel(:) with (/Phi_x, Phi_y, Phi_z, Phi_xx, Phi_yy, Phi_zz, Phi_xy, Phi_yz, Phi_xz/) All evaluated at the Particle's position.

Parameters:
ParticleParticle to calculate potential of
InfoInfo structure containing particle (and gas potential)
iposIndex within Info of host cell

Definition at line 667 of file particle_info_ops.f90.

subroutine CalcMomentContributions ( TYPE(InfoDef)  Info,
TYPE(ParticleDef)  Particle,
INTEGER, dimension(3,2)  mS,
REAL(KIND=qpREC), dimension(3)  offset 
) [private]

Calculate contributions to particles moments for info structure from region defined by mS.

Parameters:
InfoInfo structure
ParticleParticle object
mSindex defining region

Definition at line 731 of file particle_info_ops.f90.

subroutine CalcGridParticleOverlaps ( TYPE(InfoDef)  Info,
TYPE(ParticleDef)  Particle,
INTEGER, dimension(:,:,:), pointer  mTs,
INTEGER  nOverlaps,
REAL(KIND=qPREC), dimension(:,:), pointer  offsets,
INTEGER, optional  nGhost 
) [private]

Calculates overlaps between a grid and a particle.

Parameters:
InfoInfo structure
ParticleParticle object
mTsArray of overlap indices
nOverlapsNumber of overlaps
nGhostnumber of ghost cells to include in overlap calculations

Definition at line 763 of file particle_info_ops.f90.

LOGICAL function ParticleInGrid ( Type(ParticleDef)  Particle,
TYPE(InfoDef)  Info,
INTEGER, dimension(:)  ipos 
) [private]

Determine if a particle is inside of a grid and return the index of the host cell.

Parameters:
ParticleParticle object
InfoInfo structure
iposindex of host cell

Definition at line 832 of file particle_info_ops.f90.


The documentation for this module was generated from the following file:
 All Classes Files Functions Variables