noparticles_spin

Module

Description

$Id$

This module takes care of everything related to particle spin.

** 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_spin=.false.

Quick access

Variables:

amplsp, calc_magnus_liftforce, calc_saffman_liftforce, gaunoise_vect, idiag_psxm, idiag_psym, idiag_pszm, initsp, lmagnus_lift, lsaffman_lift, prepare_curl_vectorfield

Routines:

calc_liftforce(), dps_dt(), dps_dt_pencil(), init_particles_spin(), initialize_particles_spin(), pencil_criteria_par_spin(), read_particles_spin_init_pars(), read_particles_spin_run_pars(), register_particles_spin(), rprint_particles_spin(), write_particles_spin_init_pars(), write_particles_spin_run_pars()

Needed modules

Variables

  • particles_spin/prepare_curl_vectorfield [private]

Subroutines and functions

subroutine  particles_spin/register_particles_spin()

Set up indices for access to the fp and dfp arrays

23-jul-08/kapelrud: dummy

subroutine  particles_spin/initialize_particles_spin(f)

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

23-jul-08/kapelrud: coded

Parameters:

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

subroutine  particles_spin/init_particles_spin(f, fp)

Initial spin of particles.

21-jul-08/kapelrud: coded

Parameters:
subroutine  particles_spin/pencil_criteria_par_spin()

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

21-nov-06/anders: coded

subroutine  particles_spin/dps_dt_pencil(f, df, fp, dfp, p, ineargrid)

Evolution of particle spin.

22-aug-05/anders: 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,inout]

  • p [pencil_case]

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

subroutine  particles_spin/dps_dt(f, df, fp, dfp, ineargrid)

Evolution of particle spin.

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]

subroutine  particles_spin/read_particles_spin_init_pars(iomsg)
Parameters:

iomsg [character,out]

subroutine  particles_spin/write_particles_spin_init_pars(unit)
Parameters:

unit [integer,in]

subroutine  particles_spin/read_particles_spin_run_pars(iomsg)
Parameters:

iomsg [character,out]

subroutine  particles_spin/write_particles_spin_run_pars(unit)
Parameters:

unit [integer,in]

subroutine  particles_spin/rprint_particles_spin(lreset[, lwrite])

Read and register print parameters relevant for particles spin.

21-jul-08/kapelrud: adapted from particles_radius

Parameters:

  • lreset [logical]

  • lwrite [logical]

subroutine  particles_spin/calc_liftforce(fp, k, rep, liftforce)

22-jul-08/kapelrud: dummy coded

Parameters:

  • fp (mparray) [real,in]

  • k [integer,in]

  • rep [real,in]

  • liftforce (3) [real,out]