particles_number

Module

Description

$Id$

This module takes care of everything related to internal particle number.

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

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

MPVAR CONTRIBUTION 1 CPARAM logical, parameter :: lparticles_number=.true.

Quick access

Variables:

birthring_inner, birthring_outer, cdtpf, deltavp22_floor, depletion_rate, dt1_fragmentation, idiag_admom, idiag_dtfragp, idiag_dvp22mwnp, idiag_dvp22mwnp2, idiag_npsm, idiag_npswarmmax, idiag_npswarmmin, initnpswarm, lbirthring_depletion, lfragmentation_par, llog10_for_admom_above10, mmom, np_swarm0, np_swarm0_luck, rhop_swarm0, tstart_fragmentation_par, vthresh_coagulation

Routines:

calc_diagnostics_particles_num(), dnpswarm_dt(), dnpswarm_dt_pencil(), init_particles_number(), initialize_particles_number(), pencil_criteria_par_number(), read_particles_num_init_pars(), read_particles_num_run_pars(), register_particles_number(), rprint_particles_number(), set_particle_number(), write_particles_num_init_pars(), write_particles_num_run_pars()

Needed modules

Variables

  • particles_number/birthring_inner [real,private/optional/default=0.0]
  • particles_number/birthring_outer [real,private/optional/default=huge1]
  • particles_number/cdtpf [real,private/optional/default=0.2]
  • particles_number/deltavp22_floor [real,private/optional/default=0.0]
  • particles_number/depletion_rate [real,private/optional/default=0.0]
  • particles_number/dt1_fragmentation (nx) [real,private]
  • particles_number/idiag_admom (25) [integer,private/optional/default=0]
  • particles_number/idiag_dtfragp [integer,private/optional/default=0]
  • particles_number/idiag_dvp22mwnp [integer,private/optional/default=0]
  • particles_number/idiag_dvp22mwnp2 [integer,private/optional/default=0]
  • particles_number/idiag_npsm [integer,private/optional/default=0]
  • particles_number/idiag_npswarmm [integer,private/optional/default=0]
  • particles_number/idiag_npswarmmax [integer,private/optional/default=0]
  • particles_number/idiag_npswarmmin [integer,private/optional/default=0]
  • particles_number/initnpswarm (ninit) [character,private/optional/default='nothing']
  • particles_number/lbirthring_depletion [logical,private/optional/default=.false.]
  • particles_number/lfragmentation_par [logical,private/optional/default=.false.]
  • particles_number/llog10_for_admom_above10 [logical,private/optional/default=.true.]
  • particles_number/mmom [integer,private/parameter/optional/default=24]
  • particles_number/np_swarm0 [real,private/optional/default=1.0]
  • particles_number/np_swarm0_luck [real,private/optional/default=1.0]
  • particles_number/rhop_swarm0 [real,private/optional/default=1.0]
  • particles_number/tstart_fragmentation_par [real,private/optional/default=0.0]
  • particles_number/vthresh_coagulation [real,private/optional/default=0.0]

Subroutines and functions

subroutine  particles_number/register_particles_number()

Set up indices for access to the fp and dfp arrays.

24-nov-05/anders: adapted

Called from:

particles_register_modules()

Call to:

svn_id(), append_npvar(), not_implemented(), fatal_error(), set_particle_number(), sum_weighted_name(), calc_diagnostics_particles_num(), max_mn_name(), sum_par_name(), max_par_name(), integrate_par_name()

subroutine  particles_number/initialize_particles_number(f)

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

24-nov-05/anders: adapted

Parameters:

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

Called from:

particles_register_modules(), particles_rprint_list(), particles_initialize_modules()

Call to:

not_implemented(), fatal_error(), set_particle_number(), sum_weighted_name(), calc_diagnostics_particles_num(), max_mn_name(), sum_par_name(), max_par_name(), integrate_par_name()

subroutine  particles_number/init_particles_number(f, fp)

Initial internal particle number.

24-nov-05/anders: adapted

Parameters:
Called from:

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

Call to:

set_particle_number(), sum_weighted_name(), calc_diagnostics_particles_num(), max_mn_name(), sum_par_name(), max_par_name(), integrate_par_name()

subroutine  particles_number/set_particle_number(f, fp, npar_low, npar_high[, init])
Parameters:

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

  • fp (mpar_loc,mparray) [real]

  • npar_low [integer]

  • npar_high [integer]

  • init [logical]

Use :

general (loptest())

Called from:

register_particles_number(), initialize_particles_number(), init_particles_number()

Call to:

sum_weighted_name(), calc_diagnostics_particles_num(), max_mn_name(), sum_par_name(), max_par_name(), integrate_par_name()

subroutine  particles_number/pencil_criteria_par_number()

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

21-nov-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_weighted_name(), calc_diagnostics_particles_num(), max_mn_name(), sum_par_name(), max_par_name(), integrate_par_name()

subroutine  particles_number/dnpswarm_dt_pencil(f, df, fp, dfp, p, ineargrid)

Evolution of internal particle number.

24-oct-05/anders: coded

Parameters:

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

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

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

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

  • p [pencil_case]

  • ineargrid (mpar_loc,3) [integer]

Use :

diagnostics

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:

sum_weighted_name(), calc_diagnostics_particles_num(), max_mn_name(), sum_par_name(), max_par_name(), integrate_par_name()

subroutine  particles_number/calc_diagnostics_particles_num(p)
Parameters:

p [pencil_case]

Use :

diagnostics

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(), read_all_particles_init_pars(), read_all_particles_run_pars(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles(), register_particles_number(), initialize_particles_number(), init_particles_number(), set_particle_number(), pencil_criteria_par_number(), dnpswarm_dt_pencil()

Call to:

max_mn_name(), sum_par_name(), max_par_name(), integrate_par_name()

subroutine  particles_number/dnpswarm_dt(f, df, fp, dfp, ineargrid)

Evolution of internal particle number.

21-nov-06/anders: coded

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]

Use :

sub

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(), max_par_name(), integrate_par_name()

subroutine  particles_number/read_particles_num_init_pars(iomsg)
Parameters:

iomsg [character,out]

Use :

file_io (parallel_unit())

subroutine  particles_number/write_particles_num_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_number/read_particles_num_run_pars(iomsg)
Parameters:

iomsg [character,out]

Use :

file_io (parallel_unit())

subroutine  particles_number/write_particles_num_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()

subroutine  particles_number/rprint_particles_number(lreset[, lwrite])

Read and register print parameters relevant for internal particle number.

24-aug-05/anders: adapted

Parameters:

  • lreset [logical]

  • lwrite [logical]

Use :

diagnostics

Called from:

particles_register_modules(), particles_rprint_list()