f_source.hpp File Reference

#include "sml.hpp"
#include "plasma.hpp"
#include "perturbed_B_field.hpp"
#include "sources.hpp"
#include "pseudo_inverse.hpp"
#include "charge.hpp"
#include "neutrals.hpp"
#include "diagnostics.hpp"

Include dependency graph for f_source.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	f_source (const Simulation< DeviceType > &sml, const Grid< DeviceType > &grid, const MagneticField< DeviceType > &magnetic_field, ElectricField< DeviceType > &electric_field, DomainDecomposition< DeviceType > &pol_decomp, const VelocityGrid &vgrid, const Charges &charges, Plasma &plasma, Smoothing &smoothing, PerturbedBField< DeviceType > &perturbed_B_field, const Neutrals< DeviceType > &neutrals, Sources &sources, DMWrapper &pseudo_inv_dm, Diagnostics &diagnostics)
	Applies multiple non-Hamiltonian source terms (collisions, neutrals, heat/torque, diffusion, radiative cooling, etc.) that modify the distribution function. More...

Function Documentation

void f_source	(	const Simulation< DeviceType > &	sml,
		const Grid< DeviceType > &	grid,
		const MagneticField< DeviceType > &	magnetic_field,
		ElectricField< DeviceType > &	electric_field,
		DomainDecomposition< DeviceType > &	pol_decomp,
		const VelocityGrid &	vgrid,
		const Charges &	charges,
		Plasma &	plasma,
		Smoothing &	smoothing,
		PerturbedBField< DeviceType > &	perturbed_B_field,
		const Neutrals< DeviceType > &	neutrals,
		Sources &	sources,
		DMWrapper &	pseudo_inv_dm,
		Diagnostics &	diagnostics
	)

Applies multiple non-Hamiltonian source terms (collisions, neutrals, heat/torque, diffusion, radiative cooling, etc.) that modify the distribution function.

The function orchestrates the entire "source" step in the kinetic equation, including:

• Checking if sources should be triggered at the current simulation step
• Optionally upsampling the particle set (if enabled) before performing particle-mesh interpolation and grid-based operations
• Transfering a fraction of the particle weights to the background distribution and updating particle weights (based on analytic or numerical background updates)
• Computing or retrieving the total distribution f0_f
• Applying each source routine sequentially (collisions, neutrals, heat and torque, anomalous diffusion, radiative cooling, pellets, current drive, etc.)
• Recording the incremental distribution-function changes in f0_df0g and accumulating them in f0_df0g_cumul
• Distributing the cumulative changes to particles to keep the grid and particle representations consistent
• Calling relevant diagnostic routines as needed

If sources are not triggered, the function simply updates particle weights.

Key steps and notes:

1. Upsampling (optional): If f0 upsampling is enabled, the particle set is resampled to reduce the error of mesh-particle interpolation.
2. Particle-Weight Updates: Particle weights may be recalculated based on updated analytic background information or to ensure correct f0 matching.
3. Collision Handling: For non-linear collisions, particle and distribution-function data are copied to/from the host if needed, since collisions can be memory-intensive.
4. Moment Calculations: The function computes distribution-function moments (density, flow, temperature) on the grid, used by certain source routines.
5. Incremental Changes: Each source routine (diffusion, collisions, neutrals, etc.) writes its changes into an incremental array (f0_df0g). These changes are then accumulated (in f0_df0g_cumul) and zeroed out (in f0_df0g) via accumulate_df0g_and_reset_to_zero.
6. Diagnostics: Several diagnostics can be triggered, e.g., writing out f0, df, or monitoring the distribution-function changes at each stage.
7. Performance & Parallelism: This routine relies on Kokkos parallel loops and GPTL timers for efficient execution and detailed performance measurement.

Template Parameters

DeviceType

The device (execution space) on which the simulation primarily runs.

Parameters

[in]	sml	Top-level simulation parameters and flags (time step, step count, upsampling flags, etc.).
[in]	grid	The spatial grid object containing geometry, number of planes, and mapping information.
[in]	magnetic_field	Access to magnetic-field geometry, used by certain sources and moment calculations.
[in,out]	electric_field	Electric field object, which can be modified by routines such as current-drive sources.
[in,out]	pol_decomp	Domain decomposition information for poloidal planes (may be used in parallel loops or moment calculations).
[in]	vgrid	Velocity-space grid (including resolution, bounds, and pseudo-inverse setup flags).
[in]	charges	Contains charge/mass information for different species.
[in,out]	plasma	Main plasma container for all species; holds distribution functions, particle data, and moments.
[in,out]	perturbed_B_field	Optional container for perturbed magnetic fields used in certain advanced calculations (e.g., 3D modes).
[in]	neutrals	Data structure holding neutral densities and reaction rates for neutral-particle recycling or atomic physics processes.
[in,out]	sources	Controls which source terms (collisions, diffusion, neutral recycling, pellet injection, etc.) are active, along with their parameters.
[in,out]	pseudo_inv_dm	Data manager for pseudo-inverse velocity mapping, needed for distributing f0 changes to particles correctly.
[in,out]	diagnostics	Manages diagnostic output for f0, df, distribution function moments, and other user-defined checks.

Returns

This function does not return a value; instead, it modifies the plasma state, updates diagnostic data, and manages distribution-function changes internally.

Note

• Collisions (if enabled and executed on the device) trigger moving the particle data from the device to the host before execution due to high memory requirements.
• The incremental distribution changes f0_df0g are always accumulated into f0_df0g_cumul before being distributed to the particle representation.
• When sources are not triggered, only a minimal update (e.g., particle weights) is performed to remain consistent with potential background changes.

Here is the call graph for this function: