ADAM Documentation

Appearance

adam_prism_cpu_object ​

ADAM, PRISM (Plasma Research usIng Simulation Methods) equations system class definition, CPU backend.

Source: src/app/prism/cpu/adam_prism_cpu_object.F90

Dependencies

Contents ​

Variables ​

NameTypeAttributesDescription
compute_fluxes_maxwellprocedure(compute_convective_fluxes_interface)pointerCompute convective fluxes.
PML_FACE_X_Minteger(kind=I4P)parameter
PML_FACE_X_Pinteger(kind=I4P)parameter
PML_FACE_Y_Minteger(kind=I4P)parameter
PML_FACE_Y_Pinteger(kind=I4P)parameter
PML_FACE_Z_Minteger(kind=I4P)parameter
PML_FACE_Z_Pinteger(kind=I4P)parameter
GRMS_3DB_RATIOreal(kind=R8P)parameter

Derived Types ​

prism_cpu_object ​

Maxwell equations system class definition, CPU backend.

Inheritance

Extends: prism_common_object

Components ​

NameTypeAttributesDescription
iotype(io_object)IO handler.
amrtype(amr_object)AMR marker handler.
slicestype(slices_object)Slices handler.
blanesmoantype(blanesmoan_object)Blanes-Moan integrator.
cfmtype(cfm_object)Commutator-Free Magnus integrator.
leapfrogtype(leapfrog_object)Leapfrog integrator.
flailtype(flail_object)Linear algebra methods handler.
wenotype(weno_object)WENO reconstructor.
ibtype(ib_object)Immersed boundary.
rktype(rk_object)Runge-Kutta integrator.
adamtype(adam_object)ADAM, grid + tree + field + maps orchestrator.
fdv_schemecharacter(len=:)allocatableFDV scheme, fd/fv.
fdv_orderinteger(kind=I4P)Order of finite difference/volume schemes, general order.
fdv_half_stencilinteger(kind=I4P)Half stencil length of finite difference/volume schemes.
fdv_half_stencilsinteger(kind=I4P)Half stencil length of fdv schemes for each derivative up to 6.
ngcinteger(kind=I4P)pointerNumber of ghost cells.
niinteger(kind=I4P)pointerNumber of cells in i direction.
njinteger(kind=I4P)pointerNumber of cells in j direction.
nkinteger(kind=I4P)pointerNumber of cells in k direction.
nbinteger(kind=I4P)pointerTotal blocks number for MPI.
blocks_numberinteger(kind=I4P)pointerActual blocks number.
nvinteger(kind=I4P)pointerNumber of variables in q vector.
realm_indexinteger(kind=I4P)Inter-realm seam coupling — currently-published stage buffer key.
stage_activeinteger(kind=I4P)A copy of the forest's flux register (its faces and lookup, the accumulators unused), refreshed by the forest each
flux_register_copytype(flux_register_object)Procedure pointer TBPs for FDV operators (set at initialization by backend).
compute_block_total_variationprocedure(compute_block_total_variation_interface)pass(self), pointerCompute TV.
compute_curlprocedure(compute_curl_interface)pass(self), pointerCompute curl.
compute_curl_extendedprocedure(compute_curl_interface)pass(self), pointerCompute curl on extended support.
compute_derivative1procedure(compute_derivative1_interface)pass(self), pointerCompute deriv1.
compute_derivative2procedure(compute_derivative2_interface)pass(self), pointerCompute deriv2.
compute_derivative4procedure(compute_derivative4_interface)pass(self), pointerCompute deriv4.
compute_divergenceprocedure(compute_divergence_interface)pass(self), pointerCompute dive.
compute_gradientprocedure(compute_gradient_interface)pass(self), pointerCompute grad.
compute_gradient_extendedprocedure(compute_gradient_interface)pass(self), pointerCompute gradient on extended support.
compute_laplacianprocedure(compute_laplacian_interface)pass(self), pointerCompute laplac.
save_em_onlylogical[IO] save_fields = em: the XH5F output holds D and B only.
amr_locked_logicalAMR regrid lock (issue #22 GA6): set .true. by backends whose device/topology
nv_cinteger(kind=I4P)pointerNumber of conservative variables in q vector.
nv_sinteger(kind=I4P)pointerNumber of source variables in q vector.
nv_clinteger(kind=I4P)pointerNumber of divergence cleaning variables in q vector.
qreal(kind=R8P)allocatableConservative cell centered variables.
dqreal(kind=R8P)allocatableResiduals right hand side.
q_picreal(kind=R8P)allocatablePIC variables.
pic_fieldsreal(kind=R8P)allocatableFields value at particle locations.
curlreal(kind=R8P)allocatableCurl fields.
divergencereal(kind=R8P)allocatableDivergence fields.
q_nametype(string)allocatableFields names [1:nv].
dq_nametype(string)allocatableResiduals names [1:nv].
q_pic_nametype(string)allocatablePIC Fields names.
curl_nametype(string)allocatableCurl fields names.
div_nametype(string)allocatableDivergence fields names.
energy_Dreal(kind=R8P)allocatableEnergy of field D, time history.
energy_Breal(kind=R8P)allocatableEnergy of field B, time history.
coil_powerreal(kind=R8P)allocatablePower of coils, time history.
Poynting_fluxreal(kind=R8P)allocatableTotal Poynting flux from boundary, time history.
rms_energy_error_Dreal(kind=R8P)RMS energy error of D field.
rms_energy_error_Breal(kind=R8P)RMS energy error of B field.
max_divergence_Dreal(kind=R8P)Maximum of divergence of D field.
max_divergence_Breal(kind=R8P)Maximum of divergence of B field.
max_divergence_Jreal(kind=R8P)Maximum of divergence of J field.
single_particle_output_last_timereal(kind=R8P)Last time written to single-particle history.
single_particle_output_writtenlogicalSingle-particle history write sentinel.
bctype(prism_bc_object)Boundary conditions.
coiltype(prism_coil_object)Coil source term.
external_fieldstype(prism_external_fields_object)External fields.
fWLayertype(prism_fWLayer_object)Far-field weighted layer.
grmstype(prism_grms_object)Grms diagnostic.
ictype(prism_ic_object)Initial conditions.
leapfrog_pictype(prism_leapfrog_pic_object)Leapfrog PIC integrator.
magnetic_field_at_center_domaintype(prism_magnetic_field_at_center_domain_object)Domain-center B diagnostic.
numericstype(prism_numerics_object)Numerics configuration.
particle_injectiontype(prism_particle_injection_object)Particle injection.
physicstype(prism_physics_object)Physics configuration.
pictype(prism_pic_object)PIC state.
pmltype(prism_pml_object)Perfectly matched layer.
rk_pictype(prism_rk_pic_object)Runge-Kutta PIC handler.
rk_pmltype(prism_rk_pml_object)Runge-Kutta PML auxiliary handler.
timetype(prism_time_object)Time integration state.
flxyz_creal(kind=R8P)allocatableFluxes at cell center with +/- decomposition for all directions.
flx_freal(kind=R8P)allocatableFluxes along x at cell face.
fly_freal(kind=R8P)allocatableFluxes along y at cell face.
flz_freal(kind=R8P)allocatableFluxes along z at cell face.
charge_conservation_accreal(kind=R8P)allocatableAccumulator for rho/dt + weighted div(J) diagnostic.
charge_conservation_divjreal(kind=R8P)allocatableWorkspace for stage div(J) diagnostic.
direct_current_matrix_xreal(kind=R8P)allocatableCached factored x-line matrices for direct PIC current.
direct_current_matrix_yreal(kind=R8P)allocatableCached factored y-line matrices for direct PIC current.
direct_current_matrix_zreal(kind=R8P)allocatableCached factored z-line matrices for direct PIC current.
direct_current_dxyzreal(kind=R8P)allocatableGrid spacings used to build direct current matrices.
direct_current_pivot_xinteger(kind=I4P)allocatableCached x-line pivots for direct PIC current.
direct_current_pivot_yinteger(kind=I4P)allocatableCached y-line pivots for direct PIC current.
direct_current_pivot_zinteger(kind=I4P)allocatableCached z-line pivots for direct PIC current.
direct_current_cache_niinteger(kind=I4P)Cached x-line size.
direct_current_cache_njinteger(kind=I4P)Cached y-line size.
direct_current_cache_nkinteger(kind=I4P)Cached z-line size.
direct_current_cache_nbinteger(kind=I4P)Cached block count.
direct_current_cache_hsinteger(kind=I4P)Cached half-stencil.
direct_current_cache_esirkepovlogical
fv_add_phi_dampinglogicalApply phi damping in FV residuals.
fv_add_psi_dampinglogicalApply psi damping in FV residuals.
fv_ivar_phiinteger(kind=I4P)Phi slot index in FV residuals.
fv_ivar_psiinteger(kind=I4P)Psi slot index in FV residuals.
charge_conservation_error_maxreal(kind=R8P)Max continuity-equation residual over one PIC step.
current_solver_residual_maxreal(kind=R8P)Max residual of the direct current line solves.
charge_conservation_readylogicalTrue when the current PIC step has a finalized diagnostic.
compute_residualsprocedure(compute_residuals_interface)pass(self), pointerCompute residuals, space operator.
integrateprocedure(integrate_interface)pass(self), pointerIntegrate, time operator.

Type-Bound Procedures ​

NameAttributesDescription
load_fdv_from_filepass(self)Load FDV config from file.
runtime_amr_forestpass(self)Whether this realm regrids during the run (#74).
regrid_forestpass(self)Invoked by forest%regrid per realm per timestep (#74).
finalize_mpi_forestpass(self)Process-global MPI finalize; forest calls it ONCE after all.
after_topology_build_forestpass(self)Backend hook invoked once after the forest builds the seam maps.
close_block_xh5fnopassClose XH5F file block.
close_file_xh5fnopassClose XH5F file.
open_block_xh5fpass(self)Open block file XH5F.
open_file_xh5fpass(self)Open file XH5F.
save_q_xh5fpass(self)Save in XH5F (XDMF/HDF5) format.
compute_curl_fd_extendedpass(self)Compute curl of vector field, finite difference, even for half gcs.
compute_gradient_fd_extendedpass(self)Compute gradient of scalar field, finite difference, even for half
amr_updatepass(self)Do AMR update (init-time only where amr_locked_).
mark_by_geometrypass(self)Mark blocks to be refined by a primitive geometric box.
allocate_commonpass(self)Allocate common data.
compute_auxiliary_fieldspass(self)Compute auxiliary fields.
compute_fields_numberpass(self)Compute the block-sized fields allocated per block.
initializepass(self)Initialize the equation common data.
fold_deposited_ghostspass(self)Fold PIC deposits spilled into ghosts, locally and across ranks.
initialize_pic_time_zeropass(self)Host-side PIC particle injection plus charge/current deposition at t=0.
verify_no_pic_deposition_on_coilspass(self)Guard against PIC deposition on coil cells.
weight_pic_fields_time_zeropass(self)Host-side PIC field interpolation at t=0.
save_pic_self_force_diagnostic_time_zeropass(self)Temporary PIC self-force diagnostic at t=0.
load_restart_filespass(self)Load restart files.
save_energy_errorpass(self)Save energy error history.
save_energy_historypass(self)Save energy history.
save_coils_current_diagnosticspass(self)Save instantaneous coil-current diagnostics.
save_divergence_historypass(self)Save divergence history.
save_grms_historypass(self)Save Grms history.
save_magnetic_field_at_center_domain_historypass(self)Save domain-center B history.
save_restart_filespass(self)Save restart files.
save_slicespass(self)Save the slices on their cadence.
save_xh5fpass(self)Save simulation data in XH5F format.
initialize_coilspass(self)Initialize coils.
compute_coils_current_time_zeropass(self)Host-side coil current initialization at t=0.
impose_ct_correctionpass(self)Host-side constrained-transport projection on q(ivar:ivar+2).
impose_pic_fields_time_zeropass(self)Host-side elliptic initialization for PIC/current-driven fields.
set_rectangular_coil_xpass(self)Subroutine to set a rectangular coil source with +-x normal
set_rectangular_coil_ypass(self)Subroutine to set a rectangular coil source with +-y normal
set_rectangular_coil_zpass(self)Subroutine to set a rectangular coil source with +-z normal
set_circular_coil_xpass(self)Subroutine to set a circular coil source with +-x normal
set_circular_coil_ypass(self)Subroutine to set a circular coil source with +-y normal
set_circular_coil_zpass(self)Subroutine to set a circular coil source with +-z normal
set_solenoid_xpass(self)Subroutine to set a solenoid source with +-x normal
set_solenoid_ypass(self)Subroutine to set a solenoid source with +-y normal
set_solenoid_zpass(self)Subroutine to set a solenoid source with +-z normal
set_helicon_coilpass(self)Subroutine to set a helicon coil source.
compute_rectangular_current_flux_sidespass(self)Precompute rectangular side-current fluxes.
compute_helicon_current_flux_segmentspass(self)Precompute helicon segment-current fluxes.
coupling_descriptor_forestpass(self)Report (scheme_time, rk_scheme, nv) for β admissibility.
mark_by_j_vec_total_variationpass(self)
allocate_cpupass(self)Allocate CPU data.
initialize_prismpass(self)Initialize PRSIM equation.
save_residualspass(self)Save residuals history.
save_simulation_datapass(self)Save all simulation data.
apply_fWL_correctionpass(self)Apply fWLayer correction (if present)
compute_coils_currentpass(self)Compute current coils sources.
set_boundary_conditionspass(self)Set boundary conditions of equation.
set_initial_conditionspass(self)Set initial conditions (and coils) of equation.
update_ghostpass(self)Update ghost cells and set boundary conditions.
compute_field_mean_valuepass(self)Compute field mean value.
initialize_forestpass(self)Invoked by forest%initialize per realm at startup.
compute_local_dt_forestpass(self)Invoked by forest%compute_global_dt during the min reduction.
advance_one_step_forestpass(self)Invoked by forest%evolve_one_step per realm per timestep.
stages_per_step_forestpass(self)Number of integrator stages this realm exposes per step.
open_step_forestpass(self)Per-step prologue (multi-realm path).
begin_stage_forestpass(self)Begin one integrator stage on this realm (multi-realm path).
end_stage_forestpass(self)End the stage: residuals + assignment (multi-realm path).
close_step_forestpass(self)Per-step epilogue (multi-realm path).
post_step_forestpass(self)Invoked by forest%post_step per realm per timestep.
is_done_forestpass(self)Invoked by forest%is_done during the termination reduction.
finalize_forestpass(self)Invoked by forest%finalize per realm at shutdown.
fill_seam_from_peer_forestpass(self)Copy peer's interior into self's ghosts for peer slot p_idx.
pack_seam_cells_forestpass(self)Pack own cells of the cross-rank seam send rows.
unpack_seam_cells_forestpass(self)Unpack the cross-rank seam receive rows into own ghosts.
apply_reflux_to_stage_forestpass(self)Apply end-of-step Berger-Colella reflux to self's committed q.
initialize_charge_conservation_diagnosticpass(self)Initialize PIC continuity-equation diagnostic.
accumulate_charge_conservation_currentpass(self)Accumulate weighted stage div(J).
finalize_charge_conservation_diagnosticpass(self)Finalize PIC continuity-equation diagnostic.
save_charge_conservation_diagnosticpass(self)Save PIC charge-conservation diagnostic history.
compute_dtpass(self)Compute time step.
compute_energypass(self)Compute energy.
compute_energy_errorpass(self)Compute energy error.
compute_grmspass(self)Compute Grms of the rotating magnetic-field amplitude.
compute_magnetic_field_at_center_domainpass(self)Compute B at the domain center.
impose_div_freepass(self)Impose divergence-free property.
simulatepass(self)Perform the simulation.

Interfaces ​

compute_residuals_interface ​

integrate_interface ​

Subroutines ​

mark_by_j_vec_total_variation ​

Mark blocks to be refined/derefined by the value of total variation of j_vec.

fortran
subroutine mark_by_j_vec_total_variation(self, tv_tol, delta_type, delta_fine, delta_coarse, threshold, do_init)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.
tv_tolreal(kind=R8P)inTotal variation tolerance value.
delta_typecharacter(len=*)inDelta criterion type.
delta_finereal(kind=R8P)inMaximum cell delta in fine grids.
delta_coarsereal(kind=R8P)inMinimum cell delta in coarse grids.
thresholdreal(kind=R8P)inoptionalThreshold for sphere proximity.
do_initlogicalinoptionalRe-initialize refinements queries.

Call graph

allocate_cpu ​

Allocate CPU data.

fortran
subroutine allocate_cpu(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.

Call graph

initialize_prism ​

Initialize PRSIM equation.

fortran
subroutine initialize_prism(self, filename, realms_number)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.
filenamecharacter(len=*)inInput file name.
realms_numberinteger(kind=I4P)inoptionalForest realm count; divides the per-process budget (default 1).

Call graph

save_residuals ​

Save residuals history.

fortran
subroutine save_residuals(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.

Call graph

save_simulation_data ​

Save all simulation data.

fortran
subroutine save_simulation_data(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.

Call graph

compute_coils_current ​

Compute current coils sources (DC/AC with smooth envelope).

fortran
subroutine compute_coils_current(self, q, gamma)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout
qreal(kind=R8P)inout
gammareal(kind=R8P)inoptional

Call graph

apply_fWL_correction ​

Apply correction if a fWL is present

fortran
subroutine apply_fWL_correction(self, q)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.
qreal(kind=R8P)inoutConservative variables.

Call graph

set_boundary_conditions ​

Set boundary conditions of equation.

fortran
subroutine set_boundary_conditions(self, q, s)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.
qreal(kind=R8P)inoutConservative variables.
sinteger(kind=I4P)inoptionalStage counter.

Call graph

compute_face_mirror_indexes ​

Return the donor indexes mirrored across the selected boundary face.

fortran
subroutine compute_face_mirror_indexes(face, ni, nj, nk, i_gc, j_gc, k_gc, idelta, jdelta, kdelta, i_d, j_d, k_d)

Arguments

NameTypeIntentAttributesDescription
faceinteger(kind=I4P)inFace index in 1:6 numbering.
niinteger(kind=I4P)inGrid dimensions.
njinteger(kind=I4P)inGrid dimensions.
nkinteger(kind=I4P)inGrid dimensions.
i_gcinteger(kind=I4P)inGhost-cell indexes.
j_gcinteger(kind=I4P)inGhost-cell indexes.
k_gcinteger(kind=I4P)inGhost-cell indexes.
ideltainteger(kind=I4P)inOne-step inward deltas.
jdeltainteger(kind=I4P)inOne-step inward deltas.
kdeltainteger(kind=I4P)inOne-step inward deltas.
i_dinteger(kind=I4P)outMirrored donor indexes.
j_dinteger(kind=I4P)outMirrored donor indexes.
k_dinteger(kind=I4P)outMirrored donor indexes.

Call graph

enforce_silver_muller_normal_bc_cpu ​

fortran
subroutine enforce_silver_muller_normal_bc_cpu(self, q)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
qreal(kind=R8P)inout

Call graph

solve_silver_muller_normal_line_cpu ​

fortran
subroutine solve_silver_muller_normal_line_cpu(q, ngc, ni, nj, nk, b, face, i_seed, j_seed, k_seed, hs, dxyz, has_rho, var_rho)

Arguments

NameTypeIntentAttributesDescription
qreal(kind=R8P)inout
ngcinteger(kind=I4P)in
niinteger(kind=I4P)in
njinteger(kind=I4P)in
nkinteger(kind=I4P)in
binteger(kind=I4P)in
faceinteger(kind=I4P)in
i_seedinteger(kind=I4P)in
j_seedinteger(kind=I4P)in
k_seedinteger(kind=I4P)in
hsinteger(kind=I4P)in
dxyzreal(kind=R8P)in
has_rhologicalin
var_rhointeger(kind=I4P)in

Call graph

silver_muller_face_metadata_cpu ​

fortran
subroutine silver_muller_face_metadata_cpu(face, dir_t1, dir_t2, var_d_t1, var_d_t2, var_d_n, var_b_t1, var_b_t2, var_b_n)

Arguments

NameTypeIntentAttributesDescription
faceinteger(kind=I4P)in
dir_t1integer(kind=I4P)out
dir_t2integer(kind=I4P)out
var_d_t1integer(kind=I4P)out
var_d_t2integer(kind=I4P)out
var_d_ninteger(kind=I4P)out
var_b_t1integer(kind=I4P)out
var_b_t2integer(kind=I4P)out
var_b_ninteger(kind=I4P)out

Call graph

solve_silver_muller_normal_field_cpu ​

fortran
subroutine solve_silver_muller_normal_field_cpu(q, ngc, ni, nj, nk, b, face, i_seed, j_seed, k_seed, hs, dxyz, dir_t1, dir_t2, var_t1, var_t2, var_n, use_target_var, target_var)

Arguments

NameTypeIntentAttributesDescription
qreal(kind=R8P)inout
ngcinteger(kind=I4P)in
niinteger(kind=I4P)in
njinteger(kind=I4P)in
nkinteger(kind=I4P)in
binteger(kind=I4P)in
faceinteger(kind=I4P)in
i_seedinteger(kind=I4P)in
j_seedinteger(kind=I4P)in
k_seedinteger(kind=I4P)in
hsinteger(kind=I4P)in
dxyzreal(kind=R8P)in
dir_t1integer(kind=I4P)in
dir_t2integer(kind=I4P)in
var_t1integer(kind=I4P)in
var_t2integer(kind=I4P)in
var_ninteger(kind=I4P)in
use_target_varlogicalin
target_varinteger(kind=I4P)in

Call graph

interior_cell_from_face_cpu ​

fortran
subroutine interior_cell_from_face_cpu(face, eq, ni, nj, nk, i_seed, j_seed, k_seed, ic, jc, kc)

Arguments

NameTypeIntentAttributesDescription
faceinteger(kind=I4P)in
eqinteger(kind=I4P)in
niinteger(kind=I4P)in
njinteger(kind=I4P)in
nkinteger(kind=I4P)in
i_seedinteger(kind=I4P)in
j_seedinteger(kind=I4P)in
k_seedinteger(kind=I4P)in
icinteger(kind=I4P)out
jcinteger(kind=I4P)out
kcinteger(kind=I4P)out

Call graph

ghost_cell_from_face_cpu ​

fortran
subroutine ghost_cell_from_face_cpu(face, ghost_layer, ni, nj, nk, i_seed, j_seed, k_seed, ic, jc, kc)

Arguments

NameTypeIntentAttributesDescription
faceinteger(kind=I4P)in
ghost_layerinteger(kind=I4P)in
niinteger(kind=I4P)in
njinteger(kind=I4P)in
nkinteger(kind=I4P)in
i_seedinteger(kind=I4P)in
j_seedinteger(kind=I4P)in
k_seedinteger(kind=I4P)in
icinteger(kind=I4P)out
jcinteger(kind=I4P)out
kcinteger(kind=I4P)out

Call graph

set_initial_conditions ​

Set initial conditions and coils on field.

fortran
subroutine set_initial_conditions(self, is_restart)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.
is_restartlogicalinBranching sentinel for restart/non restart path.

Call graph

update_ghost ​

Update ghost cells (intra-realm only). If not specified all steps are performed, synchronous computation.

Inter-realm seam ghost cells are NO LONGER filled here: the forest's Phase 2 seam fill (between begin_stage and end_stage) populates them via the fill_seam_from_peer_forest TBP operating on the realm's currently-active buffer (selected internally via stage_active). The realm(:) optional dummy that used to thread through this signature has been retired.

fortran
subroutine update_ghost(self, q, step, s)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.
qreal(kind=R8P)inoutConservative variables.
stepinteger(kind=I4P)inoptionalStep to be perfordmed in asyncronous comp.
sinteger(kind=I4P)inoptionalStage counter.

Call graph

initialize_forest ​

Initialize this realm from scratch: PRISM init, IC injection (or restart load), initial ghost update, initial diagnostics dump, IO files open, plus PIC/leapfrog priming if those schemes are active.

Invoked by forest%initialize. The forest writes self%realm_index = is BEFORE calling this routine, so the body can already read the 1-based forest position from self%realm_index if needed. Pic residual computation

Integration of equations

fortran
subroutine initialize_forest(self, filename, realms_number, memory_avail, nv, verbose)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe realm.
filenamecharacter(len=*)inInput parameters file name.
realms_numberinteger(kind=I4P)inoptionalRealm count; divides the per-process budget.
memory_availreal(kind=R8P)inoptionalPer-process memory budget override.
nvinteger(kind=I4P)inoptionalNumber of field variables override.
verboselogicalinoptionalTrigger verbose output.

Call graph

compute_local_dt_forest ​

Compute this realm's local stability-limited dt (no MPI reduction).

Invoked by forest%compute_global_dt during the min reduction across all realms in the forest. The reduction itself is the orchestrator's job; this method computes only the value local to self.

fortran
subroutine compute_local_dt_forest(self, dt_local)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inThe realm.
dt_localreal(kind=R8P)outLocal stability-limited dt.

Call graph

advance_one_step_forest ​

Advance this realm by one full timestep of size dt.

Invoked by forest%evolve_one_step once per realm per timestep. Owns the integration itself, i.e. everything that turns q at time t into q at time t + dt.

fortran
subroutine advance_one_step_forest(self, dt)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe realm.
dtreal(kind=R8P)inTimestep size from the forest's global reduction.

Call graph

open_step_forest ​

Per-step prologue on the multi-realm path: set dt, init RK stages.

Mirrors the head of integrate_rk_ssp: external-field prelude (if active), rk%initialize_stages(q=self%q), and the per-step time bookkeeping advance_one_step_forest does inline (it increment, dt cap for time_max, self%time%dt update). Time advance and progress print run in close_step_forest, mirroring the legacy ordering.

fortran
subroutine open_step_forest(self, dt)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe realm.
dtreal(kind=R8P)inTimestep size from the forest.

Call graph

begin_stage_forest ​

Begin integrator stage k on the multi-realm path.

Mirrors the FIRST line of integrate_rk_ssp's substage body: rk%compute_stage(s=k, dt=self%time%dt [, phi=ib%phi]). This populates rk%q_rk(:,:,:,:,:,k) from previously computed substages and from self%q, and publishes the stage buffer to peers by setting self%stage_active = k. No ghost reads, no peer-realm access — peer realms may not yet have opened their stage-k buffer when this fires.

fortran
subroutine begin_stage_forest(self, k, K_total, dt, realm)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe realm.
kinteger(kind=I4P)inStage index (1..K_total).
K_totalinteger(kind=I4P)inForest-wide stage count for this step.
dtreal(kind=R8P)inTimestep size from the forest.
realmclass(realm_object)inouttarget, optionalSibling realms (contract parity).

Call graph

end_stage_forest ​

Close integrator stage k: residuals + stage assignment in one sweep.

fortran
subroutine end_stage_forest(self, k, K_total, dt, realm, flux_register)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe realm.
kinteger(kind=I4P)inStage index (1..K_total).
K_totalinteger(kind=I4P)inForest-wide stage count for this step.
dtreal(kind=R8P)inTimestep size from the forest.
realmclass(realm_object)inouttarget, optionalSibling realms (FNL parity only).
flux_registerclass(flux_register_object)inoutoptionalForest's flux register for FV reflux.

Call graph

close_step_forest ​

Per-step epilogue on the multi-realm path: q assembly, BC, div-clean, residual save, coil source refresh, time advance, progress print.

Mirrors the post-substage tail of integrate_rk_ssp: rk%update_q + update_q_BC + save_residuals + compute_coils_current + impose_div_free + external_fields add, plus the post-loop time advance + progress print that advance_one_step_forest does inline.

fortran
subroutine close_step_forest(self, dt)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe realm.
dtreal(kind=R8P)inTimestep size from the forest.

Call graph

fill_seam_from_peer_forest ​

Fill THIS realm's seam ghost cells for peer slot p_idx from peer's interior cells. Single-TBP roundtrip: walks the receiver's sorted seam-map slice for the peer, and for each row copies peer's INTERIOR(b_send, i_send, j_send, k_send, v) → self's GHOST (b_recv, i_recv, j_recv, k_recv, v) on the active conservative buffer (q when stage_active == 0, or rk%q_rk(:,...,stage_active) when active). The PEER's stage_active controls its read source; SELF's stage_active controls its write target.

select type(peer) is confined here — the only place that needs to know the peer's concrete backend type. Cross-backend mixing (CPU realm reading from FNL peer) is not supported and triggers error_stop.

fortran
subroutine fill_seam_from_peer_forest(self, peer, p_idx)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout
peerclass(realm_object)intarget
p_idxinteger(kind=I4P)in

Call graph

pack_seam_cells_forest ​

Pack the ghost values of the cross-rank seam send rows of peer slot p_idx from the active buffer (q when stage_active == 0, else the active stage of q_rk): cell copies, or the 2:1 interpolations and restrictions of a refined seam (issues #40, #52; adam_seam_exchange%pack_seam_rows).

fortran
subroutine pack_seam_cells_forest(self, p_idx, buf)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inThe realm.
p_idxinteger(kind=I4P)inPeer slot (the realm owning the ghosts).
bufreal(kind=R8P)outPacked values.

Call graph

unpack_seam_cells_forest ​

Unpack buf into this realm's seam ghosts of the cross-rank receive rows of peer slot p_idx, on the active buffer (issue #40; adam_seam_exchange%unpack_seam_rows).

fortran
subroutine unpack_seam_cells_forest(self, p_idx, buf)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe realm.
p_idxinteger(kind=I4P)inPeer slot (the realm owning the cells).
bufreal(kind=R8P)inPacked values.

Call graph

apply_reflux_to_stage_forest ​

PRISM-CPU override of the Berger-Colella reflux correction TBP.

α.r1 cadence: end-of-step barrier. The body fires exactly once per realm per step, at stage == self%rk%nrk (the realm's own final RK substage). Earlier stages return immediately as a no-op. The accumulators F_coarse(:,:,1) / F_fine_sum(:,:,1) hold the step flux sum_s beta_s F_s of each side (accumulate_seam_fluxes_fv fires at every stage, weighted by beta_s), i.e. the flux each side's committed update used, so the correction restores conservation to round-off; same-K and asymmetric-K realms alike, each side summing its own beta. This is the AMReX non-subcycled Reflux cadence.

For each face in flux_register where face%coarse_realm == self%realm_index, writes the per-cell correction q_rk(:, seam_cell, b_coarse, stage) += ark(stage) * sign * (dt / dx_coarse) * (F_coarse(:,:,1) - F_fine_sum(:,:,1)) on the matching one-cell-thick seam slice (i ∈ {1, ni} for x-normal faces, etc.). The third-axis index is hardcoded to 1 under α.r1 (register collapsed by M2); the stage parameter is retained on the signature for API stability and used only for the cadence gate and as the write target into self%rk%q_rk(:, ..., stage).

Empty-register / out-of-range guards short-circuit to a no-op, so a realm with no seam faces returns cleanly.

fortran
subroutine apply_reflux_to_stage_forest(self, stage, dt, flux_register)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe realm.
stageinteger(kind=I4P)inIntegrator stage 1..K_total.
dtreal(kind=R8P)inTime step.
flux_registerclass(flux_register_object)inForest's flux register.

Call graph

post_step_forest ​

Run PRISM-CPU's per-timestep post-step work: state IO, energy diagnostics, divergence diagnostics.

Invoked by forest%post_step. v1 implementation is the verbatim post- step block formerly inline in simulate — every action runs every step, since today's cadence is enforced inside the save_* routines themselves (e.g. save_simulation_data honours io%it_save). The do_* flags are signature-only for now: when the forest takes over cadence the flags will gate the individual calls. For now they are accepted but unused, preserving present-day behavior bit-for-bit.

dt, t, it are not consumed by the current body; they are on the contract so the forest can supply them once it owns time-state (today they are still read from the time module singleton).

realm is accepted on contract parity with FNL; unused on CPU.

fortran
subroutine post_step_forest(self, dt, t, it, do_save_state, do_save_residuals, do_save_restart, do_amr, realm)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe realm.
dtreal(kind=R8P)inTimestep size just advanced.
treal(kind=R8P)inSimulation time after the advance.
itinteger(kind=I4P)inIteration index after the advance.
do_save_statelogicalinoptionalSave state output this step.
do_save_residualslogicalinoptionalSave residuals output this step.
do_save_restartlogicalinoptionalSave restart dump this step.
do_amrlogicalinoptionalRun AMR update this step.
realmclass(realm_object)inouttarget, optionalSibling realms.

Call graph

is_done_forest ​

Decide whether this realm has reached its local termination criterion.

Invoked by forest%is_done. PRISM-CPU override: matches the legacy condition inline in simulate — terminate when either the simulated time has reached self%time%time_max (time-driven mode, it_max <= 0) or the iteration count has reached self%time%it_max (iteration-driven mode). Today the test reads time-state from the time module singleton, so self is unused; once the forest takes over time bookkeeping the body will consume self%time%* instead.

fortran
subroutine is_done_forest(self, done)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inThe realm.
donelogicaloutTrue if this realm is done evolving.

Call graph

finalize_forest ​

Shut this realm down: final state dump, close residuals/energy/ divergence history files, post-loop divergence diagnostics, finalize MPI handler.

Invoked by forest%finalize. v1 implementation is the verbatim post- loop block formerly inline in simulate. Behavior unchanged.

fortran
subroutine finalize_forest(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe realm.

Call graph

compute_dt ​

Compute the global stability-limited dt and store it on self%time%dt.

Body delegates the local computation to compute_local_dt_forest (orchestrator contract method), then performs the legacy MPI_ALLREDUCE on MPI_COMM_WORLD for backward compatibility with simulate. The forest's compute_global_dt will perform its own reduction, possibly on a per-realm sub-comm; the redundancy disappears once the legacy compute_dt is retired.

fortran
subroutine compute_dt(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.

Call graph

compute_energy ​

Compute energy.

fortran
subroutine compute_energy(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.

Call graph

compute_energy_error ​

Compute energy error.

fortran
subroutine compute_energy_error(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.

compute_grms ​

Compute the RMS gradient of the rotating magnetic-field amplitude over the selected domain and over its -3 dB subset.

fortran
subroutine compute_grms(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout

Call graph

compute_magnetic_field_at_center_domain ​

Compute the magnetic field interpolated at the geometrical domain center.

fortran
subroutine compute_magnetic_field_at_center_domain(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout

Call graph

compute_max_divergence_outside_absorbing_layers ​

Compute divergence maxima excluding absorbing layers and any cell whose centered-divergence stencil intersects them.

fortran
subroutine compute_max_divergence_outside_absorbing_layers(self, hs, max_div_D, max_div_B, max_div_J)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
hsinteger(kind=I4P)in
max_div_Dreal(kind=R8P)out
max_div_Breal(kind=R8P)out
max_div_Jreal(kind=R8P)out

Call graph

exclude_stencil_contaminated_face ​

Shrink a 1D diagnostic window so that no retained cell uses a centered divergence stencil intersecting the selected absorbing layer face.

Attributes: pure

fortran
subroutine exclude_stencil_contaminated_face(lo, hi, face_first, face_last, is_minus, hs)

Arguments

NameTypeIntentAttributesDescription
lointeger(kind=I4P)inout
hiinteger(kind=I4P)inout
face_firstinteger(kind=I4P)in
face_lastinteger(kind=I4P)in
is_minuslogicalin
hsinteger(kind=I4P)in

Call graph

impose_div_free ​

Impose divergence-free property.

fortran
subroutine impose_div_free(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.

Call graph

fortran
subroutine print_elliptic_progress(label, progress_done, progress_total, last_percent, converged)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inProgress label.
progress_doneinteger(kind=I4P)inCompleted smoothing sweeps.
progress_totalinteger(kind=I4P)inPlanned smoothing sweeps.
last_percentinteger(kind=I4P)inoutLast printed percent.
convergedlogicalinoptionalForce progress to 100% when converged.

Call graph

simulate ​

Perform the simulation: legacy single-realm entry point.

fortran
subroutine simulate(self, filename)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.
filenamecharacter(len=*)inInput file name.

Call graph

compute_residuals_fd_centered ​

Compute residuals of equation, space operator, centered finite difference schemes.

fortran
subroutine compute_residuals_fd_centered(self, q, dq, s, flux_register)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.
qreal(kind=R8P)inoutConservative variables.
dqreal(kind=R8P)inoutResiduals.
sinteger(kind=I4P)inoptionalStage counter.
flux_registerclass(flux_register_object)inoutoptionalFlux register.

Call graph

apply_pml_fd_centered_ade ​

Add ADE-PML source terms to the FD-centered Maxwell residuals and build the 12 auxiliary RHSs.

fortran
subroutine apply_pml_fd_centered_ade(self, q, dq, s)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout
qreal(kind=R8P)in
dqreal(kind=R8P)inout
sinteger(kind=I4P)inoptional

Call graph

apply_direct_damping ​

Apply diagnostic direct damping on components transverse to the selected PML normal.

fortran
subroutine apply_direct_damping(self, q, dq, block_ids, face)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
qreal(kind=R8P)in
dqreal(kind=R8P)inout
block_idsinteger(kind=I4P)in
faceinteger(kind=I4P)in

Call graph

select_pml_field_scales ​

Convert D/B derivatives into E/H derivatives for the current physical scaling.

fortran
subroutine select_pml_field_scales(self, inv_eps_scale, inv_mu_scale)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
inv_eps_scalereal(kind=R8P)out
inv_mu_scalereal(kind=R8P)out

Call graph

apply_x_face_field_correction ​

fortran
subroutine apply_x_face_field_correction(self, q, q_face, dq, block_ids, face, inv_eps_scale, inv_mu_scale)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
qreal(kind=R8P)in
q_facereal(kind=R8P)in
dqreal(kind=R8P)inout
block_idsinteger(kind=I4P)in
faceinteger(kind=I4P)in
inv_eps_scalereal(kind=R8P)in
inv_mu_scalereal(kind=R8P)in

Call graph

apply_y_face_field_correction ​

fortran
subroutine apply_y_face_field_correction(self, q, q_face, dq, block_ids, face, inv_eps_scale, inv_mu_scale)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
qreal(kind=R8P)in
q_facereal(kind=R8P)in
dqreal(kind=R8P)inout
block_idsinteger(kind=I4P)in
faceinteger(kind=I4P)in
inv_eps_scalereal(kind=R8P)in
inv_mu_scalereal(kind=R8P)in

Call graph

apply_z_face_field_correction ​

fortran
subroutine apply_z_face_field_correction(self, q, q_face, dq, block_ids, face, inv_eps_scale, inv_mu_scale)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
qreal(kind=R8P)in
q_facereal(kind=R8P)in
dqreal(kind=R8P)inout
block_idsinteger(kind=I4P)in
faceinteger(kind=I4P)in
inv_eps_scalereal(kind=R8P)in
inv_mu_scalereal(kind=R8P)in

Call graph

compute_x_face_pml_rhs ​

fortran
subroutine compute_x_face_pml_rhs(self, q, q_face, dq_face, block_ids, face, inv_eps_scale, inv_mu_scale)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
qreal(kind=R8P)in
q_facereal(kind=R8P)in
dq_facereal(kind=R8P)inout
block_idsinteger(kind=I4P)in
faceinteger(kind=I4P)in
inv_eps_scalereal(kind=R8P)in
inv_mu_scalereal(kind=R8P)in

Call graph

compute_y_face_pml_rhs ​

fortran
subroutine compute_y_face_pml_rhs(self, q, q_face, dq_face, block_ids, face, inv_eps_scale, inv_mu_scale)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
qreal(kind=R8P)in
q_facereal(kind=R8P)in
dq_facereal(kind=R8P)inout
block_idsinteger(kind=I4P)in
faceinteger(kind=I4P)in
inv_eps_scalereal(kind=R8P)in
inv_mu_scalereal(kind=R8P)in

Call graph

compute_z_face_pml_rhs ​

fortran
subroutine compute_z_face_pml_rhs(self, q, q_face, dq_face, block_ids, face, inv_eps_scale, inv_mu_scale)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
qreal(kind=R8P)in
q_facereal(kind=R8P)in
dq_facereal(kind=R8P)inout
block_idsinteger(kind=I4P)in
faceinteger(kind=I4P)in
inv_eps_scalereal(kind=R8P)in
inv_mu_scalereal(kind=R8P)in

Call graph

compute_pml_coefficients ​

Return the face-local ADE-PML coefficients for the supported variants.

Attributes: pure

fortran
subroutine compute_pml_coefficients(self, center_distance, span, gamma, alpha, kappa)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
center_distancereal(kind=R8P)in
spanreal(kind=R8P)in
gammareal(kind=R8P)out
alphareal(kind=R8P)out
kappareal(kind=R8P)out

Call graph

compute_residuals_fv_centered ​

Compute residuals of equation, space operator, centered finite volume schemes.

fortran
subroutine compute_residuals_fv_centered(self, q, dq, s, flux_register)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.
qreal(kind=R8P)inoutConservative variables.
dqreal(kind=R8P)inoutResiduals.
sinteger(kind=I4P)inoptionalStage counter.
flux_registerclass(flux_register_object)inoutoptionalForest's flux register; FV reflux.

Call graph

accumulate_seam_fluxes_fv ​

Accumulate the face fluxes of one RK stage, weighted by the stage's SSP coefficient weight = beta_s, on the seam faces of the FV-centered scheme.

Walks every (block, fec) pair and, for non-zero entries in self%adam%maps%inter_realm_face_register_index(b, fec), packs the appropriate flx_f/fly_f/flz_f face skin into a (nv, nface_cells) slab and routes it to the right register accumulator: positive index → coarse side → accumulate_coarse_flux, negative index → fine side → accumulate_fine_flux. The call site fires at every stage, so the register sums the stage fluxes into the step flux sum_s beta_s F_s of both sides.

The register accumulators are sized (nv, nface_cells, 1) under α.r1 (M2 reshape) with the full state-vector width nv (set at register_face time from realm%adam%field%nv). The FV scheme only fills the conservative slice 1:nv_c of the flux arrays; the remaining rows are left at zero in flux_slab so the register's F_coarse - F_fine_sum correction is identically zero outside the conservative variables. The third-axis index passed to accumulate_*_flux is hardcoded to 1 (collapsed register).

For a same-resolution mirror seam (rmf-2realm), each coarse and fine side carries an identical end-of-step flux; F_coarse - F_fine_sum is round-off zero in expectation and the downstream q-correction is a no-op. For a true 2:1 intra-realm AMR jump (#13 §7.5 M3) the coarse and fine sides differ:

  • Coarse side (sgn_idx > 0): packs its full nface_cells-cell face skin directly — the linear index c runs (inner axis fastest, outer axis slowest) over the coarse cells, exactly as before.
  • Fine side (sgn_idx < 0): each of the ratio/2 (4 in 3D) fine blocks covers ONE quadrant of the coarse face. Its nj*nk fine-face cells are 2:1-restricted (2x2 conservative average) onto the (nj/2)*(nk/2) coarse cells of that quadrant, written into the coarse-skin-shaped slab at the quadrant offset (zero elsewhere), then accumulated. The quadrant offset is read from maps%amr_seam_quadrant, precomputed at registration from the two blocks' Morton codes (issue #28 D2 — the coarse partner may live on another rank, so its geometry is not readable here). The fine blocks' accumulate_fine_flux calls sum into disjoint quadrants, so F_fine_sum ends up holding the area-averaged fine flux over the WHOLE coarse face, matching F_coarse's shape for the Berger-Colella delta.

Conservative 2:1 averaging (arithmetic mean of the 2x2 fine sub-faces) is the correct restriction for a face FLUX (Berger-Colella 1989 §4; Olivares 2019 Eq. 26-27): the coarse-face flux equals the average of the fine-face fluxes covering it, so the telescoping ∮F·n across the seam cancels to round-off.

The FD-centered case does not reach this routine (different residual target).

fortran
subroutine accumulate_seam_fluxes_fv(self, ni, nj, nk, nv_c, blocks_number, weight, flux_register)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe realm.
niinteger(kind=I4P)inInterior cell counts.
njinteger(kind=I4P)inInterior cell counts.
nkinteger(kind=I4P)inInterior cell counts.
nv_cinteger(kind=I4P)inNumber of conservative variables.
blocks_numberinteger(kind=I4P)inNumber of local blocks.
weightreal(kind=R8P)inStage weight, the SSP coefficient beta_s.
flux_registerclass(flux_register_object)inoutForest's flux register.

Call graph

compute_residuals_weno ​

Compute residuals of equation, space operator, WENO schemes.

fortran
subroutine compute_residuals_weno(self, q, dq, s, flux_register)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.
qreal(kind=R8P)inoutConservative variables.
dqreal(kind=R8P)inoutResiduals.
sinteger(kind=I4P)inoptionalStage counter.
flux_registerclass(flux_register_object)inoutoptionalFlux register.

Call graph

integrate_blanesmoan ​

Integrate equation, time operator, Yoshida RK scheme.

fortran
subroutine integrate_blanesmoan(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.

Call graph

integrate_cfm ​

Integrate equation, time operator, Commutator-Free Magnus integrator.

fortran
subroutine integrate_cfm(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.

Call graph

integrate_leapfrog ​

Integrate equation, time operator, leapfrog scheme.

fortran
subroutine integrate_leapfrog(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.

Call graph

integrate_leapfrog_pic ​

Integrate equation, time operator, leapfrog scheme for particle in cell Maxwell residuals computation Pic residual computation Integration of equations

fortran
subroutine integrate_leapfrog_pic(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.

Call graph

integrate_rk_ls ​

Integrate equation, time operator, RK classical low storage schemes. Low storage RK working on q_rk(:,:,:,:,:,1)/q as stages, update q in place.

fortran
subroutine integrate_rk_ls(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.

Call graph

integrate_rk_ssp ​

Integrate equation, time operator, SSP RK schemes. SSP RK working on q_rk as stages.

fortran
subroutine integrate_rk_ssp(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.

Call graph

integrate_rk_ssp_pic ​

Integrate equation, time operator, SSP RK schemes. SSP RK working on q_rk as stages.

fortran
subroutine integrate_rk_ssp_pic(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.

Call graph

integrate_rk_ssp_pic_charge_conserving ​

Integrate PIC equations with SSP RK and charge-conserving current reconstruction.

fortran
subroutine integrate_rk_ssp_pic_charge_conserving(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout

Call graph

compute_pic_charge_displacement_decomposition ​

Directional telescopic decomposition of rho(q_to)-rho(q_ref), using the configured particle shape.

fortran
subroutine compute_pic_charge_displacement_decomposition(self, q_ref, q_to, q_work, h_dir)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout
q_refreal(kind=R8P)in
q_toreal(kind=R8P)in
q_workreal(kind=R8P)inout
h_dirreal(kind=R8P)inout

Call graph

compute_pic_esirkepov_displacement ​

Symmetric Esirkepov density decomposition for the same separable shape used by rho.

fortran
subroutine compute_pic_esirkepov_displacement(self, q_ref, q_to, h_dir, particle)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
q_refreal(kind=R8P)in
q_toreal(kind=R8P)in
h_dirreal(kind=R8P)inout
particleinteger(kind=I4P)inoptional

Call graph

compute_esirkepov_gaussian_shape_1d ​

Normalize the filtered Gaussian on the endpoint's own deposition stencil. Its tensor product equals Gaussian_charge_weighting's 3D normalization up to roundoff.

fortran
subroutine compute_esirkepov_gaussian_shape_1d(self, x, x_cell, dx, ip, radius, lo, hi, w)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
xreal(kind=R8P)in
x_cellreal(kind=R8P)in
dxreal(kind=R8P)in
ipinteger(kind=I4P)in
radiusinteger(kind=I4P)in
lointeger(kind=I4P)in
hiinteger(kind=I4P)in
wreal(kind=R8P)out

Call graph

esirkepov_shape_weight_1d ​

Apply the optional binomial filter to the B-spline before computing particle fluxes.

fortran
subroutine esirkepov_shape_weight_1d(self, x, xc, dx, w)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
xreal(kind=R8P)in
xcreal(kind=R8P)in
dxreal(kind=R8P)in
wreal(kind=R8P)out

Call graph

deposit_pic_charge_density ​

Deposit charge density for an arbitrary PIC position array.

fortran
subroutine deposit_pic_charge_density(self, q_pic_pos, q_work)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout
q_pic_posreal(kind=R8P)in
q_workreal(kind=R8P)inout

Call graph

initialize_charge_conservation_diagnostic ​

Initialize rho_n/dt + sum_s beta_s div(J_s) diagnostic accumulator.

fortran
subroutine initialize_charge_conservation_diagnostic(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout

Call graph

accumulate_charge_conservation_current ​

Accumulate beta_s div(J_s) for the current PIC RK stage.

fortran
subroutine accumulate_charge_conservation_current(self, q, weight)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout
qreal(kind=R8P)inout
weightreal(kind=R8P)in

Call graph

finalize_charge_conservation_diagnostic ​

Finalize max |(rho_np1-rho_n)/dt + sum_s beta_s div(J_s)|.

fortran
subroutine finalize_charge_conservation_diagnostic(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout

Call graph

save_charge_conservation_diagnostic ​

Save the 12-column PIC charge-conservation diagnostic for the current completed step.

fortran
subroutine save_charge_conservation_diagnostic(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout

Call graph

solve_pic_charge_conserving_current_dispatch ​

Select the configured charge-conserving current reconstruction.

fortran
subroutine solve_pic_charge_conserving_current_dispatch(self, q, hq)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout
qreal(kind=R8P)inout
hqreal(kind=R8P)in

Call graph

ensure_esirkepov_current_solver_cache ​

Factor the interior face map plus one checkerboard constraint per line.

fortran
subroutine ensure_esirkepov_current_solver_cache(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout

Call graph

solve_pic_charge_conserving_current_esirkepov ​

Integrate Esirkepov's directional charge changes to faces and invert D=G A.

fortran
subroutine solve_pic_charge_conserving_current_esirkepov(self, q, hq)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout
qreal(kind=R8P)inout
hqreal(kind=R8P)in

Call graph

modified_kernels ​

P = A Q maps the base-shape nodes to centers, Q maps the face prefix sums to centers (A2 = [1,1]/2 for FD2, A6 = [1,-8,37,37,-8,1]/60 for FD6, so that D J = P H). Even Q: base on centers, P odd and centered, Q from faces. Odd Q: base on the dual nodes (node m at x_m+dx/2, see modified_position_shift), P even with taps m=i-N/2-2..i+N/2+2, Q centered on the prefix sums at centers (flux index f = center-1). radius bounds the taps of P (plus one if odd).

fortran
subroutine modified_kernels(self, p, qw, radius, qfirst, nq)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
preal(kind=R8P)out
qwreal(kind=R8P)out
radiusinteger(kind=I4P)out
qfirstinteger(kind=I4P)out
nqinteger(kind=I4P)out

Call graph

filter_modified_axis ​

Zero extension is used only outside the block; supported particles stay in the bulk.

fortran
subroutine filter_modified_axis(input, output, axis, p, radius)

Arguments

NameTypeIntentAttributesDescription
inputreal(kind=R8P)in
outputreal(kind=R8P)out
axisinteger(kind=I4P)in
preal(kind=R8P)in
radiusinteger(kind=I4P)in

Call graph

deposit_pic_modified_charge ​

Deposit the unfiltered particle shape, then apply P_c=Q A in all directions.

fortran
subroutine deposit_pic_modified_charge(self, q)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout
qreal(kind=R8P)inout

Call graph

initialize_pic_conserving_current_time_zero ​

Deposit the current at t=0 using the same trajectory operator as the PIC evolution.

fortran
subroutine initialize_pic_conserving_current_time_zero(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout

Call graph

check_conserving_single_block ​

The CPU charge-conserving current is single-block by design (line solves and P/Q filters per block); the multi-block version is FNL-only (prism_fnl_pic_conserving_object, virtual-block solves).

fortran
subroutine check_conserving_single_block(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in

Call graph

modified_current_line ​

F^E is the face prefix sum of the directional Esirkepov charge change.

fortran
subroutine modified_current_line(self, source, dir, b, n, qw, qfirst, nq, sol)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout
sourcereal(kind=R8P)in
dirinteger(kind=I4P)in
binteger(kind=I4P)in
ninteger(kind=I4P)in
qwreal(kind=R8P)in
qfirstinteger(kind=I4P)in
nqinteger(kind=I4P)in
solreal(kind=R8P)out

Call graph

solve_pic_charge_conserving_current_modified ​

J_d=Q_d P_transverse F_d^E; no inverse reconstruction or line solve.

fortran
subroutine solve_pic_charge_conserving_current_modified(self, q, hq)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout
qreal(kind=R8P)inout
hqreal(kind=R8P)in

Call graph

solve_modified_current_with_cleanup ​

Reconstruct one particle's SSP source at a time, clean its matched current, then accumulate.

fortran
subroutine solve_modified_current_with_cleanup(self, q, q_ref, q_to_history, active_stage, mixed_source)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout
qreal(kind=R8P)inout
q_refreal(kind=R8P)in
q_to_historyreal(kind=R8P)in
active_stageinteger(kind=I4P)in
mixed_sourcereal(kind=R8P)inoptional

Call graph

cleanup_modified_particle_current ​

Zero only sub-threshold leakage outside the exact P/Q-expanded source support.

fortran
subroutine cleanup_modified_particle_current(self, q_particle, particle, block, shape_lo, shape_hi)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
q_particlereal(kind=R8P)inout
particleinteger(kind=I4P)in
blockinteger(kind=I4P)in
shape_lointeger(kind=I4P)in
shape_hiinteger(kind=I4P)in

Call graph

report_particle_tail_error ​

fortran
subroutine report_particle_tail_error(particle, component, block, i, j, k, value, j_ref, ratio, lo, hi)

Arguments

NameTypeIntentAttributesDescription
particleinteger(kind=I4P)in
componentinteger(kind=I4P)in
blockinteger(kind=I4P)in
iinteger(kind=I4P)in
jinteger(kind=I4P)in
kinteger(kind=I4P)in
valuereal(kind=R8P)in
j_refreal(kind=R8P)in
ratioreal(kind=R8P)in
lointeger(kind=I4P)in
hiinteger(kind=I4P)in

Call graph

build_esirkepov_face_line ​

fortran
subroutine build_esirkepov_face_line(self, source, dir, b, n, flux)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout
sourcereal(kind=R8P)in
dirinteger(kind=I4P)in
binteger(kind=I4P)in
ninteger(kind=I4P)in
fluxreal(kind=R8P)out

Call graph

update_esirkepov_face_residual ​

Check the reconstructed flux on both boundary faces and every interior face.

fortran
subroutine update_esirkepov_face_residual(self, n, sol, flux)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout
ninteger(kind=I4P)in
solreal(kind=R8P)in
fluxreal(kind=R8P)in

Call graph

ensure_direct_current_solver_cache ​

Build cached factored line matrices for the direct conserving-current solver.

fortran
subroutine ensure_direct_current_solver_cache(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout

Call graph

solve_pic_charge_conserving_current ​

Reconstruct J from D_alpha J_alpha = -H_alpha(Q)/dt with homogeneous ghost-cell values.

fortran
subroutine solve_pic_charge_conserving_current(self, q, hq)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout
qreal(kind=R8P)inout
hqreal(kind=R8P)in

Call graph

find_pic_position_cell ​

Locate one PIC position on the local Cartesian block grid.

fortran
subroutine find_pic_position_cell(self, q_pos, b, i, j, k)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
q_posreal(kind=R8P)in
binteger(kind=I4P)out
iinteger(kind=I4P)out
jinteger(kind=I4P)out
kinteger(kind=I4P)out

Call graph

particle_weighting_radius ​

Integer support radius for the configured particle shape.

fortran
subroutine particle_weighting_radius(self, b, rx, ry, rz)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
binteger(kind=I4P)in
rxinteger(kind=I4P)out
ryinteger(kind=I4P)out
rzinteger(kind=I4P)out

Call graph

particle_shape_weight_1d ​

One-dimensional particle shape used by the PIC charge deposition.

fortran
subroutine particle_shape_weight_1d(self, model, x, xc, dx, w, cutoff_limit)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
modelcharacter(len=*)in
xreal(kind=R8P)in
xcreal(kind=R8P)in
dxreal(kind=R8P)in
wreal(kind=R8P)out
cutoff_limitreal(kind=R8P)inoptional

Call graph

build_centered_reconstruction_matrix ​

Build face-reconstruction matrix R such that FD1_CC J = (R_{i+1/2}-R_{i-1/2})/dx.

fortran
subroutine build_centered_reconstruction_matrix(self, n, a)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
ninteger(kind=I4P)in
areal(kind=R8P)inout

Call graph

build_centered_derivative_matrix ​

fortran
subroutine build_centered_derivative_matrix(self, dir, b, n, a)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
dirinteger(kind=I4P)in
binteger(kind=I4P)in
ninteger(kind=I4P)in
areal(kind=R8P)inout

Call graph

factorize_matrix_pivot ​

fortran
subroutine factorize_matrix_pivot(a, pivot, n)

Arguments

NameTypeIntentAttributesDescription
areal(kind=R8P)inout
pivotinteger(kind=I4P)out
ninteger(kind=I4P)in

Call graph

solve_factored_matrix_pivot ​

fortran
subroutine solve_factored_matrix_pivot(a, pivot, rhs, sol, n)

Arguments

NameTypeIntentAttributesDescription
areal(kind=R8P)in
pivotinteger(kind=I4P)in
rhsreal(kind=R8P)in
solreal(kind=R8P)out
ninteger(kind=I4P)in

Call graph

update_current_line_solver_residual ​

Update max residual |D_alpha sol - target| for one direct current line solve.

fortran
subroutine update_current_line_solver_residual(self, dir, b, n, sol, target)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inout
dirinteger(kind=I4P)in
binteger(kind=I4P)in
ninteger(kind=I4P)in
solreal(kind=R8P)in
targetreal(kind=R8P)in

Call graph

odd_mirror_index ​

fortran
subroutine odd_mirror_index(idx, n, col, sgn)

Arguments

NameTypeIntentAttributesDescription
idxinteger(kind=I4P)in
ninteger(kind=I4P)in
colinteger(kind=I4P)out
sgnreal(kind=R8P)out

Call graph

impose_zero_current_ghosts ​

fortran
subroutine impose_zero_current_ghosts(self, q)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
qreal(kind=R8P)inout

Call graph

impose_odd_current_ghosts ​

Zero normal face flux: J outside the face is the odd mirror of J inside.

fortran
subroutine impose_odd_current_ghosts(self, q)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
qreal(kind=R8P)inout

Call graph

integrate_rk_yoshida ​

Integrate equation, time operator, Yoshida RK scheme.

fortran
subroutine integrate_rk_yoshida(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inoutThe equation.

Call graph

compute_dxyz_min ​

Compute minimum dxyz space step.

fortran
subroutine compute_dxyz_min(blocks_number, dxyz, dxyz_min)

Arguments

NameTypeIntentAttributesDescription
blocks_numberinteger(kind=I4P)inNumber of blocks.
dxyzreal(kind=R8P)inXYZ space steps.
dxyz_minreal(kind=R8P)outMinimum space step.

Call graph

compute_fluxes_convective_weno ​

Compute convective fluxes along direction dir, WENO scheme for space operator.

fortran
subroutine compute_fluxes_convective_weno(dir, blocks_number, ni, nj, nk, ngc, nv_c, weno_s, weno_a, weno_p, weno_d, weno_c, weno_zeps, weno_sigma, evmax, erw, elw, chi, q, fluxes)

Arguments

NameTypeIntentAttributesDescription
dirinteger(kind=I4P)inDirection, 1=X, 2=Y, 3=Z.
blocks_numberinteger(kind=I4P)inNumber of blocks.
niinteger(kind=I4P)inGrid cells number in I direction.
njinteger(kind=I4P)inGrid cells number in J direction.
nkinteger(kind=I4P)inGrid cells number in K direction.
ngcinteger(kind=I4P)inGhost cells number.
nv_cinteger(kind=I4P)inNumber of conservative varibales.
weno_sinteger(kind=I4P)inWeno stencils number/dimension.
weno_areal(kind=R8P)inOptimal weights.
weno_preal(kind=R8P)inPolinomials coefficients.
weno_dreal(kind=R8P)inSmoothness indicators coefficients.
weno_creal(kind=R8P)inCentered polinomials coefficients.
weno_zepsreal(kind=R8P)inParameter for avoiding division by zero in computing IS.
weno_sigmareal(kind=R8P)inWENO descaler switch (0 Jiang-Shu, 1 scale-invariant).
evmaxreal(kind=R8P)inMaximum waves speed estimation.
erwreal(kind=R8P)inRight eigenvectors for WENO reconstruction.
elwreal(kind=R8P)inLeft eigenvectors for WENO reconstruction.
chireal(kind=R8P)inSpeed parameter for divergence cleaning.
qreal(kind=R8P)inField variables.
fluxesreal(kind=R8P)inoutFluxes.

Call graph

compute_fluxes_convective_ri_weno ​

Compute convective fluxes at right interface of b,i,j,k.

fortran
subroutine compute_fluxes_convective_ri_weno(dir, b, i, j, k, ngc, nv_c, weno_s, weno_zeps, weno_sigma, weno_a, weno_p, weno_d, weno_c, evmax, erw, elw, chi, si, sir, q, fluxes)

Arguments

NameTypeIntentAttributesDescription
dirinteger(kind=I4P)inDirection, 1=X, 2=Y, 3=Z.
binteger(kind=I4P)inCounter.
iinteger(kind=I4P)inCounter.
jinteger(kind=I4P)inCounter.
kinteger(kind=I4P)inCounter.
ngcinteger(kind=I4P)inGhost cells number.
nv_cinteger(kind=I4P)inNumber of conservative varibales in q vector.
weno_sinteger(kind=I4P)inWeno stencils number/dimension.
weno_zepsreal(kind=R8P)inParameter to avoid division by zero.
weno_sigmareal(kind=R8P)inWENO descaler switch (0 Jiang-Shu, 1 SI).
weno_areal(kind=R8P)inOptimal weights.
weno_preal(kind=R8P)inPolinomials coefficients.
weno_dreal(kind=R8P)inSmoothness indicators coefficients.
weno_creal(kind=R8P)inCentered polinomials coefficients.
evmaxreal(kind=R8P)inMaximum waves speed estimation.
erwreal(kind=R8P)inRight eigenvectors for WENO reconstruction.
elwreal(kind=R8P)inLeft eigenvectors for WENO reconstruction.
chireal(kind=R8P)inSpeed parameter for divergence cleaning.
siinteger(kind=I4P)inStencil increment.
sirreal(kind=R8P)inStencil increment, real cast.
qreal(kind=R8P)inFields variables.
fluxesreal(kind=R8P)inoutFluxes.

Call graph

compute_fluxes_difference ​

Compute fluxes difference.

fortran
subroutine compute_fluxes_difference(blocks_number, ni, nj, nk, ngc, nv_c, var_Jx, var_Jy, var_Jz, phi_ivar, psi_ivar, rho_ivar, use_rho, chi_wave2, alpha, dx, dy, dz, flx, fly, flz, q, dq)

Arguments

NameTypeIntentAttributesDescription
blocks_numberinteger(kind=I4P)inNumber of blocks.
niinteger(kind=I4P)inGrid cells number in I direction.
njinteger(kind=I4P)inGrid cells number in J direction.
nkinteger(kind=I4P)inGrid cells number in K direction.
ngcinteger(kind=I4P)inGhost cells number.
nv_cinteger(kind=I4P)inNumber of conservative varibales in q.
var_Jxinteger(kind=I4P)inCurrent variable indices.
var_Jyinteger(kind=I4P)inCurrent variable indices.
var_Jzinteger(kind=I4P)inCurrent variable indices.
phi_ivarinteger(kind=I4P)in
psi_ivarinteger(kind=I4P)in
rho_ivarinteger(kind=I4P)in
use_rhologicalin
chi_wave2real(kind=R8P)in
alphareal(kind=R8P)in
dxreal(kind=R8P)inSpace steps.
dyreal(kind=R8P)inSpace steps.
dzreal(kind=R8P)inSpace steps.
flxreal(kind=R8P)inX direction fluxes.
flyreal(kind=R8P)inY direction fluxes.
flzreal(kind=R8P)inZ direction fluxes.
qreal(kind=R8P)inFields.
dqreal(kind=R8P)inoutFluxes differences.

Call graph

decompose_fluxes_convective ​

Decompose convective fluxes.

fortran
subroutine decompose_fluxes_convective(dir, si, sir, b, i, j, k, ngc, nv_c, weno_s, evmax, elw, q, chi, fmpc)

Arguments

NameTypeIntentAttributesDescription
dirinteger(kind=I4P)inDirection, 1=X, 2=Y, 3=Z.
siinteger(kind=I4P)inStencil increment.
sirreal(kind=R8P)inStencil increment, real cast.
binteger(kind=I4P)inCounter.
iinteger(kind=I4P)inCounter.
jinteger(kind=I4P)inCounter.
kinteger(kind=I4P)inCounter.
ngcinteger(kind=I4P)inGhost cells number.
nv_cinteger(kind=I4P)inNumber of conservative varibales in q vector.
weno_sinteger(kind=I4P)inWeno stencils number/dimension.
evmaxreal(kind=R8P)inMaximum eigenvalue.
elwreal(kind=R8P)inLeft eigenvectors for WENO reconstruction.
qreal(kind=R8P)inAuxiliary variables.
chireal(kind=R8P)inSpeed coefficient for D & B div-cleaning.
fmpcreal(kind=R8P)inoutFluxes -+ decomposition in characteristics space.

Call graph

compute_field_mean_value ​

Compute mean value of the field in a certain region of the domain.

fortran
subroutine compute_field_mean_value(self, q, n_x, n_y, n_z, n_b, mean_value)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inThe object
qreal(kind=R8P)inField variables.
n_xinteger(kind=I4P)inNumber of cells in each direction and number
n_yinteger(kind=I4P)inNumber of cells in each direction and number
n_zinteger(kind=I4P)inNumber of cells in each direction and number
n_binteger(kind=I4P)inNumber of cells in each direction and number
mean_valuereal(kind=R8P)outMean value of the field out of the fWLayer

Functions ​

is_face_line_seed_cpu ​

Attributes: pure

Returns: logical

fortran
function is_face_line_seed_cpu(face, i, j, k, ni, nj, nk) result(is_seed)

Arguments

NameTypeIntentAttributesDescription
faceinteger(kind=I4P)in
iinteger(kind=I4P)in
jinteger(kind=I4P)in
kinteger(kind=I4P)in
niinteger(kind=I4P)in
njinteger(kind=I4P)in
nkinteger(kind=I4P)in

Call graph

face_normal_direction_cpu ​

Attributes: pure

Returns: integer(kind=i4p)

fortran
function face_normal_direction_cpu(face) result(dir_n)

Arguments

NameTypeIntentAttributesDescription
faceinteger(kind=I4P)in

Call graph

silver_muller_unknown_coefficient_cpu ​

Attributes: pure

Returns: real(kind=r8p)

fortran
function silver_muller_unknown_coefficient_cpu(face, m, hs, ds) result(coeff)

Arguments

NameTypeIntentAttributesDescription
faceinteger(kind=I4P)in
minteger(kind=I4P)in
hsinteger(kind=I4P)in
dsreal(kind=R8P)in

Call graph

tangential_divergence_at_cell_cpu ​

Attributes: pure

Returns: real(kind=r8p)

fortran
function tangential_divergence_at_cell_cpu(q, ngc, b, i, j, k, hs, dxyz, dir_t1, dir_t2, var_t1, var_t2) result(div_t)

Arguments

NameTypeIntentAttributesDescription
qreal(kind=R8P)in
ngcinteger(kind=I4P)in
binteger(kind=I4P)in
iinteger(kind=I4P)in
jinteger(kind=I4P)in
kinteger(kind=I4P)in
hsinteger(kind=I4P)in
dxyzreal(kind=R8P)in
dir_t1integer(kind=I4P)in
dir_t2integer(kind=I4P)in
var_t1integer(kind=I4P)in
var_t2integer(kind=I4P)in

Call graph

normal_known_contribution_cpu ​

Attributes: pure

Returns: real(kind=r8p)

fortran
function normal_known_contribution_cpu(q, ngc, ni, nj, nk, b, face, i, j, k, hs, dxyz, var_n) result(div_n_known)

Arguments

NameTypeIntentAttributesDescription
qreal(kind=R8P)in
ngcinteger(kind=I4P)in
niinteger(kind=I4P)in
njinteger(kind=I4P)in
nkinteger(kind=I4P)in
binteger(kind=I4P)in
faceinteger(kind=I4P)in
iinteger(kind=I4P)in
jinteger(kind=I4P)in
kinteger(kind=I4P)in
hsinteger(kind=I4P)in
dxyzreal(kind=R8P)in
var_ninteger(kind=I4P)in

Call graph

normal_depth_from_cell_cpu ​

Attributes: pure

Returns: integer(kind=i4p)

fortran
function normal_depth_from_cell_cpu(face, i, j, k, ni, nj, nk) result(depth)

Arguments

NameTypeIntentAttributesDescription
faceinteger(kind=I4P)in
iinteger(kind=I4P)in
jinteger(kind=I4P)in
kinteger(kind=I4P)in
niinteger(kind=I4P)in
njinteger(kind=I4P)in
nkinteger(kind=I4P)in

Call graph

component_along_direction_cpu ​

Attributes: pure

Returns: real(kind=r8p)

fortran
function component_along_direction_cpu(q, ngc, b, var, dir, i, j, k, offset) result(value_)

Arguments

NameTypeIntentAttributesDescription
qreal(kind=R8P)in
ngcinteger(kind=I4P)in
binteger(kind=I4P)in
varinteger(kind=I4P)in
dirinteger(kind=I4P)in
iinteger(kind=I4P)in
jinteger(kind=I4P)in
kinteger(kind=I4P)in
offsetinteger(kind=I4P)in

Call graph

stages_per_step_forest ​

Number of integrator stages this realm exposes per step.

For the multi-realm path the forest drives the stage loop, so it needs to know K up front. ONLY runge-kutta-ssp-* is split into per-stage TBPs (begin_stage_forest / end_stage_forest): the staged protocol reads gamm(k) per stage and applies beta(:) in close_step_forest — coefficients the low-storage schemes do not even allocate (issue #25: LS schemes used to pass this gate silently and crash/corrupt far downstream on both backends). The forest queries this TBP only on the STAGED branch, so refusing here leaves the fused N=1/no-seam fast path — where LS schemes legitimately run — untouched. Other integrators (Yoshida, Leapfrog, Blanes-Moan, CFM) must error-stop here as well when they become selectable.

Returns: integer(kind=I4P)

fortran
function stages_per_step_forest(self) result(K)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)inThe realm.

Call graph

compute_pml_kappa ​

Attributes: pure

Returns: real(kind=r8p)

fortran
function compute_pml_kappa(self, center_distance, span) result(kappa)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in
center_distancereal(kind=R8P)in
spanreal(kind=R8P)in

Call graph

modified_filter_radius ​

Cells reached by the P filter, plus one for the half-cell shift of the odd filters (boundary margin).

Returns: integer(kind=i4p)

fortran
function modified_filter_radius(self) result(radius)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in

Call graph

modified_position_shift ​

Odd esirkepov_Q<N> deposit the base shape on the dual nodes x_c+dx/2 (P has an even number of taps, dual nodes to centers): this equals the regular deposit of the particle at x-dx/2. Zero for the even filters and the other solvers.

Returns: real(kind=R8P)

fortran
function modified_position_shift(self) result(shift)

Arguments

NameTypeIntentAttributesDescription
selfclass(prism_cpu_object)in

Call graph

dotproduct ​

Compute the scalar (dot) product.

Returns: real(kind=R8P)

fortran
function dotproduct(a, b) result(dot)

Arguments

NameTypeIntentAttributesDescription
areal(kind=R8P)inLeft hand side.
breal(kind=R8P)inLeft hand side.

Call graph

crossproduct ​

Returns: real(kind=R8P)

fortran
function crossproduct(a, b) result(cross)

Arguments

NameTypeIntentAttributesDescription
areal(kind=R8P)inLeft hand side.
breal(kind=R8P)inLeft hand side.

Call graph