Species< Device > Class Template Reference

#include <species.hpp>

Public Member Functions
	Species (int idx_in, bool is_electron_in, bool is_adiabatic_in, bool is_gyrokinetic_in, double mass_in, double charge_in, double charge_eu_in, bool is_deltaf_in, int ncycles_in)
	Species ()

Public Attributes
int	idx
	Index in all_species. More...
bool	is_electron
	Whether this species is the electrons. More...
bool	is_adiabatic
	Whether this species is adiabatic. More...
bool	is_gyrokinetic
	Whether the species is gyrokinetic or drift kinetic. More...
double	mass
	Particle mass. More...
double	charge
	Particle charge. More...
double	charge_eu
	Particle charge in eu. More...
double	c_m
	c/m More...
double	c2_2m
	c2/2m More...
bool	is_deltaf
	Whether this species is deltaf. More...
int	ncycles
	Number of subcycles. More...
int	ncycles_between_sorts
	Number of subcycles between sorts. More...
Cabana::AoSoA < ParticleDataTypes, HostType, VEC_LEN >	backup_particles
	Copy of particles to be restored for RK2. More...
Distribution< Device >	f0
	Species distribution in velocity space on local mesh nodes. More...
Eq::Profile< Device >	eq_temp
Eq::Profile< Device >	eq_den
Eq::Profile< Device >	eq_flow

Constructor & Destructor Documentation

template<class Device >

Species< Device >::Species	(	int	idx_in,
		bool	is_electron_in,
		bool	is_adiabatic_in,
		bool	is_gyrokinetic_in,
		double	mass_in,
		double	charge_in,
		double	charge_eu_in,
		bool	is_deltaf_in,
		int	ncycles_in
	)

Constructor for species class

template<class Device>

Species< Device >::Species ( )

inline

Member Data Documentation

template<class Device>

Cabana::AoSoA<ParticleDataTypes,HostType,VEC_LEN> Species< Device >::backup_particles

Copy of particles to be restored for RK2.

template<class Device>

double Species< Device >::c2_2m

c2/2m

template<class Device>

double Species< Device >::c_m

c/m

template<class Device>

double Species< Device >::charge

Particle charge.

template<class Device>

double Species< Device >::charge_eu

Particle charge in eu.

template<class Device>

Eq::Profile<Device> Species< Device >::eq_den

template<class Device>

Eq::Profile<Device> Species< Device >::eq_flow

template<class Device>

Eq::Profile<Device> Species< Device >::eq_temp

template<class Device>

Distribution<Device> Species< Device >::f0

Species distribution in velocity space on local mesh nodes.

template<class Device>

int Species< Device >::idx

Index in all_species.

template<class Device>

bool Species< Device >::is_adiabatic

Whether this species is adiabatic.

template<class Device>

bool Species< Device >::is_deltaf

Whether this species is deltaf.

template<class Device>

bool Species< Device >::is_electron

Whether this species is the electrons.

template<class Device>

bool Species< Device >::is_gyrokinetic

Whether the species is gyrokinetic or drift kinetic.

template<class Device>

double Species< Device >::mass

Particle mass.

template<class Device>

int Species< Device >::ncycles

Number of subcycles.

template<class Device>

int Species< Device >::ncycles_between_sorts

Number of subcycles between sorts.

---

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

• /u/gitlab-xgc/builds/YGMz2TJ8/0/xgc/XGC-Devel/XGC_core/cpp/species.hpp
• /u/gitlab-xgc/builds/YGMz2TJ8/0/xgc/XGC-Devel/XGC_core/cpp/species.tpp