noneutralvelocity

Module

Description

$Id$

This module takes care of everything related to neutral velocity

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

MVAR CONTRIBUTION 0 MAUX CONTRIBUTION 0

PENCILS PROVIDED uun(3); divun; snij(3,3)

Quick access

Variables:

ampl_unx, ampl_uny, ampl_unz, ampluun, borderuun, cions_rhon, cneut_rho, colldrag, csn0, csn20, diffus_nun, electron_pressure, enum_borderuun, enum_iviscn, idiag_divunm, idiag_dtcn, idiag_dtnun, idiag_dtun, idiag_epskn, idiag_fricions, idiag_fricneut, idiag_neutralangmom, idiag_pndivunm, idiag_rnunxunymz, idiag_un2m, idiag_un2mphi, idiag_un2mr, idiag_un2mz, idiag_unm2, idiag_unmax, idiag_unmx, idiag_unmy, idiag_unmz, idiag_unp2m, idiag_unpmphi, idiag_unpmr, idiag_unr2m, idiag_unrmphi, idiag_unrmr, idiag_unrms, idiag_unrunpmr, idiag_unx2m, idiag_unx2mx, idiag_unx2my, idiag_unx2mz, idiag_unxm, idiag_unxmax, idiag_unxmx, idiag_unxmxy, idiag_unxmy, idiag_unxmz, idiag_unxpt, idiag_unxunym, idiag_unxunymx, idiag_unxunymy, idiag_unxunymz, idiag_unxunzm, idiag_unxunzmx, idiag_unxunzmy, idiag_unxunzmz, idiag_uny2m, idiag_uny2mx, idiag_uny2my, idiag_uny2mz, idiag_unym, idiag_unymax, idiag_unymx, idiag_unymxy, idiag_unymy, idiag_unymz, idiag_unypt, idiag_unyunzm, idiag_unyunzmx, idiag_unyunzmy, idiag_unyunzmz, idiag_unz2m, idiag_unz2mx, idiag_unz2my, idiag_unz2mz, idiag_unzm, idiag_unzmax, idiag_unzmphi, idiag_unzmr, idiag_unzmx, idiag_unzmxy, idiag_unzmy, idiag_unzmz, idiag_unzpt, idiag_unzrmaxs, idiag_unzrms, idiag_unzz2m, inituun, iviscn, kx_uun, ky_uun, kz_uun, ladvection_velocity, lcentrifugal_force, lelectron_pressure, lfreeze_unext, lfreeze_unint, lpressuregradient, lupw_uun, lviscneutral, nun, nun_hyper3, uun_const, uun_left, uun_right, widthuun

Routines:

calc_diagnostics_neutralvel(), calc_pencils_neutralvelocity(), calc_viscous_force_neutral(), duun_dt(), init_uun(), initialize_neutralvelocity(), pencil_criteria_neutralvelocity(), pencil_interdep_neutralvelocity(), read_neutralvelocity_init_pars(), read_neutralvelocity_run_pars(), register_neutralvelocity(), rprint_neutralvelocity(), set_border_neutralvelocity(), write_neutralvelocity_init_pars(), write_neutralvelocity_run_pars()

Needed modules

Variables

Subroutines and functions

subroutine  neutralvelocity/register_neutralvelocity()

Initialise variables which should know that we solve the hydro equations: iuu, etc; increase nvar accordingly.

18-mar-03/axel: dummy routine

Identify version number (generated automatically by SVN).

Called from:

register_modules()

Call to:

svn_id()

subroutine  neutralvelocity/initialize_neutralvelocity()

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

18-mar-03/axel: dummy routine

Called from:

register_modules(), initialize_modules()

subroutine  neutralvelocity/init_uun(f)

Initialise uun; called from start.f90.

18-mar-03/axel: dummy routine

Parameters:

f (,,*,*) [real,contiguous]

Called from:

start

subroutine  neutralvelocity/pencil_criteria_neutralvelocity()

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

20-11-04/anders: coded

Called from:

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

subroutine  neutralvelocity/pencil_interdep_neutralvelocity(lpencil_in)

Interdependency among pencils provided by the Neutralvelocity 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  neutralvelocity/calc_pencils_neutralvelocity(f, p)

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

13-nov-04/anders: coded

Parameters:

  • f (,,*,*) [real,in,contiguous]

  • p [pencil_case,in]

Called from:

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

subroutine  neutralvelocity/duun_dt(f, df, p)

Velocity evolution. Calculate dud/dt = - ud.gradud - 2Omega x ud + grav + Fvisc No pressure gradient force for neutral!

18-mar-03/axel: dummy routine

Parameters:

  • f (,,*,*) [real,contiguous]

  • df (,,*,*) [real,contiguous]

  • p [pencil_case]

Called from:

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

subroutine  neutralvelocity/calc_diagnostics_neutralvel(p)
Parameters:

p [pencil_case]

Called from:

pde(), write_diagnostics(), calc_all_module_diagnostic_auxiliaries()

subroutine  neutralvelocity/read_neutralvelocity_init_pars(iomsg)
Parameters:

iomsg [character,out]

subroutine  neutralvelocity/write_neutralvelocity_init_pars(unit)
Parameters:

unit [integer,in]

Called from:

get_datadir(), get_snapdir(), read_all_init_pars(), read_all_run_pars(), get_downpars()

subroutine  neutralvelocity/read_neutralvelocity_run_pars(iomsg)
Parameters:

iomsg [character,out]

subroutine  neutralvelocity/write_neutralvelocity_run_pars(unit)
Parameters:

unit [integer,in]

Called from:

get_datadir(), get_snapdir(), read_all_init_pars(), read_all_run_pars(), get_downpars()

subroutine  neutralvelocity/rprint_neutralvelocity(lreset[, lwrite])

Reads and registers print parameters relevant for neutral velocity.

3-may-02/axel: coded

27-may-02/axel: added possibility to reset list

Parameters:

  • lreset [logical]

  • lwrite [logical]

Called from:

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