PerturbedBField< Device > Class Template Reference

#include <perturbed_B_field.hpp>

Public Member Functions
	PerturbedBField (NLReader::NamelistReader &nlr, const DomainDecomposition< DeviceType > &pol_decomp, const Grid< DeviceType > &grid)
	PerturbedBField ()
void	initialize (NLReader::NamelistReader &nlr, const DomainDecomposition< DeviceType > &pol_decomp, const Grid< DeviceType > &grid)
void	update_rampup_fac_from_fortran () const
void	copy_bfield_from_fortran () const
void	copy_to_device_if_on (int gstep)
KOKKOS_INLINE_FUNCTION bool	is_triggered (int gstep) const
template<Order OT>
KOKKOS_INLINE_FUNCTION void	get_delta_b (const Grid< Device > &grid, const Simd< double > &phi, const SimdGridWeights< OT, PhiInterpType::None > &grid_wts, SimdVector &tdb) const
template<>
void	initialize (NLReader::NamelistReader &nlr, const DomainDecomposition< DeviceType > &pol_decomp, const Grid< DeviceType > &grid)
template<>
	PerturbedBField (NLReader::NamelistReader &nlr, const DomainDecomposition< DeviceType > &pol_decomp, const Grid< DeviceType > &grid)

Public Attributes
bool	rampup_vac
	(.true.) Ramp up perturbed field slowly, (.false.) turn on perturbed field abruptly More...
int	num_ntor
	Number of toroidal mode numbers (<= sml_nphi_total) More...
int	rampup_time
	Number of time steps over which the perturbed field is ramped up. More...
int	start_time
	Time step in which perturbed field is switched on. More...
int	mode
	Mode of RMP operation (details in XGC_core/module_ptb_3db.F90 –> ptb_3db_mode) More...
bool	full_spec_on
	(EM-only) whether to retain the full RMP spectrum from M3D-C1 or only |m/q-n|<=sml_mode_select_mres_q More...
double	rampup_fac
	The current relative amplitude of the vacuum vector potential (if ptb_3db_mode==2) - this is updated during the simulation. More...
bool	active
	Whether the field is in device memory and should be used in the push etc. Could be renamed for clarity. More...
Kokkos::View< int *, Kokkos::LayoutRight, Device >	ntor
	Array to store the toroidal mode numbers. More...
Kokkos::View< Field < VarType::Vector, PhiInterpType::None > **, Kokkos::LayoutRight, Device >	bfield_im_vac
	perturbed vacuum field on XGC mesh, imaginary part More...
Kokkos::View< Field < VarType::Vector, PhiInterpType::None > **, Kokkos::LayoutRight, Device >	bfield_re_vac
	perturbed vacuum field on XGC mesh, real part, dimensions: (grid vertex, R-Z-phi components, tor. mode number) More...

Constructor & Destructor Documentation

template<class Device>

PerturbedBField< Device >::PerturbedBField	(	NLReader::NamelistReader &	nlr,
		const DomainDecomposition< DeviceType > &	pol_decomp,
		const Grid< DeviceType > &	grid
	)

template<class Device>

PerturbedBField< Device >::PerturbedBField ( )

inline

template<>

PerturbedBField< DeviceType >::PerturbedBField	(	NLReader::NamelistReader &	nlr,
		const DomainDecomposition< DeviceType > &	pol_decomp,
		const Grid< DeviceType > &	grid
	)

Constructor for perturbed magnetic field class

Here is the call graph for this function:

Member Function Documentation

template<class Device>

void PerturbedBField< Device >::copy_bfield_from_fortran ( ) const

inline

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Device>

void PerturbedBField< Device >::copy_to_device_if_on ( int  gstep )

inline

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Device >

template<Order OT>

KOKKOS_INLINE_FUNCTION void PerturbedBField< Device >::get_delta_b	(	const Grid< Device > &	grid,
		const Simd< double > &	phi,
		const SimdGridWeights< OT, PhiInterpType::None > &	grid_wts,
		SimdVector &	tdb
	)		const

Get magnetic field perturbation vector for a vector of particle locations

Parameters

[in]	grid	The grid object
[in]	phi	Phi coordinate
[in]	grid_wts	Triangle the particles are in
[out]	tdb	Magnetic field perturbation vector

Here is the call graph for this function:

Here is the caller graph for this function:

template<>

void PerturbedBField< DeviceType >::initialize	(	NLReader::NamelistReader &	nlr,
		const DomainDecomposition< DeviceType > &	pol_decomp,
		const Grid< DeviceType > &	grid
	)

Here is the call graph for this function:

template<class Device>

void PerturbedBField< Device >::initialize	(	NLReader::NamelistReader &	nlr,
		const DomainDecomposition< DeviceType > &	pol_decomp,
		const Grid< DeviceType > &	grid
	)

Here is the caller graph for this function:

template<class Device >

KOKKOS_INLINE_FUNCTION bool PerturbedBField< Device >::is_triggered

(

int

gstep

)

const

Here is the caller graph for this function:

template<class Device>

void PerturbedBField< Device >::update_rampup_fac_from_fortran ( ) const

inline

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

template<class Device>

bool PerturbedBField< Device >::active

Whether the field is in device memory and should be used in the push etc. Could be renamed for clarity.

template<class Device>

Kokkos::View<Field<VarType::Vector,PhiInterpType::None>**,Kokkos::LayoutRight,Device> PerturbedBField< Device >::bfield_im_vac

perturbed vacuum field on XGC mesh, imaginary part

template<class Device>

Kokkos::View<Field<VarType::Vector,PhiInterpType::None>**,Kokkos::LayoutRight,Device> PerturbedBField< Device >::bfield_re_vac

perturbed vacuum field on XGC mesh, real part, dimensions: (grid vertex, R-Z-phi components, tor. mode number)

template<class Device>

bool PerturbedBField< Device >::full_spec_on

(EM-only) whether to retain the full RMP spectrum from M3D-C1 or only |m/q-n|<=sml_mode_select_mres_q

template<class Device>

int PerturbedBField< Device >::mode

Mode of RMP operation (details in XGC_core/module_ptb_3db.F90 –> ptb_3db_mode)

template<class Device>

Kokkos::View<int*,Kokkos::LayoutRight,Device> PerturbedBField< Device >::ntor

Array to store the toroidal mode numbers.

template<class Device>

int PerturbedBField< Device >::num_ntor

Number of toroidal mode numbers (<= sml_nphi_total)

template<class Device>

double PerturbedBField< Device >::rampup_fac

The current relative amplitude of the vacuum vector potential (if ptb_3db_mode==2) - this is updated during the simulation.

template<class Device>

int PerturbedBField< Device >::rampup_time

Number of time steps over which the perturbed field is ramped up.

template<class Device>

bool PerturbedBField< Device >::rampup_vac

(.true.) Ramp up perturbed field slowly, (.false.) turn on perturbed field abruptly

template<class Device>

int PerturbedBField< Device >::start_time

Time step in which perturbed field is switched on.

---

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

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