noselfgravity

Module

Description

$Id$

This module takes care of self gravity.

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

MVAR CONTRIBUTION 0 MAUX CONTRIBUTION 0

Quick access

Variables:

c, calc_cylgrav_stresses, gm1, gravitational_const, idiag_gpgzm, idiag_gpotself2m, idiag_gpotselfx2m, idiag_gpotselfxm, idiag_gpotselfy2m, idiag_gpotselfym, idiag_gpotselfz2m, idiag_gpotselfzm, idiag_grgpm, idiag_grgzm, idiag_gxgym, idiag_gxgzm, idiag_gygzm, idiag_jeanslength, idiag_ljeans2d, idiag_potself2m, idiag_potselfm, idiag_potselfmx, idiag_potselfmxy, idiag_potselfmy, idiag_potselfmz, idiag_qtoomre, idiag_qtoomremax, idiag_qtoomremin, idiag_rpotselfm, idiag_rugpotselfm, kappa_mn, lbryan_etal14, ljeans_stiffening, lselfgravity_dust, lselfgravity_gas, lselfgravity_neutrals, luse_g_newton, nj_stiff, rhs_poisson_const, stiff_gamma, tselfgrav_gentle, tstart_selfgrav

Routines:

addselfgrav(), calc_diagnostics_selfgrav(), calc_pencils_selfgravity(), calc_selfpotential(), initialize_selfgravity(), pencil_criteria_selfgravity(), pencil_interdep_selfgravity(), read_selfgravity_init_pars(), read_selfgravity_run_pars(), register_selfgravity(), rprint_selfgravity(), write_selfgravity_init_pars(), write_selfgravity_run_pars()

Needed modules

Variables

  • selfgravity/gravitational_const [real,private/optional/default=real(g_newton_cgs)]
  • selfgravity/rhs_poisson_const [real,private/optional/default=0.0]

Subroutines and functions

subroutine  selfgravity/register_selfgravity()

Register self gravity variables.

15-may-06/anders+jeff: dummy

Use :

sharedvariables (put_shared_variable())

subroutine  selfgravity/initialize_selfgravity(f)

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

15-may-06/anders+jeff: dummy

Parameters:

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

subroutine  selfgravity/pencil_criteria_selfgravity()

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

15-may-06/anders+jeff: dummy

subroutine  selfgravity/pencil_interdep_selfgravity(lpencil_in)

Interdependency among pencils from the Selfgravity module is specified here.

15-may-06/anders+jeff: dummy

Parameters:

lpencil_in (npencils) [logical]

subroutine  selfgravity/calc_pencils_selfgravity(f, p)

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

15-may-06/anders+jeff: dummy

Parameters:
subroutine  selfgravity/calc_selfpotential(f)

Calculate the potential of self gravity.

15-may-06/anders+jeff: dummy

Parameters:

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

subroutine  selfgravity/addselfgrav(df, p)

Add self gravity acceleration on gas.

15-may-06/anders+jeff: dummy

Parameters:

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

  • p [pencil_case]

subroutine  selfgravity/calc_diagnostics_selfgrav(p)
Parameters:

p [pencil_case]

subroutine  selfgravity/read_selfgravity_init_pars(iomsg)
Parameters:

iomsg [character,out]

Use :

file_io (parallel_unit())

subroutine  selfgravity/write_selfgravity_init_pars(unit)
Parameters:

unit [integer,in]

subroutine  selfgravity/read_selfgravity_run_pars(iomsg)
Parameters:

iomsg [character,out]

subroutine  selfgravity/write_selfgravity_run_pars(unit)
Parameters:

unit [integer,in]

subroutine  selfgravity/rprint_selfgravity(lreset[, lwrite])

Reads and registers print parameters relevant for gravity advance.

16-may-06/anders+jeff: dummy

Parameters:

  • lreset [logical]

  • lwrite [logical]