orb5x::GyrodensityCorrect Class Reference

Placeholder interface for the finite-Larmor-radius density correction. More...

#include "gyrodensity_correct.hpp"

Static Public Member Functions
static void	gyrodensity_correct_disp ()
	Report that the displacement-density correction is not yet implemented.
static void	init_dens_corr_arrays ()
	Report that correction-array allocation is not yet implemented.

Detailed Description

Placeholder interface for the finite-Larmor-radius density correction.

OneStep invokes this subsystem on the final RK4 stage when any species has nl_chargecorr enabled. The corresponding ORB5 routines allocate correction work arrays and adjust the deposited gyro-density; both C++ methods currently issue a one-time warning and perform no correction.

Warning

Enabling charge correction does not yet reproduce the Fortran result.

Member Function Documentation

gyrodensity_correct_disp()

void orb5x::GyrodensityCorrect::gyrodensity_correct_disp ( )

static

Report that the displacement-density correction is not yet implemented.

init_dens_corr_arrays()

void orb5x::GyrodensityCorrect::init_dens_corr_arrays ( )

static

Report that correction-array allocation is not yet implemented.

---

The documentation for this class was generated from the following file:

• gyrodensity_correct.hpp