testscalar_axisym

Module

Description

$Id$

This modules deals with testscalar fields for axisymmetric turbulence testscalar fields are invoked, a corresponding replacement dummy routine is used instead which absorbs all the calls to the testscalar relevant subroutines listed in here.

** 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 :: ltestscalar = .true. CPARAM logical, parameter :: ltestfield_z = .true. CPARAM logical, parameter :: ltestfield_xy = .false. CPARAM logical, parameter :: ltestfield_xz = .false.

MVAR CONTRIBUTION 2 MAUX CONTRIBUTION 2

Quick access

Variables:: amplcctest, camp, camp1, ccc, dccinit, delta_testscalar, delta_testscalar_next, idiag_c1pt, idiag_c1rms, idiag_c2pt, idiag_c2rms, idiag_c3pt, idiag_c3rms, idiag_c4pt, idiag_c4rms, idiag_c5pt, idiag_c5rms, idiag_c6pt, idiag_c6rms, idiag_f11z, idiag_f12z, idiag_f21z, idiag_f22z, idiag_f31z, idiag_f32z, idiag_gam11, idiag_gam11z, idiag_gam12, idiag_gam12z, idiag_gam13, idiag_gam13z, idiag_gam21, idiag_gam21z, idiag_gam22, idiag_gam22z, idiag_gam23, idiag_gam23z, idiag_gam31, idiag_gam31z, idiag_gam32, idiag_gam32z, idiag_gam33, idiag_gam33z, idiag_gam3z, idiag_gamc, idiag_gamcz, idiag_kap11, idiag_kap11z, idiag_kap12, idiag_kap12z, idiag_kap13, idiag_kap13z, idiag_kap21, idiag_kap21z, idiag_kap22, idiag_kap22z, idiag_kap23, idiag_kap23z, idiag_kap31, idiag_kap31z, idiag_kap32, idiag_kap32z, idiag_kap33, idiag_kap33z, idiag_kapcpara, idiag_kapcparaz, idiag_kapcperp1, idiag_kapcperp2, idiag_kapcperpz, idiag_mgam33, idiag_mkap33, idiag_muc1, idiag_muc2, idiag_mucz, idiag_ngam33, idiag_nkap33, initcctest, itestscalar, jtestx1, jtestx2, jtesty1, jtesty2, jtestz1, jtestz2, kappatest, kappatest1, ktestscalar, ktestscalar1, kx1, kx_cctest, kxtestscalar, kxtestscalar1, ky_cctest, kytestscalar, kytestscalar1, kz_cctest, lam_testscalar, lignore_ugtestm, linit_cctest, lset_cctest2, lsoca_ug, ltestscalar_newx, ltestscalar_newy, ltestscalar_newz, ltestscalar_per_unitvolume, ltestscalar_ugc, lug_as_aux, mtestscalar, nccinit, om_testscalar, phasex_cctest, phasez_cctest, reinitialize_cctest, rescale_cctest, set_ggtest_g1_g2, set_ggtest_g1_g2_const, tccinit, tccinit_previous, testscalar_zaver_range, ugtestm, ugtestmx, ugtestmy, zmask
Routines:: dcctest_dt(), get_slices_testscalar(), init_cctest(), initialize_testscalar(), pencil_criteria_testscalar(), pencil_interdep_testscalar(), read_testscalar_init_pars(), read_testscalar_run_pars(), register_testscalar(), rescaling_testscalar(), rprint_testscalar(), testscalar_after_boundary(), write_testscalar_init_pars(), write_testscalar_run_pars()

Needed modules

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

Variables

testscalar/amplcctest (ninit) [real,private/optional/default=0.]
testscalar/camp [real,private/optional/default=1.0]
testscalar/camp1 [real,private/optional/default=1.0]
testscalar/ccc (nx) [real,private]
testscalar/cx (nx) [real,private]
testscalar/cy (my) [real,private]
testscalar/cz (mz) [real,private]
testscalar/dccinit [real,private/optional/default=0.0]
testscalar/delta_testscalar [real,private/optional/default=0.0]
testscalar/delta_testscalar_next [real,private/optional/default=0.0]
testscalar/idiag_c1pt [integer,private/optional/default=0]
testscalar/idiag_c1rms [integer,private/optional/default=0]
testscalar/idiag_c2pt [integer,private/optional/default=0]
testscalar/idiag_c2rms [integer,private/optional/default=0]
testscalar/idiag_c3pt [integer,private/optional/default=0]
testscalar/idiag_c3rms [integer,private/optional/default=0]
testscalar/idiag_c4pt [integer,private/optional/default=0]
testscalar/idiag_c4rms [integer,private/optional/default=0]
testscalar/idiag_c5pt [integer,private/optional/default=0]
testscalar/idiag_c5rms [integer,private/optional/default=0]
testscalar/idiag_c6pt [integer,private/optional/default=0]
testscalar/idiag_c6rms [integer,private/optional/default=0]
testscalar/idiag_f11z [integer,private/optional/default=0]
testscalar/idiag_f12z [integer,private/optional/default=0]
testscalar/idiag_f21z [integer,private/optional/default=0]
testscalar/idiag_f22z [integer,private/optional/default=0]
testscalar/idiag_f31z [integer,private/optional/default=0]
testscalar/idiag_f32z [integer,private/optional/default=0]
testscalar/idiag_gam11 [integer,private/optional/default=0]
testscalar/idiag_gam11z [integer,private/optional/default=0]
testscalar/idiag_gam12 [integer,private/optional/default=0]
testscalar/idiag_gam12z [integer,private/optional/default=0]
testscalar/idiag_gam13 [integer,private/optional/default=0]
testscalar/idiag_gam13z [integer,private/optional/default=0]
testscalar/idiag_gam21 [integer,private/optional/default=0]
testscalar/idiag_gam21z [integer,private/optional/default=0]
testscalar/idiag_gam22 [integer,private/optional/default=0]
testscalar/idiag_gam22z [integer,private/optional/default=0]
testscalar/idiag_gam23 [integer,private/optional/default=0]
testscalar/idiag_gam23z [integer,private/optional/default=0]
testscalar/idiag_gam31 [integer,private/optional/default=0]
testscalar/idiag_gam31z [integer,private/optional/default=0]
testscalar/idiag_gam32 [integer,private/optional/default=0]
testscalar/idiag_gam32z [integer,private/optional/default=0]
testscalar/idiag_gam33 [integer,private/optional/default=0]
testscalar/idiag_gam33z [integer,private/optional/default=0]
testscalar/idiag_gam3z [integer,private/optional/default=0]
testscalar/idiag_gamc [integer,private/optional/default=0]
testscalar/idiag_gamcz [integer,private/optional/default=0]
testscalar/idiag_kap11 [integer,private/optional/default=0]
testscalar/idiag_kap11z [integer,private/optional/default=0]
testscalar/idiag_kap12 [integer,private/optional/default=0]
testscalar/idiag_kap12z [integer,private/optional/default=0]
testscalar/idiag_kap13 [integer,private/optional/default=0]
testscalar/idiag_kap13z [integer,private/optional/default=0]
testscalar/idiag_kap21 [integer,private/optional/default=0]
testscalar/idiag_kap21z [integer,private/optional/default=0]
testscalar/idiag_kap22 [integer,private/optional/default=0]
testscalar/idiag_kap22z [integer,private/optional/default=0]
testscalar/idiag_kap23 [integer,private/optional/default=0]
testscalar/idiag_kap23z [integer,private/optional/default=0]
testscalar/idiag_kap31 [integer,private/optional/default=0]
testscalar/idiag_kap31z [integer,private/optional/default=0]
testscalar/idiag_kap32 [integer,private/optional/default=0]
testscalar/idiag_kap32z [integer,private/optional/default=0]
testscalar/idiag_kap33 [integer,private/optional/default=0]
testscalar/idiag_kap33z [integer,private/optional/default=0]
testscalar/idiag_kapcpara [integer,private/optional/default=0]
testscalar/idiag_kapcparaz [integer,private/optional/default=0]
testscalar/idiag_kapcperp1 [integer,private/optional/default=0]
testscalar/idiag_kapcperp2 [integer,private/optional/default=0]
testscalar/idiag_kapcperpz [integer,private/optional/default=0]
testscalar/idiag_mgam33 [integer,private/optional/default=0]
testscalar/idiag_mkap33 [integer,private/optional/default=0]
testscalar/idiag_muc1 [integer,private/optional/default=0]
testscalar/idiag_muc2 [integer,private/optional/default=0]
testscalar/idiag_mucz [integer,private/optional/default=0]
testscalar/idiag_ngam33 [integer,private/optional/default=0]
testscalar/idiag_nkap33 [integer,private/optional/default=0]
testscalar/initcctest (ninit) [character,private/optional/default='nothing']
testscalar/itestscalar [character,private/optional/default='g1-g2']
testscalar/jtestx1 [integer,private/parameter/optional/default=3]
testscalar/jtestx2 [integer,private/parameter/optional/default=4]
testscalar/jtesty1 [integer,private/parameter/optional/default=5]
testscalar/jtesty2 [integer,private/parameter/optional/default=6]
testscalar/jtestz1 [integer,private/parameter/optional/default=1]
testscalar/jtestz2 [integer,private/parameter/optional/default=2]
testscalar/kappatest [real,private/optional/default=0.0]
testscalar/kappatest1 [real,private/optional/default=0.0]
testscalar/ktestscalar [real,private/optional/default=1.0]
testscalar/ktestscalar1 [real,private/optional/default=1.0]
testscalar/kx1 [real,private]
testscalar/kx_cctest (ninit) [real,private/optional/default=1.]
testscalar/kxtestscalar [real,private/optional/default=1.0]
testscalar/kxtestscalar1 [real,private/optional/default=1.0]
testscalar/ky1 [real,private]
testscalar/ky_cctest (ninit) [real,private/optional/default=1.]
testscalar/kytestscalar [real,private/optional/default=1.0]
testscalar/kytestscalar1 [real,private/optional/default=1.0]
testscalar/kz1 [real,private]
testscalar/kz_cctest (ninit) [real,private/optional/default=1.]
testscalar/lam_testscalar [real,private/optional/default=0.0]
testscalar/lignore_ugtestm [logical,private/optional/default=.false.]
testscalar/linit_cctest [logical,private/optional/default=.false.]
testscalar/lset_cctest2 [logical,private/optional/default=.false.]
testscalar/lsoca_ug [logical,private/optional/default=.false.]
testscalar/ltestscalar_newx [logical,private/optional/default=.false.]
testscalar/ltestscalar_newy [logical,private/optional/default=.false.]
testscalar/ltestscalar_newz [logical,private/optional/default=.true.]
testscalar/ltestscalar_per_unitvolume [logical,private/optional/default=.false.]
testscalar/ltestscalar_ugc [logical,private/optional/default=.false.]
testscalar/lug_as_aux [logical,private/optional/default=.false.]
testscalar/mtestscalar [integer,private/parameter/optional/default=njtestscalar]
testscalar/nccinit [integer,private]
testscalar/om_testscalar [real,private/optional/default=0.0]
testscalar/phasex_cctest (ninit) [real,private/optional/default=0.]
testscalar/phasez_cctest (ninit) [real,private/optional/default=0.]
testscalar/reinitialize_cctest [logical,private/optional/default=.false.]
testscalar/rescale_cctest (njtestscalar) [real,private/optional/default=0.]
testscalar/set_ggtest_g1_g2 [private]
testscalar/set_ggtest_g1_g2_const [private]
testscalar/sx (nx) [real,private]
testscalar/sy (my) [real,private]
testscalar/sz (mz) [real,private]
testscalar/tccinit [real,private/optional/default=0.0]
testscalar/tccinit_previous [real,private/optional/default=0.0]
testscalar/testscalar_zaver_range (2) [real,private/optional/default=(/-max_real,max_real/)]
testscalar/ugtestm (nz,njtestscalar) [real,private]
testscalar/ugtestmx (nx,njtestscalar) [real,private]
testscalar/ugtestmy (ny,njtestscalar) [real,private]
testscalar/zextent [logical,private/optional/default=.true.]
testscalar/zmask (mz) [real,private]

Subroutines and functions

subroutine testscalar/register_testscalar()

Initialise variables which should know that we solve for the vector potential: icctest, etc; increase nvar accordingly

26-nov-08/axel: adapted from testfield_z.f90 17-apr-09/axel: added y column of kappa tensor

Use :: cdata, mpicomm (stop_it())
Call to:: svn_id(), stop_it(), initial_condition_cctest(), identify_bcs(), fatal_error(), dot_mn(), xysum_mn_name_z(), save_name(), read_snaptime(), update_snaptime()

subroutine testscalar/initialize_testscalar(f)

Perform any post-parameter-read initialization

26-nov-08/axel: adapted from testfield_z.f90 27-dec-08/axel: extended to x-dependent mean fields

Parameters:: f (mx,my,mz,mfarray) [real]
Use :: cdata, farraymanager
Call to:: stop_it(), initial_condition_cctest(), identify_bcs(), fatal_error(), dot_mn(), xysum_mn_name_z(), save_name(), read_snaptime(), update_snaptime()

subroutine testscalar/init_cctest(f)

initialise testscalar; called from start.f90

26-nov-08/axel: adapted from testfield_z.f90

Parameters:: f (mx,my,mz,mfarray) [real,out]
Use :: cdata, mpicomm (stop_it()), initialcondition (initial_condition_cctest())
Call to:: stop_it(), initial_condition_cctest(), identify_bcs(), fatal_error(), dot_mn(), xysum_mn_name_z(), save_name(), read_snaptime(), update_snaptime()

subroutine testscalar/pencil_criteria_testscalar()

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

26-jun-05/anders: adapted from magnetic

Use :: cdata
Call to:: identify_bcs(), fatal_error(), dot_mn(), xysum_mn_name_z(), stop_it(), save_name(), read_snaptime(), update_snaptime()

subroutine testscalar/pencil_interdep_testscalar(lpencil_in)

Interdependency among pencils from the Testscalar module is specified here.

26-jun-05/anders: adapted from magnetic

Parameters:: lpencil_in (npencils) [logical]
Use :: cdata
Call to:: identify_bcs(), fatal_error(), dot_mn(), xysum_mn_name_z(), stop_it(), save_name(), read_snaptime(), update_snaptime()

subroutine testscalar/read_testscalar_init_pars(iomsg)

Parameters:: iomsg [character,out]
Use :: file_io (parallel_unit())
Call to:: identify_bcs(), fatal_error(), dot_mn(), xysum_mn_name_z(), stop_it(), save_name(), read_snaptime(), update_snaptime()

subroutine testscalar/write_testscalar_init_pars(unit)

Parameters:: unit [integer,in]
Call to:: identify_bcs(), fatal_error(), dot_mn(), xysum_mn_name_z(), stop_it(), save_name(), read_snaptime(), update_snaptime()

subroutine testscalar/read_testscalar_run_pars(iomsg)

Parameters:: iomsg [character,out]
Use :: file_io (parallel_unit())
Call to:: identify_bcs(), fatal_error(), dot_mn(), xysum_mn_name_z(), stop_it(), save_name(), read_snaptime(), update_snaptime()

subroutine testscalar/write_testscalar_run_pars(unit)

Parameters:: unit [integer,in]
Call to:: identify_bcs(), fatal_error(), dot_mn(), xysum_mn_name_z(), stop_it(), save_name(), read_snaptime(), update_snaptime()

subroutine testscalar/dcctest_dt(f, df, p)

testscalar evolution:

calculate dc^(p)/dt=-U.g^(p)-u.G^(p)-u.g+<u.g>]+kappa*del2c^(p), where p=1,2 and g=grad c

26-nov-08/axel: adapted from testfield_z.f90 27-dec-08/axel: extended to x-dependent mean fields 17-apr-09/axel: added y column of kappa tensor 17-jun-11/axel: adapted from testscalar to testfield/scalar_axisym

Parameters:

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

Use :

cdata, diagnostics, sub, hydro (uumz(), lcalc_uumeanz()), mpicomm (stop_it())

Call to:

identify_bcs(), fatal_error(), dot_mn(), xysum_mn_name_z(), stop_it(), save_name(), read_snaptime(), update_snaptime()

subroutine testscalar/get_slices_testscalar(f, slices)

Write slices for animation of magnetic variables.

26-nov-08/axel: adapted from testfield_z.f90

Parameters:

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

Use :

cdata (icctest(), lwrite_slice_xy3(), lwrite_slice_xy4(), ix_loc(), iy_loc(), iz_loc(), iz2_loc(), iz3_loc(), iz4_loc())

Call to:

dot_mn(), read_snaptime(), update_snaptime(), fatal_error()

subroutine testscalar/testscalar_after_boundary(f)

Calculate either <ug> or, if ltestscalar_per_unitvolume=T, <ug>+<du>, where g=gradc and d=divu. This is needed when lsoca_ug=F.

26-nov-08/axel: adapted from testfield_z.f90 27-dec-08/axel: also calculate yz-averages

8-aug-10/axel: renamed calc_ltestscalar_pars => testscalar_after_boundary

Parameters:: f (mx,my,mz,mfarray) [real,inout]
Use :: cdata, sub, hydro (calc_pencils_hydro())
Call to:: dot_mn(), read_snaptime(), update_snaptime(), fatal_error()

subroutine testscalar/rescaling_testscalar(f)

Rescale testscalar by factor rescale_cctest(jtest), which could be different for different testscalar

26-nov-08/axel: adapted from testfield_z.f90

Parameters:: f (mx,my,mz,mfarray) [real,inout]
Use :: cdata, sub (read_snaptime(), update_snaptime())
Call to:: read_snaptime(), update_snaptime(), fatal_error()

subroutine testscalar/rprint_testscalar(lreset[, lwrite])

reads and registers print parameters relevant for testscalar fields

26-nov-08/axel: adapted from testfield_z.f90 27-dec-08/axel: included kap11, kap21, and kap31

Parameters:

lreset [logical]
lwrite [logical]

Use :

cdata, diagnostics, farraymanager (farray_index_append()), general (loptest())