meanfield

Module

Description

$Id$

This modules solves mean-field contributions to both the induction and the momentum equations.

** 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 :: lmagn_mf = .true.

MVAR CONTRIBUTION 0 MAUX CONTRIBUTION 0

PENCILS PROVIDED mf_EMF(3); mf_EMFdotB; jxb_mf(3); jxbr_mf(3); chiB_mf PENCILS PROVIDED mf_qp; mf_Beq21; meanfield_etat


Quick access

Variables:

alpha_aniso, alpha_exp, alpha_height, alpha_pom0, alpha_profile, alpha_rmax, alpha_rmin, alpha_tensor, alpha_tensor_y, alpha_tensor_z, alpha_width, alpha_width2, alpha_zz, ampluu_kinematic, b2_to_u2, calc_fluc_alp_cells, calp, channel_magn_mf, channel_magn_mf2, chi_t0, chit_quenching, delta_profile, emf_profile, eta_tensor, eta_tensor_y, eta_tensor_z, fluc_alp_m, fluc_alp_profile, fpatches, gamma_effect, gamma_quenching, gwfac1, gwfac2, gwfac3, hij_ampl, hijk, idiag_alpkjbm, idiag_alpkm, idiag_alpmxz, idiag_emfdotb_int, idiag_emfdotbm, idiag_emfmz1, idiag_emfmz2, idiag_emfmz3, idiag_peffmxz, idiag_qam, idiag_qem, idiag_qpm, idiag_qpmz, idiag_qsm, init_mf, ir_cell, itheta_cell, kx_alpha, lalpha_aniso, lalpha_omega_approx, lalpha_profile_total, lalpha_tensor, lalphass_disk, lchit_bext2_equil, lchit_with_glntt, ldelta_profile, lemf_profile, leta_tensor, lgw_tensor, lignore_gradb2_inchib, llarge_scale_velocity, lmeanfield_chitb, lmeanfield_pumping, lnempi_correction, lnempi_correction_qp_profile, lomega_effect_meanfield, lqp_aniso_factor, lqp_profile, lqpcurrent, lqpx_profile, lread_alpha_tensor_z, lread_alpha_tensor_z_as_y, lread_eta_tensor_z, lread_eta_tensor_z_as_y, lrho_chit, lrhs_term, lrhs_term2, lshear_current_effect, ltest_patches, lturb_temp_diff, meanfield_ba, meanfield_be, meanfield_beq, meanfield_beq2_height, meanfield_beq_height, meanfield_beq_profile, meanfield_beq_width, meanfield_chitb, meanfield_cs0, meanfield_delta_height, meanfield_delta_width, meanfield_etat_corona, meanfield_etat_exp, meanfield_etat_height, meanfield_etat_profile, meanfield_etat_rmax, meanfield_etat_width, meanfield_kf_profile, meanfield_kf_width, meanfield_kf_width2, meanfield_pumping, meanfield_qa, meanfield_qa1, meanfield_qe, meanfield_qe1, meanfield_qp1, meanfield_qs1, mf_qj2, nmultipole, npatches, npatches_actual, nr_cell, nth_cell, omega_effect, omega_rmax, omega_rwidth, qp_aniso_factor, qp_model, qp_profder, qp_profile, qp_width, qpx_profder, qpx_profile, qpx_width, rand_alpha, refresh_fluc_alpha_phase, relhel_hij, rhs_term, rhs_term_ampl, rhs_term_amplphi, rhs_term_amplz, rhs_term_kx, rhs_termy, rhs_termz, roty, roty0, seed_magn_mf2, shear_current_profile, shear_current_sh, sigma_alpha, tau_cell, uturb, x1_alp, x2_alp, x_surface, x_surface2, xcenter, xpatches, y1_alp, y2_alp, ycenter, ypatches, zcenter

Routines:

calc_diagnostics_meanfield(), calc_pencils_magn_mf(), daa_dt_meanfield(), init_aa_mf(), initialize_magn_mf(), meanfield_after_boundary(), pc_aasb_const_alpha(), pencil_criteria_magn_mf(), pencil_interdep_magn_mf(), pushpars2c(), read_magn_mf_init_pars(), read_magn_mf_run_pars(), register_magn_mf(), rprint_magn_mf(), write_magn_mf_init_pars(), write_magn_mf_run_pars()

Needed modules

Variables

  • magnetic_meanfield/alpha_aniso (3) [real,private/optional/default=0.]
  • magnetic_meanfield/alpha_cutoff_down [real,private/optional/default=0.0]
  • magnetic_meanfield/alpha_cutoff_up [real,private/optional/default=0.0]
  • magnetic_meanfield/alpha_effect [real,private/optional/default=0.0]
  • magnetic_meanfield/alpha_eps [real,private/optional/default=0.0]
  • magnetic_meanfield/alpha_equator [real,private/optional/default=impossible]
  • magnetic_meanfield/alpha_equator_gap [real,private/optional/default=0.0]
  • magnetic_meanfield/alpha_exp [real,private/optional/default=0.0]
  • magnetic_meanfield/alpha_gap_step [real,private/optional/default=0.0]
  • magnetic_meanfield/alpha_height [real,private/optional/default=0.0]
  • magnetic_meanfield/alpha_input (mx,my) [real,private]
  • magnetic_meanfield/alpha_pom0 [real,private/optional/default=0.0]
  • magnetic_meanfield/alpha_profile [character,private/optional/default='const']
  • magnetic_meanfield/alpha_quenching [real,private/optional/default=0.0]
  • magnetic_meanfield/alpha_rmax [real,private/optional/default=0.0]
  • magnetic_meanfield/alpha_rmin [real,private/optional/default=0.0]
  • magnetic_meanfield/alpha_tensor (3,3) [real,private/optional/default=0.]
  • magnetic_meanfield/alpha_tensor_y (ny,3,3) [real,private/optional/default=0.]
  • magnetic_meanfield/alpha_tensor_z (nz,2,2) [real,private/optional/default=0.]
  • magnetic_meanfield/alpha_width [real,private/optional/default=0.0]
  • magnetic_meanfield/alpha_width2 [real,private/optional/default=0.0]
  • magnetic_meanfield/alpha_zz [real,private/optional/default=0.0]
  • magnetic_meanfield/ampluu_kinematic [real,private/optional/default=0.0]
  • magnetic_meanfield/b0 [real,private/optional/default=0.0]
  • magnetic_meanfield/b2_to_u2 [real,private/optional/default=0.0]
  • magnetic_meanfield/b_ext2 [real,private/pointer]
  • magnetic_meanfield/calc_fluc_alp_cells [private]
  • magnetic_meanfield/calp [real,private/optional/default=0.0]
  • magnetic_meanfield/channel_magn_mf [integer,private/optional/default=1]
  • magnetic_meanfield/channel_magn_mf2 [integer,private/optional/default=2]
  • magnetic_meanfield/chi_t0 [real,private/optional/default=0.0]
  • magnetic_meanfield/chit_quenching [real,private/optional/default=0.0]
  • magnetic_meanfield/cy (*) [real,private/allocatable]
  • magnetic_meanfield/delta_effect [real,private/optional/default=0.0]
  • magnetic_meanfield/delta_profile [character,private/optional/default='const']
  • magnetic_meanfield/detat_x (nx) [real,private]
  • magnetic_meanfield/detat_y (my) [real,private]
  • magnetic_meanfield/detat_z (mz) [real,private]
  • magnetic_meanfield/dummy [real,private/optional/default=0.0]
  • magnetic_meanfield/emf_profile [character,private/optional/default='nothing']
  • magnetic_meanfield/eta [real,private/pointer]
  • magnetic_meanfield/eta_tensor (3,3) [real,private/optional/default=0.]
  • magnetic_meanfield/eta_tensor_y (ny,3,3) [real,private/optional/default=0.]
  • magnetic_meanfield/eta_tensor_z (nz,2,2) [real,private/optional/default=0.]
  • magnetic_meanfield/etat_x (nx) [real,private]
  • magnetic_meanfield/etat_y (my) [real,private]
  • magnetic_meanfield/etat_z (mz) [real,private]
  • magnetic_meanfield/fluc_alp_m [real,private/optional/default=1.0]
  • magnetic_meanfield/fluc_alp_profile [character,private/optional/default='gaussian']
  • magnetic_meanfield/fpatches (nz) [real,private/optional/default=0]
  • magnetic_meanfield/gamma_effect [real,private/optional/default=0.0]
  • magnetic_meanfield/gamma_quenching [real,private/optional/default=0.0]
  • magnetic_meanfield/gwfac1 [real,private/optional/default=1.0]
  • magnetic_meanfield/gwfac2 [real,private/optional/default=1.0]
  • magnetic_meanfield/gwfac3 [real,private/optional/default=1.0]
  • magnetic_meanfield/hij (nx,3,3) [real,private]
  • magnetic_meanfield/hij_ampl [real,private/optional/default=1.0]
  • magnetic_meanfield/hijk (nx,3,3,3) [real,private]
  • magnetic_meanfield/idiag_alpkjbm [integer,private/optional/default=0]
  • magnetic_meanfield/idiag_alpkm [integer,private/optional/default=0]
  • magnetic_meanfield/idiag_alpm [integer,private/optional/default=0]
  • magnetic_meanfield/idiag_alpmxz [integer,private/optional/default=0]
  • magnetic_meanfield/idiag_emfdotb_int [integer,private/optional/default=0]
  • magnetic_meanfield/idiag_emfdotbm [integer,private/optional/default=0]
  • magnetic_meanfield/idiag_emfmz1 [integer,private/optional/default=0]
  • magnetic_meanfield/idiag_emfmz2 [integer,private/optional/default=0]
  • magnetic_meanfield/idiag_emfmz3 [integer,private/optional/default=0]
  • magnetic_meanfield/idiag_etatm [integer,private/optional/default=0]
  • magnetic_meanfield/idiag_peffmxz [integer,private/optional/default=0]
  • magnetic_meanfield/idiag_qam [integer,private/optional/default=0]
  • magnetic_meanfield/idiag_qem [integer,private/optional/default=0]
  • magnetic_meanfield/idiag_qpm [integer,private/optional/default=0]
  • magnetic_meanfield/idiag_qpmz [integer,private/optional/default=0]
  • magnetic_meanfield/idiag_qsm [integer,private/optional/default=0]
  • magnetic_meanfield/init_mf (ninit) [character,private/optional/default='nothing']
  • magnetic_meanfield/ir_cell (nx) [integer,private/optional/default=1]
  • magnetic_meanfield/itheta_cell (nx,my) [integer,private/optional/default=1]
  • magnetic_meanfield/kf_x (nx) [real,private]
  • magnetic_meanfield/kf_x1 (nx) [real,private]
  • magnetic_meanfield/kf_y (my) [real,private]
  • magnetic_meanfield/kf_z (mz) [real,private]
  • magnetic_meanfield/kx_alpha [real,private/optional/default=1.0]
  • magnetic_meanfield/kx_hij [real,private/optional/default=1.0]
  • magnetic_meanfield/lalpha_aniso [logical,private/optional/default=.false.]
  • magnetic_meanfield/lalpha_omega_approx [logical,private/optional/default=.false.]
  • magnetic_meanfield/lalpha_profile_total [logical,private/optional/default=.false.]
  • magnetic_meanfield/lalpha_tensor [logical,private/optional/default=.false.]
  • magnetic_meanfield/lalphass_disk [logical,private/optional/default=.false.]
  • magnetic_meanfield/lchit_bext2_equil [logical,private/optional/default=.false.]
  • magnetic_meanfield/lchit_with_glntt [logical,private/optional/default=.false.]
  • magnetic_meanfield/ldelta_profile [logical,private/optional/default=.false.]
  • magnetic_meanfield/lemf_profile [logical,private/optional/default=.false.]
  • magnetic_meanfield/leta_tensor [logical,private/optional/default=.false.]
  • magnetic_meanfield/lgw_tensor [logical,private/optional/default=.false.]
  • magnetic_meanfield/lignore_gradb2_inchib [logical,private/optional/default=.false.]
  • magnetic_meanfield/llarge_scale_velocity [logical,private/optional/default=.false.]
  • magnetic_meanfield/lmeanfield_chitb [logical,private/optional/default=.false.]
  • magnetic_meanfield/lmeanfield_jxb [logical,private/optional/default=.false.]
  • magnetic_meanfield/lmeanfield_jxb_with_va2 [logical,private/optional/default=.false.]
  • magnetic_meanfield/lmeanfield_noalpm [logical,private/optional/default=.false.]
  • magnetic_meanfield/lmeanfield_pumping [logical,private/optional/default=.false.]
  • magnetic_meanfield/lnempi_correction [logical,private/optional/default=.true.]
  • magnetic_meanfield/lnempi_correction_qp_profile [logical,private/optional/default=.true.]
  • magnetic_meanfield/lomega_effect [logical,private/optional/default=.false.]
  • magnetic_meanfield/lomega_effect_meanfield [logical,private/optional/default=.false.]
  • magnetic_meanfield/lqp_aniso_factor [logical,private/optional/default=.false.]
  • magnetic_meanfield/lqp_profile [logical,private/optional/default=.false.]
  • magnetic_meanfield/lqpcurrent [logical,private/optional/default=.false.]
  • magnetic_meanfield/lqpx_profile [logical,private/optional/default=.false.]
  • magnetic_meanfield/lread_alpha_tensor_z [logical,private/optional/default=.false.]
  • magnetic_meanfield/lread_alpha_tensor_z_as_y [logical,private/optional/default=.false.]
  • magnetic_meanfield/lread_eta_tensor_z [logical,private/optional/default=.false.]
  • magnetic_meanfield/lread_eta_tensor_z_as_y [logical,private/optional/default=.false.]
  • magnetic_meanfield/lrho_chit [logical,private/optional/default=.true.]
  • magnetic_meanfield/lrhs_term [logical,private/optional/default=.false.]
  • magnetic_meanfield/lrhs_term2 [logical,private/optional/default=.false.]
  • magnetic_meanfield/lshear_current_effect [logical,private/optional/default=.false.]
  • magnetic_meanfield/ltest_patches [logical,private/optional/default=.false.]
  • magnetic_meanfield/lturb_temp_diff [logical,private/optional/default=.false.]
  • magnetic_meanfield/lweyl_gauge [logical,private/pointer]
  • magnetic_meanfield/meanfield_ba [real,private/optional/default=1.0]
  • magnetic_meanfield/meanfield_be [real,private/optional/default=1.0]
  • magnetic_meanfield/meanfield_beq [real,private/optional/default=1.0]
  • magnetic_meanfield/meanfield_beq2_height [real,private/optional/default=0.0]
  • magnetic_meanfield/meanfield_beq_height [real,private/optional/default=0.0]
  • magnetic_meanfield/meanfield_beq_profile [character,private/optional/default='const']
  • magnetic_meanfield/meanfield_beq_width [real,private/optional/default=0.0]
  • magnetic_meanfield/meanfield_bp [real,private/optional/default=1.0]
  • magnetic_meanfield/meanfield_bs [real,private/optional/default=1.0]
  • magnetic_meanfield/meanfield_chitb [private]
  • magnetic_meanfield/meanfield_cs0 [real,private/optional/default=1.0]
  • magnetic_meanfield/meanfield_delta_height [real,private/optional/default=10.0]
  • magnetic_meanfield/meanfield_delta_width [real,private/optional/default=0.05]
  • magnetic_meanfield/meanfield_etab [real,private/optional/default=0.0]
  • magnetic_meanfield/meanfield_etat [real,private/optional/default=0.0]
  • magnetic_meanfield/meanfield_etat_corona [real,private/optional/default=0.0]
  • magnetic_meanfield/meanfield_etat_exp [real,private/optional/default=1.0]
  • magnetic_meanfield/meanfield_etat_height [real,private/optional/default=1.0]
  • magnetic_meanfield/meanfield_etat_profile [character,private/optional/default='const']
  • magnetic_meanfield/meanfield_etat_rmax [real,private/optional/default=1.0]
  • magnetic_meanfield/meanfield_etat_width [real,private/optional/default=0.0]
  • magnetic_meanfield/meanfield_kf [real,private/optional/default=1.0]
  • magnetic_meanfield/meanfield_kf_profile [character,private/optional/default='const']
  • magnetic_meanfield/meanfield_kf_width [real,private/optional/default=0.0]
  • magnetic_meanfield/meanfield_kf_width2 [real,private/optional/default=0.0]
  • magnetic_meanfield/meanfield_pumping [real,private/optional/default=1.0]
  • magnetic_meanfield/meanfield_qa [real,private/optional/default=0.0]
  • magnetic_meanfield/meanfield_qa1 [real,private]
  • magnetic_meanfield/meanfield_qe [real,private/optional/default=0.0]
  • magnetic_meanfield/meanfield_qe1 [real,private]
  • magnetic_meanfield/meanfield_qp [real,private/optional/default=0.0]
  • magnetic_meanfield/meanfield_qp1 [real,private]
  • magnetic_meanfield/meanfield_qs [real,private/optional/default=0.0]
  • magnetic_meanfield/meanfield_qs1 [real,private]
  • magnetic_meanfield/mf_qj2 [real,private/optional/default=0.0]
  • magnetic_meanfield/nmultipole [integer,private/optional/default=1]
  • magnetic_meanfield/npatches [integer,private/optional/default=1]
  • magnetic_meanfield/npatches_actual [integer,private]
  • magnetic_meanfield/nr_cell [integer,private/optional/default=1]
  • magnetic_meanfield/nth_cell [integer,private/optional/default=1]
  • magnetic_meanfield/omega_ampl [real,private/optional/default=0.0]
  • magnetic_meanfield/omega_effect [private]
  • magnetic_meanfield/omega_profile [character,private/optional/default='nothing']
  • magnetic_meanfield/omega_rmax [real,private/optional/default=0.0]
  • magnetic_meanfield/omega_rwidth [real,private/optional/default=0.0]
  • magnetic_meanfield/qp_aniso_factor [real,private/optional/default=1.0]
  • magnetic_meanfield/qp_model [character,private/optional/default='atan']
  • magnetic_meanfield/qp_profder (mz) [real,private]
  • magnetic_meanfield/qp_profile (mz) [real,private]
  • magnetic_meanfield/qp_width [real,private/optional/default=impossible]
  • magnetic_meanfield/qpx_profder (nx) [real,private]
  • magnetic_meanfield/qpx_profile (nx) [real,private]
  • magnetic_meanfield/qpx_width [real,private/optional/default=impossible]
  • magnetic_meanfield/r0 [real,private/optional/default=1.0]
  • magnetic_meanfield/rand_alpha (nx,my) [real,private/optional/default=0.]
  • magnetic_meanfield/refresh_fluc_alpha_phase [private]
  • magnetic_meanfield/relhel_hij [real,private/optional/default=1.0]
  • magnetic_meanfield/rhs_term (nx) [real,private]
  • magnetic_meanfield/rhs_term_ampl [real,private/optional/default=0.0]
  • magnetic_meanfield/rhs_term_amplphi [real,private/optional/default=0.0]
  • magnetic_meanfield/rhs_term_amplz [real,private/optional/default=0.0]
  • magnetic_meanfield/rhs_term_kx [real,private/optional/default=0.0]
  • magnetic_meanfield/rhs_termy (nx) [real,private]
  • magnetic_meanfield/rhs_termz (nx) [real,private]
  • magnetic_meanfield/roty (*) [real,private/allocatable]
  • magnetic_meanfield/roty0 [real,private/optional/default=0.0]
  • magnetic_meanfield/seed_magn_mf2 [integer,private/optional/default=5555]
  • magnetic_meanfield/shear_current_profile [character,private/optional/default='nothing']
  • magnetic_meanfield/shear_current_sh [real,private/optional/default=0.0]
  • magnetic_meanfield/sigma_alpha [real,private/optional/default=1.0]
  • magnetic_meanfield/sy (*) [real,private/allocatable]
  • magnetic_meanfield/tau_cell (nx) [real,private/optional/default=1.0]
  • magnetic_meanfield/uturb [real,private/optional/default=0.1]
  • magnetic_meanfield/x1_alp [real,private/optional/default=0.0]
  • magnetic_meanfield/x2_alp [real,private/optional/default=0.0]
  • magnetic_meanfield/x_surface [real,private/optional/default=0.0]
  • magnetic_meanfield/x_surface2 [real,private/optional/default=0.0]
  • magnetic_meanfield/xcenter (*) [real,private/allocatable]
  • magnetic_meanfield/xpatches (nz) [real,private/optional/default=0]
  • magnetic_meanfield/y1_alp [real,private/optional/default=0.0]
  • magnetic_meanfield/y2_alp [real,private/optional/default=0.0]
  • magnetic_meanfield/ycenter (*) [real,private/allocatable]
  • magnetic_meanfield/ypatches (nz) [real,private/optional/default=0]
  • magnetic_meanfield/z_surface [real,private/optional/default=0.0]
  • magnetic_meanfield/zcenter (*) [real,private/allocatable]

Subroutines and functions

subroutine  magnetic_meanfield/register_magn_mf()

No additional variables to be initialized here, but other mean-field modules that are being called from here may need additional variables.

6-jan-11/axel: adapted from magnetic

Identify version number.

Use :

sharedvariables (put_shared_variable())

Call to:

svn_id(), register_magn_mf_demfdt(), fatal_error(), erfunc(), inevitably_fatal_error(), initialize_magn_mf_demfdt(), init_aa_mf_demfdt(), pencil_criteria_magn_mf_demfdt(), pencil_interdep_magn_mf_demfdt(), multsv_mn(), multsv_mn_add(), stepdown(), cross_mn(), levi_civita(), dot_mn(), xysum_mn_name_z(), ysum_mn_name_xz(), demf_dt_meanfield(), calc_diagnostics_meanfield(), integrate_mn_name(), calc_diagnostics_dt_meanfield(), read_magn_mf_demfdt_init_pars(), write_magn_mf_demfdt_init_pars(), read_magn_mf_demfdt_run_pars(), write_magn_mf_demfdt_run_pars()

subroutine  magnetic_meanfield/initialize_magn_mf(f)

Perform any post-parameter-read initialization

20-may-03/axel: reinitialize_aa added

Parameters:

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

Use :

sub (erfunc()), general (random_number_wrapper(), random_seed_wrapper(), random_gen()), sharedvariables (get_shared_variable())

Call to:

fatal_error(), erfunc(), inevitably_fatal_error(), initialize_magn_mf_demfdt(), init_aa_mf_demfdt(), pencil_criteria_magn_mf_demfdt(), pencil_interdep_magn_mf_demfdt(), multsv_mn(), multsv_mn_add(), stepdown(), cross_mn(), levi_civita(), dot_mn(), xysum_mn_name_z(), ysum_mn_name_xz(), demf_dt_meanfield(), calc_diagnostics_meanfield(), integrate_mn_name(), calc_diagnostics_dt_meanfield(), read_magn_mf_demfdt_init_pars(), write_magn_mf_demfdt_init_pars(), read_magn_mf_demfdt_run_pars(), write_magn_mf_demfdt_run_pars()

subroutine  magnetic_meanfield/init_aa_mf(f)

Initialise mean-field related magnetic field; called from magnetic.f90 At the moment, no own initial conditions are allowed, but we need this to call secondary modules

6-jan-2011/axel: adapted from magnetic

Parameters:

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

Call to:

fatal_error(), init_aa_mf_demfdt(), pencil_criteria_magn_mf_demfdt(), pencil_interdep_magn_mf_demfdt(), erfunc(), multsv_mn(), multsv_mn_add(), inevitably_fatal_error(), stepdown(), cross_mn(), levi_civita(), dot_mn(), xysum_mn_name_z(), ysum_mn_name_xz(), demf_dt_meanfield(), calc_diagnostics_meanfield(), integrate_mn_name(), calc_diagnostics_dt_meanfield(), read_magn_mf_demfdt_init_pars(), write_magn_mf_demfdt_init_pars(), read_magn_mf_demfdt_run_pars(), write_magn_mf_demfdt_run_pars()

subroutine  magnetic_meanfield/pencil_criteria_magn_mf()

All pencils that the magnetic mean-field module depends on are specified here.

28-jul-10/axel: adapted from magnetic

Call to:

pencil_criteria_magn_mf_demfdt(), pencil_interdep_magn_mf_demfdt(), erfunc(), multsv_mn(), multsv_mn_add(), inevitably_fatal_error(), stepdown(), cross_mn(), fatal_error(), levi_civita(), dot_mn(), xysum_mn_name_z(), ysum_mn_name_xz(), demf_dt_meanfield(), calc_diagnostics_meanfield(), integrate_mn_name(), calc_diagnostics_dt_meanfield(), read_magn_mf_demfdt_init_pars(), write_magn_mf_demfdt_init_pars(), read_magn_mf_demfdt_run_pars(), write_magn_mf_demfdt_run_pars()

subroutine  magnetic_meanfield/pencil_interdep_magn_mf(lpencil_in)

Interdependency among pencils from the Magnetic module is specified here.

28-jul-10/axel: adapted from magnetic

Parameters:

lpencil_in (npencils) [logical]

Call to:

pencil_interdep_magn_mf_demfdt(), erfunc(), multsv_mn(), multsv_mn_add(), inevitably_fatal_error(), stepdown(), cross_mn(), fatal_error(), levi_civita(), dot_mn(), xysum_mn_name_z(), ysum_mn_name_xz(), demf_dt_meanfield(), calc_diagnostics_meanfield(), integrate_mn_name(), calc_diagnostics_dt_meanfield(), read_magn_mf_demfdt_init_pars(), write_magn_mf_demfdt_init_pars(), read_magn_mf_demfdt_run_pars(), write_magn_mf_demfdt_run_pars()

subroutine  magnetic_meanfield/calc_pencils_magn_mf(f, p)

Calculate Magnetic mean-field pencils. Most basic pencils should come first, as others may depend on them.

28-jul-10/axel: adapted from magnetic

Parameters:
Use :

sub, general (bessj()), diagnostics (sum_mn_name(), xysum_mn_name_z(), ysum_mn_name_xz()), messages (warning())

Call to:

erfunc(), multsv_mn(), multsv_mn_add(), inevitably_fatal_error(), stepdown(), cross_mn(), fatal_error(), levi_civita(), dot_mn(), xysum_mn_name_z(), ysum_mn_name_xz(), demf_dt_meanfield(), calc_diagnostics_meanfield(), integrate_mn_name(), calc_diagnostics_dt_meanfield(), read_magn_mf_demfdt_init_pars(), write_magn_mf_demfdt_init_pars(), read_magn_mf_demfdt_run_pars(), write_magn_mf_demfdt_run_pars()

subroutine  magnetic_meanfield/daa_dt_meanfield(f, df, p)

Add mean-field evolution to magnetic field. Note that this routine is not called when ldisp_current=T.

27-jul-10/axel: coded

Parameters:
Use :

sub (cross_mn())

Call to:

cross_mn(), demf_dt_meanfield(), calc_diagnostics_meanfield(), integrate_mn_name(), xysum_mn_name_z(), ysum_mn_name_xz(), calc_diagnostics_dt_meanfield(), stepdown(), read_magn_mf_demfdt_init_pars(), write_magn_mf_demfdt_init_pars(), read_magn_mf_demfdt_run_pars(), write_magn_mf_demfdt_run_pars(), fatal_error()

subroutine  magnetic_meanfield/calc_diagnostics_meanfield(f, p)

Calculate diagnostic quantities. Diagnostic output for mean field dynamos.

Parameters:
Use :

diagnostics

Call to:

integrate_mn_name(), xysum_mn_name_z(), ysum_mn_name_xz(), calc_diagnostics_dt_meanfield(), stepdown(), read_magn_mf_demfdt_init_pars(), write_magn_mf_demfdt_init_pars(), read_magn_mf_demfdt_run_pars(), write_magn_mf_demfdt_run_pars(), fatal_error()

subroutine  magnetic_meanfield/read_magn_mf_init_pars(iomsg)
Parameters:

iomsg [character,inout]

Use :

file_io (parallel_unit())

Call to:

read_magn_mf_demfdt_init_pars(), write_magn_mf_demfdt_init_pars(), read_magn_mf_demfdt_run_pars(), write_magn_mf_demfdt_run_pars(), fatal_error()

subroutine  magnetic_meanfield/write_magn_mf_init_pars(unit)
Parameters:

unit [integer,in]

Call to:

write_magn_mf_demfdt_init_pars(), read_magn_mf_demfdt_run_pars(), write_magn_mf_demfdt_run_pars(), fatal_error()

subroutine  magnetic_meanfield/read_magn_mf_run_pars(iomsg)
Parameters:

iomsg [character,inout]

Use :

file_io (parallel_unit())

Call to:

read_magn_mf_demfdt_run_pars(), write_magn_mf_demfdt_run_pars(), fatal_error()

subroutine  magnetic_meanfield/write_magn_mf_run_pars(unit)
Parameters:

unit [integer,in]

Call to:

write_magn_mf_demfdt_run_pars(), fatal_error()

subroutine  magnetic_meanfield/rprint_magn_mf(lreset[, lwrite])

Reads and registers print parameters relevant for magnetic fields.

3-may-02/axel: coded

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

Parameters:
  • lreset [logical]

  • lwrite [logical]

Use :

diagnostics (parse_name())

Call to:

fatal_error()

subroutine  magnetic_meanfield/pc_aasb_const_alpha(f, topbot, j)

Perfect-conductor BC for mean field in 1D (only z dependent) with constant alpha and etaT, IF A IS CONSIDERED AS B. Only implemented at lower z boundary.

2-jan-17/MR: coded

Parameters:
  • f (,,*,*) [real]

  • topbot [integer]

  • j [integer]

Call to:

fatal_error()

subroutine  magnetic_meanfield/meanfield_after_boundary(f)

precalculate parameters that are new at each timestep, but the same for all pencils

Parameters:

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

subroutine  magnetic_meanfield/pushpars2c(p_par)
Parameters:

p_par (1100) [integer]

Use :

syscalls (copy_addr()), general (string_to_enum())