nocosmicray

Module

Description

$Id$

This modules solves the passive scalar advection equation

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

MVAR CONTRIBUTION 0 MAUX CONTRIBUTION 0

Quick access

Variables:: ampl_qcr, ampl_qcr2, amplecr, amplecr2, blimiter_cr, cosmicray_diff, ecr_const, ecr_floor, ecr_floor_log, ecr_min, epsilon_ecr, gammacr, gammacr1, idiag_ecrdivum, idiag_ecrm, idiag_ecrmax, idiag_ecrmin, idiag_ecrmz, idiag_ecrph1mz, idiag_ecrph2mz, idiag_ecrph3mz, idiag_ecrpt, idiag_kmax, initecr, initecr2, jcr_param, kx_ecr, ky_ecr, kz_ecr, lalfven_advect, lcheck_negative_ecr, limiter_cr, lnegl, lupw_ecr, luse_diff_constants, lvariable_tensor_diff, radius_ecr, simplified_cosmicray_tensor, widthecr, x_pos_cr, x_pos_cr2, y_pos_cr, y_pos_cr2, z_pos_cr, z_pos_cr2
Routines:: calc_diagnostics_cosmicray(), calc_pencils_cosmicray(), decr_dt(), get_slices_cosmicray(), impose_ecr_floor(), init_ecr(), initialize_cosmicray(), pencil_criteria_cosmicray(), pencil_interdep_cosmicray(), read_cosmicray_init_pars(), read_cosmicray_run_pars(), register_cosmicray(), rprint_cosmicray(), write_cosmicray_init_pars(), write_cosmicray_run_pars()

Needed modules

cdata: $Id$
general (keep_compiler_quiet()): $Id$

Variables

Subroutines and functions

subroutine cosmicray/register_cosmicray()

Initialise variables which should know that we solve for active scalar: iecr - the cosmic ray energy density; increase nvar accordingly

09-oct-03/tony: coded

Identify version number.

Use :: messages
Called from:: register_modules()
Call to:: svn_id()

subroutine cosmicray/initialize_cosmicray(f)

Perform any necessary post-parameter read initialization Dummy routine

09-oct-03/tony: coded

Parameters:: f (mx,my,mz,mfarray) [real]
Called from:: register_modules(), initialize_modules()

subroutine cosmicray/read_cosmicray_init_pars(iomsg)

Parameters:: iomsg [character,out]

subroutine cosmicray/write_cosmicray_init_pars(unit)

Parameters:: unit [integer,in]
Called from:: get_datadir(), get_snapdir(), read_all_init_pars(), read_all_run_pars(), get_downpars()

subroutine cosmicray/read_cosmicray_run_pars(iomsg)

Parameters:: iomsg [character,out]

subroutine cosmicray/write_cosmicray_run_pars(unit)

Parameters:: unit [integer,in]
Called from:: get_datadir(), get_snapdir(), read_all_init_pars(), read_all_run_pars(), get_downpars()

subroutine cosmicray/init_ecr(f)

initialise magnetic field; called from start.f90 We have an init parameter (initlncc) to stear magnetic i.c. independently.

6-jul-02/axel: coded

Parameters:: f (mx,my,mz,mfarray) [real]
Called from:: start

subroutine cosmicray/pencil_criteria_cosmicray()

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

20-11-04/anders: coded

Called from:: register_modules(), initialize_modules(), finalize_modules(), choose_pencils()

subroutine cosmicray/pencil_interdep_cosmicray(lpencil_in)

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

20-11-04/anders: coded

Parameters:: lpencil_in (npencils) [logical]
Called from:: register_modules(), initialize_modules(), finalize_modules(), choose_pencils()

subroutine cosmicray/calc_pencils_cosmicray(f, p)

Calculate Cosmicray pencils. Most basic pencils should come first, as others may depend on them.

20-11-04/anders: coded

Parameters:

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

Called from:

pde(), write_diagnostics(), calc_all_module_diagnostic_auxiliaries(), perform_diagnostics(), finalize_diagnostics()

subroutine cosmicray/decr_dt(f, df, p)

Cosmic ray density evolution.

09-oct-03/tony: coded

Parameters:

f (mx,my,mz,mfarray) [real,in]
df (mx,my,mz,mvar) [real,in]
p [pencil_case,in]

Called from:

pde(), write_diagnostics(), calc_all_module_diagnostic_auxiliaries(), perform_diagnostics(), finalize_diagnostics()

subroutine cosmicray/calc_diagnostics_cosmicray(p)

Parameters:: p [pencil_case]
Called from:: pde(), write_diagnostics(), calc_all_module_diagnostic_auxiliaries()

subroutine cosmicray/rprint_cosmicray(lreset[, lwrite])

Reads and registers print parameters relevant for cosmic rays.

09-oct-03/tony: coded

Parameters:

lreset [logical]
lwrite [logical]

Called from:

register_modules(), initialize_modules(), finalize_modules(), choose_pencils(), rprint_list()

subroutine cosmicray/get_slices_cosmicray(f, slices)

Parameters:

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

Called from:

wvid_prepare(), wvid()

subroutine cosmicray/impose_ecr_floor(f)

Parameters:: f (mx,my,mz,mfarray) [real,in]
Called from:: pde(), write_diagnostics(), calc_all_module_diagnostic_auxiliaries(), perform_diagnostics(), finalize_diagnostics(), debug_imn_arrays(), impose_floors_ceilings()