equ

Module

Description

$Id$

subroutines in the chosen set of physics modules.

Quick access

Variables:: after_boundary_cpu, after_boundary_shared, before_and_after_boundary_sum_time, before_boundary_cpu, before_boundary_shared, calc_all_before_boundary_diagnostics, calc_all_module_diagnostics, calc_all_pencils, calc_all_rhs, calc_df_diagnostics, calc_maxadvec, calc_phisums, calc_time_integrals, check_if_have_to_wait_for_communication, freeze, init_reduc_pointers, initialize_pencils, load_variables_to_gpu, output_crash_files, p_fname, p_fname_keep, p_fname_sound, p_fnamer, p_fnamerz, p_fnamex, p_fnamexy, p_fnamexz, p_fnamey, p_fnamez, p_ncountsz, prep_rhs, radtransfer_sum_time, rhs_cpu, rhs_sum_time, set_dt1_max, set_dyndiff_coeff, test_rhs_gpu, time_spent_copying_and_waiting, timestep_diagnostics
Routines:: calc_all_module_diagnostic_auxiliaries(), debug_imn_arrays(), finalize_diagnostics(), impose_floors_ceilings(), pde(), perform_diagnostics(), write_diagnostics()

Needed modules

cdata: $Id$
messages: $Id$
boundcond: $Id$
grid (calc_pencils_grid(), get_grid_mn()): $Id$
mpicomm (mpi_comm_grid(), mpi_comm_pencil(), mpi_comm_xbeam(), mpi_comm_ybeam(), mpi_comm_zbeam(), mpi_comm_xyplane(), mpi_comm_xzplane(), mpi_comm_yzplane()): $Id$

Variables

equ/after_boundary_cpu [private]
equ/after_boundary_shared [private]
equ/before_and_after_boundary_sum_time [real,public/optional/default=0.0]
equ/before_boundary_cpu [private]
equ/before_boundary_shared [private]
equ/calc_all_before_boundary_diagnostics [private]
equ/calc_all_module_diagnostics [private]
equ/calc_all_pencils [private]
equ/calc_all_rhs [private]
equ/calc_df_diagnostics [private]
equ/calc_maxadvec [private]
equ/calc_phisums [private]
equ/calc_time_integrals [private]
equ/check_if_have_to_wait_for_communication [private]
equ/freeze [private]
equ/init_reduc_pointers [private]
equ/initialize_pencils [public]
equ/load_variables_to_gpu [private]
equ/output_crash_files [private]
equ/p_fname (*) [real,private/pointer]
equ/p_fname_keep (*) [real,private/pointer]
equ/p_fname_sound (*,*) [real,private/pointer]
equ/p_fnamer (*,*) [real,private/pointer]
equ/p_fnamerz (*,*,*,*) [real,private/pointer]
equ/p_fnamex (*,*,*) [real,private/pointer]
equ/p_fnamexy (*,*,*) [real,private/pointer]
equ/p_fnamexz (*,*,*) [real,private/pointer]
equ/p_fnamey (*,*,*) [real,private/pointer]
equ/p_fnamez (*,*,*) [real,private/pointer]
equ/p_ncountsz (*,*) [integer,private/pointer]
equ/prep_rhs [private]
equ/radtransfer_sum_time [real,public/optional/default=0.0]
equ/rhs_cpu [private]
equ/rhs_sum_time [real,public/optional/default=0.0]
equ/set_dt1_max [private]
equ/set_dyndiff_coeff [private]
equ/test_rhs_gpu [private]
equ/time_spent_copying_and_waiting [real,public/optional/default=0.0]
equ/timestep_diagnostics [private]

Subroutines and functions

subroutine equ/pde(f, df, p)

Call the different evolution equations.

10-sep-01/axel: coded 12-may-12/MR: call of density_before_boundary added for boussinesq;

moved call of timing after call of anelastic_after_mn

26-aug-13/MR: added call of diagnostic for imaginary parts
9-jun-15/MR: call of gravity_after_boundary added

24-sep-16/MR: added offset manipulation for second derivatives in complete one-sided fornulation.
5-jan-17/MR: removed mn-offset manipulation

14-feb-17/MR: adaptations for use of GPU kernels in calculating the rhss of the pde 25-aug-23/TP: adaptations for concurrent multithreading alongside GPU computation

Parameters:

f (,,*,*) [real,inout,contiguous] :: inout due to lshift_datacube_x,
df (,,*,*) [real,out,contiguous]
p [pencil_case,out]

Use :

chiral, chemistry, density, diagnostics (save_diagnostic_controls()), energy, equationofstate, ghostfold (fold_df(), fold_df_3points()), gpu (before_boundary_gpu(), rhs_gpu(), copy_farray_from_gpu(), get_farray_ptr_gpu(), ltest_rhs(), it_test_rhs()), gravity, hydro, magnetic, hypervisc_strict (hyperviscosity_strict()), hyperresi_strict (hyperresistivity_strict()), nscbc, particles_main, poisson, pscalar, pointmasses, polymer, radiation, selfgravity, shear, solid_cells (update_solid_cells(), dsolid_dt_integrate()), sub, testfield, testflow, testscalar, grid (coarsegrid_interp()), mpicomm

Called from:

time_step(), pencil_consistency_check(), initialize_timestep()

Call to:

subroutine equ/write_diagnostics(f)

Writes out the diagnostics

13-nov-23/TP: Carved from Time_loop

Parameters:: f (,,*,*) [real,contiguous]
Use :: chemistry, slices, diagnostics
Called from:: pde(), write_diagnostics(), calc_all_module_diagnostic_auxiliaries(), perform_diagnostics(), helper_loop(), reload(), gen_output()
Call to:: prints(), write_net_reaction(), write_1daverages(), write_2daverages(), write_sound(), wvid(), diagnostics_init_reduc_pointers(), chemistry_init_reduc_pointers(), sc_init_reduc_pointers(), calc_diagnostic_auxiliaries_magnetic(), chemistry_allocate_rhs_arrays(), calc_diagnostics_ascalar(), calc_diagnostics_chemistry(), calc_diagnostics_chiral(), calc_diagnostics_cosmicray(), calc_diagnostics_density(), calc_diagnostics_dustdensity(), calc_diagnostics_dustvelocity(), calc_diagnostics_energy(), calc_diagnostics_forcing(), calc_diagnostics_gravity(), calc_diagnostics_heatflux(), calc_diagnostics_hydro(), calc_diagnostics_interstellar(), calc_diagnostics_lorenz_gauge(), calc_diagnostics_magnetic(), calc_diagnostics_neutraldens(), calc_diagnostics_neutralvel(), particles_calc_pencil_diags(), calc_diagnostics_pointmasses(), calc_diagnostics_pscalar(), calc_diagnostics_polymer(), calc_diagnostics_radiation(), calc_diagnostics_selfgrav(), calc_diagnostics_shear(), calc_diagnostics_shock(), calc_diagnostics_training(), calc_diagnostics_viscosity(), calc_diagnostics_special(), density_before_boundary_diagnostics(), ioncalc(), calc_ode_diagnostics_special(), finalize_diagnostics(), write_diagnostics(), diagnostic(), xyaverages_z(), xzaverages_y(), yzaverages_x(), phizaverages_r(), yaverages_xz(), zaverages_xy(), phiaverages_rz(), calc_mfield(), calc_mflow(), calc_mpscalar(), update_solid_cells_pencil(), get_grid_mn(), calc_phiavg_profile(), calc_pencils_density(), calc_pencils_pscalar(), calc_pencils_ascalar(), calc_pencils_shock(), calc_pencils_chemistry(), calc_pencils_energy(), calc_pencils_viscosity(), calc_pencils_interstellar(), calc_pencils_forcing(), calc_pencils_lorenz_gauge(), calc_pencils_magnetic(), calc_pencils_polymer(), calc_pencils_gravity(), calc_pencils_selfgravity(), calc_pencils_dustvelocity(), calc_pencils_dustdensity(), calc_pencils_neutralvelocity(), calc_pencils_neutraldensity(), calc_pencils_cosmicray(), calc_pencils_cosmicrayflux(), calc_pencils_chiral(), calc_pencils_radiation(), calc_pencils_shear(), calc_pencils_borderprofiles(), calc_pencils_pointmasses(), particles_calc_pencils(), calc_pencils_special(), calc_pencils_heatflux(), finalize_isendrcv_bdry(), boundconds_y(), boundconds_z(), interstellar_before_boundary(), shear_before_boundary(), hydro_before_boundary(), calc_selfpotential(), dustdensity_before_boundary(), density_before_boundary(), magnetic_before_boundary(), energy_before_boundary(), chiral_before_boundary(), special_before_boundary(), testflow_before_boundary(), testfield_before_boundary(), particles_before_boundary(), pscalar_before_boundary(), detonate_before_boundary(), chemistry_before_boundary(), particles_special_bfre_bdary(), shock_before_boundary(), training_after_boundary(), mpiwtime(), radtransfer(), calc_shock_profile_simple(), hydro_after_boundary(), viscosity_after_boundary(), magnetic_after_boundary(), dustdensity_after_boundary(), energy_after_boundary(), gravity_after_boundary(), forcing_after_boundary(), calc_polymer_after_boundary(), testscalar_after_boundary(), testfield_after_boundary(), density_after_boundary(), neutraldensity_after_boundary(), calc_ltestflow_nonlin_terms(), meanfield_after_boundary(), special_after_boundary(), calc_for_chem_mixture(), prep_rhs_special(), max_mn_name(), xymax_mn_name_z(), time_integrals_hydro(), time_integrals_magnetic(), df_diagnos_hydro(), df_diagnos_magnetic(), duu_dt(), dlnrho_dt(), denergy_dt(), daa_dt(), dlorenz_gauge_dt(), dpoly_dt(), dcctest_dt(), daatest_dt(), duutest_dt(), dlncc_dt(), dacc_dt(), duud_dt(), dndmd_dt(), dlnrhon_dt(), duun_dt(), addgravity(), addselfgrav(), decr_dt(), dfcr_dt(), dxy_chiral_dt(), dchemistry_dt(), dheatflux_dt(), dradiation_dt(), dspecial_dt(), dsolid_dt(), shearing(), particles_pde_pencil(), pointmasses_pde_pencil(), dtraining_dt(), phisum_mn_name_rz(), timing(), sum_mn(), update_for_time_integrals_hydro(), find_max_fvec(), find_rms_fvec(), dynamical_diffusion(), dynamical_resistivity(), dynamical_thermal_diffusion(), dynamical_viscosity(), impose_density_floor(), impose_density_ceiling(), impose_velocity_ceiling(), impose_energy_floor(), impose_dustdensity_floor(), impose_ecr_floor(), freeze_solid_cells(), fatal_error_local(), copy_farray_from_gpu(), before_boundary_gpu(), rhs_gpu(), update_ghosts(), impose_floors_ceilings(), special_after_timestep(), update_after_substep_gpu(), test_gpu_bcs(), die_gracefully()

subroutine equ/calc_all_module_diagnostic_auxiliaries(f, p)

Candidate implementation for the new concern of auxiliaries in snapshots. Subject to change.

Calculates those auxiliaries that are needed only for diagnostic purposes This subroutine exists because we need to compute the auxiliaries for the snapshot The intent is that the normal calc_diagnostics_<module> also computes the diagnostic auxiliaries But by splitting their computation to different subroutines we can recompute then when needed (as in the case of snapshots) This subroutine is only used for GPU runs.

15-mar-2026/TP: coded

Parameters:

f (,,*,*) [real,inout,contiguous]
p [pencil_case]

Use :

magnetic (calc_diagnostic_auxiliaries_magnetic()), diagnostics, hydro (hydro_restore_diagnostic_controls())

Call to:

subroutine equ/perform_diagnostics(f, p)

Called by the helper to perform the diagnostics when asked for them

Parameters:

f (,,*,*) [real,inout,contiguous]
p [pencil_case]

Use :

special (calc_ode_diagnostics_special()), equationofstate (ioncalc())

Called from:

helper_loop()

Call to:

subroutine equ/finalize_diagnostics()

Finalizes all module diagnostics by MPI communication. Result is only in (diagmaster of) root.

25-aug-23/TP: refactored from pde

Use :: diagnostics, hydro, magnetic, pscalar
Called from:: pde(), write_diagnostics(), calc_all_module_diagnostic_auxiliaries(), perform_diagnostics()
Call to:: diagnostic(), xyaverages_z(), xzaverages_y(), yzaverages_x(), phizaverages_r(), yaverages_xz(), zaverages_xy(), phiaverages_rz(), calc_mfield(), calc_mflow(), calc_mpscalar(), update_solid_cells_pencil(), get_grid_mn(), calc_phiavg_profile(), calc_pencils_density(), calc_pencils_pscalar(), calc_pencils_ascalar(), calc_pencils_shock(), calc_pencils_chemistry(), calc_pencils_energy(), calc_pencils_viscosity(), calc_pencils_interstellar(), calc_pencils_forcing(), calc_pencils_lorenz_gauge(), calc_pencils_magnetic(), calc_pencils_polymer(), calc_pencils_gravity(), calc_pencils_selfgravity(), calc_pencils_dustvelocity(), calc_pencils_dustdensity(), calc_pencils_neutralvelocity(), calc_pencils_neutraldensity(), calc_pencils_cosmicray(), calc_pencils_cosmicrayflux(), calc_pencils_chiral(), calc_pencils_radiation(), calc_pencils_shear(), calc_pencils_borderprofiles(), calc_pencils_pointmasses(), particles_calc_pencils(), calc_pencils_special(), calc_pencils_heatflux(), finalize_isendrcv_bdry(), boundconds_y(), boundconds_z(), interstellar_before_boundary(), shear_before_boundary(), hydro_before_boundary(), calc_selfpotential(), dustdensity_before_boundary(), density_before_boundary_diagnostics(), density_before_boundary(), magnetic_before_boundary(), energy_before_boundary(), chiral_before_boundary(), special_before_boundary(), testflow_before_boundary(), testfield_before_boundary(), particles_before_boundary(), pscalar_before_boundary(), detonate_before_boundary(), chemistry_before_boundary(), particles_special_bfre_bdary(), shock_before_boundary(), training_after_boundary(), mpiwtime(), radtransfer(), calc_shock_profile_simple(), hydro_after_boundary(), viscosity_after_boundary(), magnetic_after_boundary(), dustdensity_after_boundary(), energy_after_boundary(), gravity_after_boundary(), forcing_after_boundary(), calc_polymer_after_boundary(), testscalar_after_boundary(), testfield_after_boundary(), density_after_boundary(), neutraldensity_after_boundary(), calc_ltestflow_nonlin_terms(), meanfield_after_boundary(), special_after_boundary(), calc_for_chem_mixture(), prep_rhs_special(), max_mn_name(), xymax_mn_name_z(), time_integrals_hydro(), time_integrals_magnetic(), df_diagnos_hydro(), df_diagnos_magnetic(), duu_dt(), dlnrho_dt(), denergy_dt(), daa_dt(), dlorenz_gauge_dt(), dpoly_dt(), dcctest_dt(), daatest_dt(), duutest_dt(), dlncc_dt(), dacc_dt(), duud_dt(), dndmd_dt(), dlnrhon_dt(), duun_dt(), addgravity(), addselfgrav(), decr_dt(), dfcr_dt(), dxy_chiral_dt(), dchemistry_dt(), dheatflux_dt(), dradiation_dt(), dspecial_dt(), dsolid_dt(), shearing(), particles_pde_pencil(), pointmasses_pde_pencil(), dtraining_dt(), phisum_mn_name_rz(), timing(), sum_mn(), update_for_time_integrals_hydro(), find_max_fvec(), find_rms_fvec(), dynamical_diffusion(), dynamical_resistivity(), dynamical_thermal_diffusion(), dynamical_viscosity(), impose_density_floor(), impose_density_ceiling(), impose_velocity_ceiling(), impose_energy_floor(), impose_dustdensity_floor(), impose_ecr_floor(), freeze_solid_cells(), fatal_error_local(), copy_farray_from_gpu(), before_boundary_gpu(), rhs_gpu(), update_ghosts(), impose_floors_ceilings(), special_after_timestep(), update_after_substep_gpu(), test_gpu_bcs(), die_gracefully()

subroutine equ/debug_imn_arrays()

For debug purposes: writes out the mm, nn, and necessary arrays.

23-nov-02/axel: coded

subroutine equ/impose_floors_ceilings(f)

Impose floors or ceilings for implemented fields.

20-oct-14/ccyang: modularized from pde.