particles_tracers

Module

Description

$Id$

This module takes care of everything related to tracer 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=.true. CPARAM character (len=20), parameter :: particles_module=”tracer”

MAUX CONTRIBUTION 2 MPVAR CONTRIBUTION 3 MPAUX CONTRIBUTION 3

PENCILS PROVIDED np; rhop; epsp; rhop_swarm; grhop(3); peh


Quick access

Variables:

a1, a3, a_ell2, a_ellipsoid, amplvvp, amplxxp, ascalar_cic, ascalar_ngp, avg_n_insert, b_ell2, b_ellipsoid, beta_dpdr_dust, beta_dpdr_dust_scaled, beta_glnrho_global, birthring_lifetime, birthring_r, birthring_width, brownian_t0, c_ell2, c_ellipsoid, calc_added_mass_beta, calc_brownian_force, calc_brownian_force_li_ahmadi, calc_diagnostics_particles, calc_draglaw_parameters, calc_draglaw_purestokes, calc_draglaw_steadystate, calc_gas_velocity_shell_call, calc_pencil_rep, calc_relative_velocity, calc_stokes_cunningham, calc_thermophoretic_force, calculate_rms_speed, cdtp, cdtp_drag, cdtpgrav, coeff, coeff_restitution, collisional_cooling, compensate_friction_increase, compensate_sedimentation, cond_ratio, cone_half_angle_deg, constant_richardson, cs2_powerlaw, delta_vp0, deltauy_gas_friction, diffuse_backreaction, drag_heat, dt1_drag, dust_charge, eps1, epsp_friction_increase, frac_hill, frac_init_particles, g1, gaussian_x_frac, get_frictiontime, get_gas_density_strat, gravr, gravr_profile, gravsmooth, gravsmooth2, gravx, gravx_profile, gravz, gravz_profile, ibrtime, icondensationrate, idiag_decollp, idiag_dedragp, idiag_deshearbcsm, idiag_dtdragp, idiag_dvpm, idiag_dvpmax, idiag_dvpx2m, idiag_dvpy2m, idiag_dvpz2m, idiag_eccpx2m, idiag_eccpxm, idiag_eccpy2m, idiag_eccpym, idiag_eccpz2m, idiag_eccpzm, idiag_ekinp, idiag_epotpm, idiag_epsmax, idiag_epsmin, idiag_epspm, idiag_epspmax, idiag_epspmin, idiag_epspmx, idiag_epspmy, idiag_epspmz, idiag_ffcondm, idiag_ffcondnegm, idiag_ffcondposm, idiag_latentheatm, idiag_lpx2m, idiag_lpxm, idiag_lpy2m, idiag_lpym, idiag_lpz2m, idiag_lpzm, idiag_mpt, idiag_nblockmax, idiag_nblockmin, idiag_np2m, idiag_npar_found, idiag_nparbmax, idiag_npargone, idiag_nparmax, idiag_nparmin, idiag_nparpmax, idiag_nparsum, idiag_npm, idiag_npmax, idiag_npmin, idiag_npmx, idiag_npmxy, idiag_npmy, idiag_npmz, idiag_nptz, idiag_npuzmz, idiag_npvz2mz, idiag_npvzmz, idiag_omegapm, idiag_rhop2m, idiag_rhop2mx, idiag_rhop2my, idiag_rhop2mz, idiag_rhopart, idiag_rhopm, idiag_rhopmax, idiag_rhopmin, idiag_rhopmphi, idiag_rhopmr, idiag_rhopmx, idiag_rhopmxy, idiag_rhopmxz, idiag_rhopmy, idiag_rhopmz, idiag_rhoprms, idiag_rhopvpxm, idiag_rhopvpxt, idiag_rhopvpym, idiag_rhopvpysm, idiag_rhopvpyt, idiag_rhopvpzm, idiag_rhopvpzt, idiag_rp2m, idiag_rpm, idiag_rpvpx2mx, idiag_rpvpxmx, idiag_rpvpy2mx, idiag_rpvpymx, idiag_rpvpz2mx, idiag_rpvpzmx, idiag_shm, idiag_sigmap, idiag_tausupersatrms, idiag_urel, idiag_vpcoalx2m, idiag_vpcoaly2m, idiag_vpcoalz2m, idiag_vpmax, idiag_vprms, idiag_vpx2m, idiag_vpxm, idiag_vpxmax, idiag_vpxmin, idiag_vpxvpym, idiag_vpxvpzm, idiag_vpy2m, idiag_vpyfull2m, idiag_vpym, idiag_vpymax, idiag_vpymin, idiag_vpyvpzm, idiag_vpz2m, idiag_vpzm, idiag_vpzmax, idiag_vpzmin, idiag_vrelpabsm, idiag_xp2m, idiag_xpm, idiag_xpmax, idiag_xpmin, idiag_yp2m, idiag_ypm, idiag_ypmax, idiag_ypmin, idiag_zp2m, idiag_zpm, idiag_zpmax, idiag_zpmin, iffg, ifgx, ifgy, ifgz, indirect_inertial_particles, init_repeat, initvvp, initxxp, insert_nucleii, insertxxp, interp_default, interp_pol_bb, interp_pol_ee, interp_pol_gradtt, interp_pol_nu, interp_pol_oo, interp_pol_pp, interp_pol_rho, interp_pol_species, interp_pol_tt, interp_pol_uu, istep_dragf, istep_pass, it_insert_nuclei, iwatermixingratio, k_shell, kx_gg, kx_vpx, kx_vpy, kx_vpz, kx_vvp, kx_xxp, ky_vpx, ky_vpy, ky_vpz, ky_vvp, ky_xxp, kz_gg, kz_vpx, kz_vpy, kz_vpz, kz_vvp, kz_xxp, l_hole, l_shell, laccretion_removal, lbrownian_forces, lbrownian_forces_li_ahmadi, lbubble, lcalc_uup, lcdtp_shear, lcentrifugal_force_par, lcoldstart_amplitude_correction, lcollisional_cooling_rms, lcollisional_cooling_taucool, lcollisional_cooling_twobody, lcollisional_dragforce_cooling, lcollisional_heat, lcompensate_friction_increase, lcompensate_sedimentation, lcoriolis_force_par, lcylindrical_gravity_par, ldiff_dragf, ldiff_pass, ldiffuse_dragf, ldiffuse_passive, ldragforce_dust_par, ldragforce_equi_global_eps, ldragforce_equi_noback, ldragforce_gas_par, ldragforce_heat, ldragforce_radialonly, ldragforce_stiff, ldraglaw_eps_stk_transonic, ldraglaw_epstein, ldraglaw_epstein_stokes_linear, ldraglaw_epstein_transonic, ldraglaw_purestokes, ldraglaw_simple, ldraglaw_steadystate, ldraglaw_stokesschiller, ldraglaw_variable, ldraglaw_variable_density, ldt_adv_par, ldt_grav_par, learly_particle_map, lenforce_policy, lfollow_gas, lgaussian_birthring, lglobalrandom, linsert_as_many_as_possible, lleft_down, lnostore_uu, lnp_ap_as_aux, lnpmin_exclude_zero, lnu_draglaw, lnucl_dynamic, local_omega, lonly_eforce, lpar_spec, lparticle_gravity, lpeh_radius, lprecalc_cell_volumes, lquadratic_interpolation, lramp_mass, lreassign_strat_rhom, lsecondary_wait, lset_df_insert_nucleii, lshear_accel_par, lsherwood_const, lsimple_volume, lsinkpoint, lsmooth_gravity_companion, lstocunn1, lstokes_drag, ltau_coll_min_courant, lthermophoretic_forces, ltrace_dust, luse_tau_ap, lvector_gravity, lwithhold_init_particles, lx0, ly0, lz0, m_hole, max_particle_insert_time, mean_free_path_gas, n_hole, nray, ntau, nu_draglaw, nu_epicycle, nu_epicycle2, nucl_thr_inc_pow, nucleation_threshold, omega_disper, particle_gravity, particles_diffusion, particles_final_clean_up, particles_insert_ramp_time, particles_insert_rate, phase_vpx, phase_vpy, phase_vpz, pos_ellipsoid, pos_sphere, pscalar_sink_rate, qgaussz, r0gaussz, rad_sphere, rdiffconst_dragf, rdiffconst_pass, redfrac, remaining_particles, rhoa, ri0, rp1, rp1_smooth, rpbeta, rpbeta_species, rpinit_ext, rpinit_int, rsinkpoint, sphere_theta1, sphere_theta2, streaming, streaming_coldstart, t_ramp_mass, t_start_secondary, tau_coll1_max, tau_coll_min, taucool, taucool1, tausg1_max, tausg_min, tausp, tausp01, tausp1, temp_grad0, thermophoretic_eq, thermophoretic_t0, true_density_cond_spec, tstart_brownian_par, tstart_collisional_cooling, tstart_dragforce_par, tstart_grav_par, tstart_grav_r_par, tstart_grav_x_par, tstart_grav_z_par, tstart_insert_particles, tstart_liftforce_par, tstart_rpbeta, tstart_sink_par, urel_sum, vpx1, vpx2, vpx3, vpy1, vpy2, vpy3, vpz0, vpz1, vpz2, vpz3, xp0, xp1, xp2, xp3, xsinkpoint, yp0, yp1, yp2, yp3, ysinkpoint, zp0, zp1, zp2, zp3, zsinkpoint

Routines:

calc_diagnostics_particles(), calc_pencils_particles(), create_particles_sink_simple(), dvvp_dt(), dvvp_dt_blocks(), dvvp_dt_pencil(), dxxp_dt(), dxxp_dt_blocks(), dxxp_dt_pencil(), init_particles(), initialize_particles(), insert_lost_particles(), insert_nucleii(), insert_particles(), particles_diffusion(), particles_dragforce_stiff(), pencil_criteria_particles(), pencil_interdep_particles(), periodic_boundcond_on_aux(), powersnap_particles(), read_particles_init_pars(), read_particles_run_pars(), register_particles(), remove_particles_sink_simple(), rprint_particles(), write_particles_init_pars(), write_particles_run_pars()

Needed modules

Variables

  • particles/gravz_profile [character,private/optional/default='zero']
  • particles/idiag_epsmax [integer,private/optional/default=0]
  • particles/idiag_epsmin [integer,private/optional/default=0]
  • particles/idiag_epspmx [integer,private/optional/default=0]
  • particles/idiag_epspmz [integer,private/optional/default=0]
  • particles/idiag_nparmax [integer,private/optional/default=0]
  • particles/idiag_npmax [integer,private/optional/default=0]
  • particles/idiag_npmin [integer,private/optional/default=0]
  • particles/idiag_npmx [integer,private/optional/default=0]
  • particles/idiag_npmz [integer,private/optional/default=0]
  • particles/idiag_rhopmx [integer,private/optional/default=0]
  • particles/idiag_rhopmz [integer,private/optional/default=0]
  • particles/idiag_xp2m [integer,private/optional/default=0]
  • particles/idiag_xpm [integer,private/optional/default=0]
  • particles/idiag_yp2m [integer,private/optional/default=0]
  • particles/idiag_ypm [integer,private/optional/default=0]
  • particles/idiag_zp2m [integer,private/optional/default=0]
  • particles/idiag_zpm [integer,private/optional/default=0]
  • particles/initxxp (ninit) [character,private/optional/default='nothing']
  • particles/insertxxp (ninit) [character,private/optional/default='nothing']
  • particles/ldragforce_equi_global_eps [logical,private/optional/default=.false.]
  • particles/lglobalrandom [logical,private/optional/default=.false.]
  • particles/lquadratic_interpolation [logical,private/optional/default=.false.]
  • particles/ltrace_dust [logical,private/optional/default=.false.]
  • particles/max_particle_insert_time [real,private/optional/default=huge1]
  • particles/nu_epicycle [real,private/optional/default=0.0]
  • particles/nu_epicycle2 [real,private/optional/default=0.0]
  • particles/particles_final_clean_up [private]
  • particles/particles_insert_rate [real,private/optional/default=0.0]
  • particles/tausp [real,private/optional/default=0.0]
  • particles/xp0 [real,private/optional/default=0.0]
  • particles/yp0 [real,private/optional/default=0.0]
  • particles/zp0 [real,private/optional/default=0.0]

Subroutines and functions

subroutine  particles/register_particles()

Set up indices for access to the fp and dfp arrays

29-dec-04/anders: coded

Use :

farraymanager

Called from:

particles_register_modules()

Call to:

svn_id(), append_npvar(), append_npaux(), not_implemented(), fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn(), sum_par_name(), interpolate_quadratic_spline(), interpolate_linear(), calc_diagnostics_particles(), max_mn_name(), yzsum_mn_name_x(), xysum_mn_name_z()

subroutine  particles/initialize_particles(f, fp)

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

29-dec-04/anders: coded

Parameters:
Called from:

particles_register_modules(), particles_rprint_list(), particles_initialize_modules()

Call to:

not_implemented(), fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn(), sum_par_name(), interpolate_quadratic_spline(), interpolate_linear(), calc_diagnostics_particles(), max_mn_name(), yzsum_mn_name_x(), xysum_mn_name_z()

subroutine  particles/init_particles(f, fp, ineargrid)

Initial positions and velocities of tracer particles.

29-dec-04/anders: coded

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

  • fp (mpar_loc,mparray) [real,out]

  • ineargrid (mpar_loc,3) [integer]

Use :

equationofstate (cs20()), general (random_number_wrapper()), sharedvariables (get_shared_variable()), sub

Called from:

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

Call to:

not_implemented(), fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn(), sum_par_name(), interpolate_quadratic_spline(), interpolate_linear(), calc_diagnostics_particles(), max_mn_name(), yzsum_mn_name_x(), xysum_mn_name_z()

subroutine  particles/particles_dragforce_stiff(f, fp, ineargrid)

10-june-11/anders: dummy

Parameters:
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_calc_selfpotential(), particles_before_boundary(), read_all_particles_init_pars(), read_all_particles_run_pars(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles()

Call to:

sum_par_name(), interpolate_quadratic_spline(), interpolate_linear(), calc_diagnostics_particles(), max_mn_name(), yzsum_mn_name_x(), xysum_mn_name_z(), fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/pencil_criteria_particles()

All pencils that the Particles module depends on are specified here.

20-04-06/anders: coded

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_calc_selfpotential(), particles_before_boundary(), particles_special_bfre_bdary(), particles_special_after_dtsub(), read_all_particles_init_pars(), read_all_particles_run_pars(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles()

Call to:

sum_par_name(), interpolate_quadratic_spline(), interpolate_linear(), calc_diagnostics_particles(), max_mn_name(), yzsum_mn_name_x(), xysum_mn_name_z(), fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/pencil_interdep_particles(lpencil_in)

Interdependency among pencils provided by the Particles module is specified here.

15-feb-06/anders: coded

Parameters:

lpencil_in (npencils) [logical]

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_selfpotential(), particles_before_boundary(), particles_special_bfre_bdary(), particles_special_after_dtsub(), read_all_particles_init_pars(), read_all_particles_run_pars(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles()

Call to:

sum_par_name(), interpolate_quadratic_spline(), interpolate_linear(), calc_diagnostics_particles(), max_mn_name(), yzsum_mn_name_x(), xysum_mn_name_z(), fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/calc_pencils_particles(f, p, fp, ineargrid)

Calculate particle pencils.

15-feb-06/anders: coded

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

  • p [pencil_case]

  • fp (mpar_loc,mparray) [real,in]

  • ineargrid (mpar_loc,3) [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(), read_all_particles_init_pars(), read_all_particles_run_pars(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles()

Call to:

sum_par_name(), interpolate_quadratic_spline(), interpolate_linear(), calc_diagnostics_particles(), max_mn_name(), yzsum_mn_name_x(), xysum_mn_name_z(), fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/dxxp_dt(f, df, fp, dfp, ineargrid)

Evolution of tracer particle position.

02-jan-05/anders: coded

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

  • df (mx,my,mz,mvar) [real,inout]

  • fp (mpar_loc,mparray) [real,in]

  • dfp (mpar_loc,mpvar) [real,inout]

  • ineargrid (mpar_loc,3) [integer,in]

Use :

diagnostics (max_name())

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:

sum_par_name(), interpolate_quadratic_spline(), interpolate_linear(), calc_diagnostics_particles(), max_mn_name(), yzsum_mn_name_x(), xysum_mn_name_z(), fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/dvvp_dt(f, df, fp, dfp, ineargrid)

Evolution of dust particle velocity.

22-aug-05/anders: dummy

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

  • df (mx,my,mz,mvar) [real]

  • fp (mpar_loc,mparray) [real]

  • dfp (mpar_loc,mpvar) [real]

  • ineargrid (mpar_loc,3) [integer]

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:

interpolate_quadratic_spline(), interpolate_linear(), calc_diagnostics_particles(), max_mn_name(), yzsum_mn_name_x(), xysum_mn_name_z(), fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/dxxp_dt_pencil(f, df, fp, dfp, p, ineargrid)

Evolution of tracer particle position (called from main pencil loop).

25-apr-06/anders: coded

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

  • df (mx,my,mz,mvar) [real,inout]

  • fp (mpar_loc,mparray) [real,inout]

  • dfp (mpar_loc,mpvar) [real,inout]

  • p [pencil_case]

  • ineargrid (mpar_loc,3) [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(), read_all_particles_init_pars(), read_all_particles_run_pars(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles()

Call to:

interpolate_quadratic_spline(), interpolate_linear(), calc_diagnostics_particles(), max_mn_name(), yzsum_mn_name_x(), xysum_mn_name_z(), fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/calc_diagnostics_particles(fp, p, ineargrid)
Parameters:
  • fp (mpar_loc,mparray) [real]

  • p [pencil_case]

  • ineargrid (mpar_loc,3) [integer]

Use :

diagnostics

Called from:

register_particles(), initialize_particles(), init_particles(), particles_dragforce_stiff(), pencil_criteria_particles(), pencil_interdep_particles(), calc_pencils_particles(), dxxp_dt(), dvvp_dt(), dxxp_dt_pencil(), 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(), read_all_particles_init_pars(), read_all_particles_run_pars(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles()

Call to:

max_mn_name(), yzsum_mn_name_x(), xysum_mn_name_z(), fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/dvvp_dt_pencil(f, df, fp, dfp, p, ineargrid)

Evolution of dust particle velocity (called from main pencil loop).

20-apr-06/anders: dummy

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

  • df (mx,my,mz,mvar) [real]

  • fp (mpar_loc,mparray) [real]

  • dfp (mpar_loc,mpvar) [real]

  • p [pencil_case]

  • ineargrid (mpar_loc,3) [integer]

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(), read_all_particles_init_pars(), read_all_particles_run_pars(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles()

Call to:

fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/dxxp_dt_blocks(f, df, fp, dfp, ineargrid)

Evolution of particle position in blocks.

29-nov-09/anders: dummy

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

  • df (mx,my,mz,mvar) [real]

  • fp (mpar_loc,mparray) [real]

  • dfp (mpar_loc,mpvar) [real]

  • ineargrid (mpar_loc,3) [integer]

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(), read_all_particles_run_pars(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles()

Call to:

fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/dvvp_dt_blocks(f, df, fp, dfp, ineargrid)

Evolution of particle velocity in blocks.

29-nov-09/anders: dummy

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

  • df (mx,my,mz,mvar) [real]

  • fp (mpar_loc,mparray) [real]

  • dfp (mpar_loc,mpvar) [real]

  • ineargrid (mpar_loc,3) [integer]

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(), read_all_particles_run_pars(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles()

Call to:

fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/remove_particles_sink_simple(f, fp, dfp, ineargrid)
Parameters:
  • f (mx,my,mz,mfarray) [real]

  • fp (mpar_loc,mparray) [real]

  • dfp (mpar_loc,mpvar) [real]

  • ineargrid (mpar_loc,3) [integer]

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(), read_all_particles_init_pars(), read_all_particles_run_pars(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles()

Call to:

fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/create_particles_sink_simple(f, fp, dfp, ineargrid)
Parameters:
  • f (mx,my,mz,mfarray) [real]

  • fp (mpar_loc,mparray) [real]

  • dfp (mpar_loc,mpvar) [real]

  • ineargrid (mpar_loc,3) [integer]

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(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/read_particles_init_pars(iomsg)
Parameters:

iomsg [character,out]

Use :

file_io (parallel_unit())

Call to:

fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/write_particles_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()

Call to:

fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/read_particles_run_pars(iomsg)
Parameters:

iomsg [character,out]

Use :

file_io (parallel_unit())

Call to:

fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/write_particles_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()

Call to:

fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/powersnap_particles(f)

Calculate power spectra of particle variables.

01-jan-06/anders: dummy

Parameters:

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

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(), particles_powersnap(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles()

Call to:

fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/insert_lost_particles(f, fp, ineargrid)

14-oct-12/dhruba: dummy

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

  • fp (mpar_loc,mparray) [real,inout]

  • ineargrid (mpar_loc,3) [integer,inout]

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(), particles_powersnap(), get_slices_particles(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles()

Call to:

fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/insert_particles(f, fp, ineargrid)

Insert particles continuously (when linsert_particles_continuously == T), i.e. in each timestep. If number of particles to be inserted are less than unity, accumulate number over several timesteps until the integer value is larger than one. Keep the remainder and accumulate this to the next insert.

Works only for particles_dust - add neccessary variable declarations in particles_tracers to make it work here.

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

  • fp (mpar_loc,mparray) [real,inout]

  • ineargrid (mpar_loc,3) [integer,inout]

Use :

general (random_number_wrapper())

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(), particles_powersnap(), get_slices_particles(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles(), particles_stochastic()

Call to:

fatal_error(), boundconds_particles(), map_nearest_grid(), map_xxp_grid(), sort_particles_imn()

subroutine  particles/insert_nucleii(f, fp, ineargrid, df)
Parameters:
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(), particles_powersnap(), get_slices_particles(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles(), particles_stochastic()

subroutine  particles/particles_diffusion(fp)

17-nov-25/wlyra: dummy

Parameters:

fp (mpar_loc,mparray) [real,inout]

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(), read_all_particles_init_pars(), read_all_particles_run_pars(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles()

subroutine  particles/rprint_particles(lreset[, lwrite])

Read and register print parameters relevant for particles

29-dec-04/anders: coded

Parameters:
  • lreset [logical]

  • lwrite [logical]

Use :

diagnostics (parse_name())

Called from:

particles_register_modules(), particles_rprint_list()