BiasPotential Class Reference

#include <bias_potential.hpp>

Public Member Functions
	BiasPotential ()
	BiasPotential (NLReader::NamelistReader &nlr, double dt, double psi_norm)
KOKKOS_INLINE_FUNCTION double	tanh_bias (double psi) const
KOKKOS_INLINE_FUNCTION double	linear_bias (double psi) const
void	add_potential (const Grid< DeviceType > &grid, double time, const View< double *, CLayout, DeviceType > &pot) const

Public Attributes
bool	kick
	If true, a periodic kick drive instead of a continuous sinusoidal drive is used. More...
double	tanh_amp
	Ampltude of the bias potential in Volt. More...
double	linear_amp
	Additional Ampltude of the bias potential in Volt for the kick drive. More...
double	psic
	Center position of bias potential phi_bia ~ exp(-(psi-psi0)^2), psi_normalized. More...
double	inv_psiw
	Decay length of the radial envelope of the bias potential. More...
int	freq
	Frequency in Hz of the bias potential. More...
int	start
double	time0
double	inv_psi_norm

Constructor & Destructor Documentation

BiasPotential() [1/2]

BiasPotential::BiasPotential ( )

inline

BiasPotential() [2/2]

BiasPotential::BiasPotential	(	NLReader::NamelistReader &	nlr,
		double	dt,
		double	psi_norm
	)

< If true, a periodic kick drive instead of a continuous sinusoidal drive is used

< Ampltude of the bias potential in Volt

< Additional Ampltude of the bias potential in Volt for the kick drive

< Center position of bias potential phi_bia ~ exp(-(psi-psi0)^2), psi_normalized

< Decay length of the radial envelope of the bias potential

< Frequency in Hz of the bias potential

< Time step in which the bias potential is started

Here is the call graph for this function:

Member Function Documentation

add_potential()

void BiasPotential::add_potential	(	const Grid< DeviceType > &	grid,
		double	time,
		const View< double *, CLayout, DeviceType > &	pot
	)		const

Here is the call graph for this function:

Here is the caller graph for this function:

linear_bias()

KOKKOS_INLINE_FUNCTION double BiasPotential::linear_bias ( double  psi ) const

inline

tanh_bias()

KOKKOS_INLINE_FUNCTION double BiasPotential::tanh_bias ( double  psi ) const

inline

Member Data Documentation

freq

int BiasPotential::freq

Frequency in Hz of the bias potential.

inv_psi_norm

double BiasPotential::inv_psi_norm

inv_psiw

double BiasPotential::inv_psiw

Decay length of the radial envelope of the bias potential.

kick

bool BiasPotential::kick

If true, a periodic kick drive instead of a continuous sinusoidal drive is used.

linear_amp

double BiasPotential::linear_amp

Additional Ampltude of the bias potential in Volt for the kick drive.

psic

double BiasPotential::psic

Center position of bias potential phi_bia ~ exp(-(psi-psi0)^2), psi_normalized.

start

int BiasPotential::start

tanh_amp

double BiasPotential::tanh_amp

Ampltude of the bias potential in Volt.

time0

double BiasPotential::time0

---

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

• /p/test_ssd/builds/t3_84szKM/0/xgc/XGC-Devel/XGC_core/cpp/bias_potential.hpp
• /p/test_ssd/builds/t3_84szKM/0/xgc/XGC-Devel/XGC_core/cpp/bias_potential.cpp