particles_mass_swarm

Module

Description

$Id$

This module handles the mass of super-particles.

** 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_mass = .true.

Quick access

Variables:

diffmult, dmpdt, dmpdt_save, dx__1, dy__1, dz__1, idiag_chrhopm, idiag_convm, idiag_dmpm, idiag_mpm, idiag_mpmax, idiag_mpmin, idiag_rhosurf, idmp, init_particle_mass, lbdry_test, lconstant_mass_w_chem, ldiffm, ldiffuse_backreac, lpart_mass_backreac, lpart_mass_momentum_backreac, mass_const, ndiffstepm, rdiffconstm

Routines:

dpmass_dt(), dpmass_dt_pencil(), init_particles_mass(), initialize_particles_mass(), pencil_criteria_par_mass(), read_particles_mass_init_pars(), read_particles_mass_run_pars(), register_particles_mass(), rprint_particles_mass(), write_particles_mass_init_pars(), write_particles_mass_run_pars()

Needed modules

Variables

  • particles_mass/idiag_mpm [integer,private/optional/default=0]

    DIAG_DOC: $overline{m_p}$

  • particles_mass/idiag_mpmax [integer,private/optional/default=0]

    DIAG_DOC: $max_j m_{p,j}$

  • particles_mass/idiag_mpmin [integer,private/optional/default=0]

    DIAG_DOC: $min_j m_{p,j}$

Subroutines and functions

subroutine  particles_mass/register_particles_mass()

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

18-jun-17/ccyang: coded

Called from:

particles_register_modules()

Call to:

svn_id(), append_npvar(), sum_par_name(), max_par_name()

subroutine  particles_mass/initialize_particles_mass(f)

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

18-jun-17/ccyang: dummy

Parameters:

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

Called from:

particles_register_modules(), particles_rprint_list(), particles_initialize_modules()

Call to:

sum_par_name(), max_par_name()

subroutine  particles_mass/init_particles_mass(f, fp)

Initialize particle mass.

18-jun-17/ccyang: coded

Parameters:
Called from:

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

Call to:

sum_par_name(), max_par_name()

subroutine  particles_mass/pencil_criteria_par_mass()

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

18-jun-17/ccyang: dummy

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

subroutine  particles_mass/dpmass_dt(f, df, fp, dfp, ineargrid)

Evolution of particle mass.

04-jul-17/ccyang: coded

Parameters:

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

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

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

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

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

Use :

particles_sub (sum_par_name(), max_par_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(), max_par_name()

subroutine  particles_mass/dpmass_dt_pencil(f, df, fp, dfp, p, ineargrid)

Evolution of particle mass in pencils.

04-jul-17/ccyang: dummy

Parameters:

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

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

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

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

  • p [pencil_case,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(), particles_pde(), particles_pde_pencil(), read_all_particles_init_pars(), read_all_particles_run_pars(), write_dim_particles(), write_snapshot_particles(), read_snapshot_particles()

subroutine  particles_mass/read_particles_mass_init_pars(iomsg)
Parameters:

iomsg [character,out]

subroutine  particles_mass/write_particles_mass_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_mass/read_particles_mass_run_pars(iomsg)
Parameters:

iomsg [character,out]

subroutine  particles_mass/write_particles_mass_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_mass/rprint_particles_mass(lreset[, lwrite])

Read and register print parameters relevant for particle mass.

04-jul-17/ccyang: coded

Parameters:

  • lreset [logical,in]

  • lwrite [logical,in,]

Use :

diagnostics

Called from:

particles_register_modules(), particles_rprint_list()