particles_stalker

Module

Description

$Id$

This module writes information about the local state of the gas at the positions of a selected number of particles.

** AUTOMATIC CPARAM.INC GENERATION ************************

Declare (for generation of cparam.inc) the number of f array variables and auxiliary variables added by this module

CPARAM logical, parameter :: lparticles_stalker=.true.

MSCRATCH CONTRIBUTION 1

---

Quick access

Variables:

ap, aps, bx, by, bz, drhodx, drhody, drhodz, dstalk, duxdx, duxdy, duxdz, duydx, duydy, duydz, duzdx, duzdy, duzdz, gttx, gtty, gttz, iscratch, linterpolate_cic, linterpolate_tsc, lstalk_ap, lstalk_aps, lstalk_bb, lstalk_grho, lstalk_gtt, lstalk_guu, lstalk_npswarm, lstalk_potself, lstalk_relvel, lstalk_rho, lstalk_rhopswarm, lstalk_sink_particles, lstalk_uu, lstalk_vv, lstalk_xx, nout, npswarm, nvar_stalk, potself, relvel, rhopswarm, stalk_gradient, stalk_magnetic, stalk_variable, tstalk, uz, vpx, vpy, vpz, zp

Routines:

finalize_particles_stalker(), initialize_particles_stalker(), particles_stalker_sub(), read_pstalker_init_pars(), read_pstalker_run_pars(), write_pstalker_init_pars(), write_pstalker_run_pars()

Needed modules

• cdata: $Id$

• messages: $Id$

• particles_cdata: $Id$

• particles_map: $Id$

• particles_mpicomm: $Id$

Variables

• particles_stalker/ap (*) [real,private/allocatable]

• particles_stalker/aps (*) [real,private/allocatable]

• particles_stalker/bx (*) [real,private/allocatable]

• particles_stalker/by (*) [real,private/allocatable]

• particles_stalker/bz (*) [real,private/allocatable]

• particles_stalker/drhodx (*) [real,private/allocatable]

• particles_stalker/drhody (*) [real,private/allocatable]

• particles_stalker/drhodz (*) [real,private/allocatable]

• particles_stalker/dstalk [real,private/optional/default=0.1]

  PAR_DOC: times between printout of stalker data

• particles_stalker/duxdx (*) [real,private/allocatable]

• particles_stalker/duxdy (*) [real,private/allocatable]

• particles_stalker/duxdz (*) [real,private/allocatable]

• particles_stalker/duydx (*) [real,private/allocatable]

• particles_stalker/duydy (*) [real,private/allocatable]

• particles_stalker/duydz (*) [real,private/allocatable]

• particles_stalker/duzdx (*) [real,private/allocatable]

• particles_stalker/duzdy (*) [real,private/allocatable]

• particles_stalker/duzdz (*) [real,private/allocatable]

• particles_stalker/gttx (*) [real,private/allocatable]

• particles_stalker/gtty (*) [real,private/allocatable]

• particles_stalker/gttz (*) [real,private/allocatable]

• particles_stalker/iscratch [integer,private/optional/default=0]

• particles_stalker/linterpolate_cic [logical,private/optional/default=.false.]

• particles_stalker/linterpolate_tsc [logical,private/optional/default=.true.]

• particles_stalker/lstalk_ap [logical,private/optional/default=.true.]

  PAR_DOC: particles diameter

• particles_stalker/lstalk_aps [logical,private/optional/default=.true.]

• particles_stalker/lstalk_bb [logical,private/optional/default=.true.]

  PAR_DOC: magnetic field at particles position

• particles_stalker/lstalk_grho [logical,private/optional/default=.false.]

  PAR_DOC: gas density gradient at particles position

• particles_stalker/lstalk_gtt [logical,private/optional/default=.false.]

• particles_stalker/lstalk_guu [logical,private/optional/default=.false.]

  PAR_DOC: gas velocity gradient at particles position

• particles_stalker/lstalk_npswarm [logical,private/optional/default=.false.]

• particles_stalker/lstalk_potself [logical,private/optional/default=.true.]

• particles_stalker/lstalk_relvel [logical,private/optional/default=.false.]

  PAR_DOC: particles relative velocity to gas

• particles_stalker/lstalk_rho [logical,private/optional/default=.true.]

  PAR_DOC: gas density at particles position

• particles_stalker/lstalk_rhopswarm [logical,private/optional/default=.true.]

• particles_stalker/lstalk_sink_particles [logical,private/optional/default=.false.]

• particles_stalker/lstalk_uu [logical,private/optional/default=.true.]

  PAR_DOC: gas velocity at particles position

• particles_stalker/lstalk_vv [logical,private/optional/default=.true.]

  PAR_DOC: particles velocity

• particles_stalker/lstalk_xx [logical,private/optional/default=.true.]

  PAR_DOC: particles position

• particles_stalker/nout [integer,private/optional/default=0]

• particles_stalker/npswarm (*) [real,private/allocatable]

• particles_stalker/nvar_stalk [integer,private/optional/default=0]

• particles_stalker/potself (*) [real,private/allocatable]

• particles_stalker/relvel (*) [real,private/allocatable]

• particles_stalker/rho (*) [real,private/allocatable]

• particles_stalker/rhopswarm (*) [real,private/allocatable]

• particles_stalker/stalk_gradient [private]

• particles_stalker/stalk_magnetic [private]

• particles_stalker/stalk_variable [private]

• particles_stalker/tstalk [real,private/optional/default=0.0]

• particles_stalker/ux (*) [real,private/allocatable]

• particles_stalker/uy (*) [real,private/allocatable]

• particles_stalker/uz (*) [real,private/allocatable]

• particles_stalker/vpx (*) [real,private/allocatable]

• particles_stalker/vpy (*) [real,private/allocatable]

• particles_stalker/vpz (*) [real,private/allocatable]

• particles_stalker/xp (*) [real,private/allocatable]

• particles_stalker/yp (*) [real,private/allocatable]

• particles_stalker/zp (*) [real,private/allocatable]

Subroutines and functions

subroutine  particles_stalker/initialize_particles_stalker(f)

Perform any post-parameter-read initialization i.e. calculate derived parameters.

13-nov-07/anders: coded

Parameters:

f (mx,my,mz,mfarray) [real]

Use :

general (keep_compiler_quiet()), farraymanager

Called from:

particles_register_modules(), particles_rprint_list(), particles_initialize_modules()

Call to:

fatal_error(), fatal_error_local(), fatal_error_local_collect(), output_stalker_init(), output_stalker(), output_part_finalize(), interpolate_linear(), interpolate_quadratic_spline(), bc_per_x(), bc_per_y(), bc_per_z()

subroutine  particles_stalker/finalize_particles_stalker()

Finalize module.

01-May-2019/PABourdin: coded

Called from:

particles_register_modules(), particles_rprint_list(), particles_initialize_modules(), particles_init(), particles_finalize()

Call to:

fatal_error_local(), fatal_error_local_collect(), output_stalker_init(), output_stalker(), output_part_finalize(), interpolate_linear(), interpolate_quadratic_spline(), bc_per_x(), bc_per_y(), bc_per_z()

subroutine  particles_stalker/particles_stalker_sub(f, fp, ineargrid)

Find local state of the gas at the position of a limited number of particles. This information is saved to a file and can be read in with IDL.

13-nov-07/anders: coded

Parameters:

• f (mx,my,mz,mfarray) [real]

• fp (mpar_loc,mparray) [real]

• ineargrid (mpar_loc,3) [integer]

Use :

io (output_stalker_init(), output_stalker(), output_part_finalize())

Called from:

particles_register_modules(), particles_rprint_list(), particles_initialize_modules(), particles_init(), particles_finalize(), particles_read_snapshot(), particles_write_snapshot(), particles_write_dsnapshot(), particles_write_pdim(), particles_write_block(), particles_write_rmv(), particles_timestep_first(), particles_timestep_second(), split_update_particles(), particles_load_balance(), particles_boundconds(), particles_pencil_criteria(), particles_pencil_interdep(), particles_calc_pencils(), particles_calc_selfpotential(), particles_before_boundary(), particles_special_bfre_bdary(), particles_special_after_dtsub(), particles_pde(), read_all_particles_init_pars(), read_all_particles_run_pars(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles()

Call to:

fatal_error_local(), fatal_error_local_collect(), output_stalker_init(), output_stalker(), output_part_finalize(), interpolate_linear(), interpolate_quadratic_spline(), bc_per_x(), bc_per_y(), bc_per_z()

subroutine  particles_stalker/read_pstalker_init_pars(iomsg)

Parameters:

iomsg [character,out]

Use :

file_io (parallel_unit())

subroutine  particles_stalker/write_pstalker_init_pars(unit)

Parameters:

unit [integer,in]

Called from:

particles_register_modules(), particles_rprint_list(), particles_initialize_modules(), particles_init(), particles_finalize(), particles_read_snapshot(), particles_write_snapshot(), particles_write_dsnapshot(), particles_write_pdim(), particles_write_block(), particles_write_rmv(), particles_timestep_first(), particles_timestep_second(), split_update_particles(), particles_load_balance(), particles_boundconds(), particles_pencil_criteria(), particles_pencil_interdep(), particles_calc_pencils(), particles_calc_selfpotential(), particles_before_boundary(), particles_special_bfre_bdary(), particles_special_after_dtsub(), particles_pde(), particles_pde_pencil(), particles_calc_pencil_diags(), particles_pde_blocks(), read_all_particles_init_pars(), write_all_particles_init_pars(), read_all_particles_run_pars(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles()

subroutine  particles_stalker/read_pstalker_run_pars(iomsg)

Parameters:

iomsg [character,out]

Use :

file_io (parallel_unit())

subroutine  particles_stalker/write_pstalker_run_pars(unit)

Parameters:

unit [integer,in]

Called from:

particles_register_modules(), particles_rprint_list(), particles_initialize_modules(), particles_init(), particles_finalize(), particles_read_snapshot(), particles_write_snapshot(), particles_write_dsnapshot(), particles_write_pdim(), particles_write_block(), particles_write_rmv(), particles_timestep_first(), particles_timestep_second(), split_update_particles(), particles_load_balance(), particles_boundconds(), particles_pencil_criteria(), particles_pencil_interdep(), particles_calc_pencils(), particles_calc_selfpotential(), particles_before_boundary(), particles_special_bfre_bdary(), particles_special_after_dtsub(), particles_pde(), particles_pde_pencil(), particles_calc_pencil_diags(), particles_pde_blocks(), read_all_particles_init_pars(), write_all_particles_init_pars(), read_all_particles_run_pars(), write_all_particles_run_pars(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles()