nolorenz_gauge

Module

Description

$Id$

Lorenz gauge, dphi/dt = -cphi2*divA

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

MVAR CONTRIBUTION 0 MAUX CONTRIBUTION 0

Quick access

Variables:: ladvect_phi
Routines:: calc_diagnostics_lorenz_gauge(), calc_pencils_lorenz_gauge(), dlorenz_gauge_dt(), get_slices_lorenz_gauge(), init_lorenz_gauge(), initialize_lorenz_gauge(), pencil_criteria_lorenz_gauge(), pencil_interdep_lorenz_gauge(), read_lorenz_gauge_init_pars(), read_lorenz_gauge_run_pars(), register_lorenz_gauge(), rprint_lorenz_gauge(), write_lorenz_gauge_init_pars(), write_lorenz_gauge_run_pars()

Needed modules

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

Variables

Subroutines and functions

subroutine lorenz_gauge/register_lorenz_gauge()

Configure pre-initialised (i.e. before parameter read) variables which should be know to be able to evaluate

6-oct-03/tony: coded

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

subroutine lorenz_gauge/initialize_lorenz_gauge(f)

called by run.f90 after reading parameters, but before the time loop

06-oct-03/tony: coded

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

subroutine lorenz_gauge/init_lorenz_gauge(f)

initialise lorenz_gauge condition; called from start.f90 06-oct-2003/tony: coded

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

subroutine lorenz_gauge/pencil_criteria_lorenz_gauge()

All pencils that this lorenz_gauge module depends on are specified here.

25-feb-07/axel: adapted

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

subroutine lorenz_gauge/pencil_interdep_lorenz_gauge(lpencil_in)

Interdependency among pencils provided by this module are specified here.

18-07-06/tony: coded

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

subroutine lorenz_gauge/calc_pencils_lorenz_gauge(f, p)

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

24-nov-04/tony: coded

Parameters:

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

Called from:

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

subroutine lorenz_gauge/dlorenz_gauge_dt(f, df, p)

calculate right hand side of ONE OR MORE extra coupled PDEs along the ‘current’ Pencil, i.e. f(l1:l2,m,n) where m,n are global variables looped over in equ.f90

Due to the multi-step Runge Kutta timestepping used one MUST always add to the present contents of the df array. NEVER reset it to zero.

several precalculated Pencils of information are passed if for efficiency.

06-oct-03/tony: coded

Parameters: