GradientMatrices< Device > Class Template Reference

#include <gradient_matrices.hpp>

Public Member Functions
	GradientMatrices ()
	GradientMatrices (bool use)
void	grid_deriv (const Grid< Device > &grid, const Kokkos::View< double *, Kokkos::LayoutRight, Device > &qty, const Kokkos::View< double *, Kokkos::LayoutRight, Device > &qty_deriv_x, const Kokkos::View< double *, Kokkos::LayoutRight, Device > &qty_deriv_y, bool discard_when_basis_is_one) const

Private Attributes
Matrix< Device >	gradx
Matrix< Device >	grady

Constructor & Destructor Documentation

template<class Device>

GradientMatrices< Device >::GradientMatrices ( )

inline

template<class Device>

GradientMatrices< Device >::GradientMatrices ( bool  use )

inline

Member Function Documentation

template<class Device>

void GradientMatrices< Device >::grid_deriv ( const Grid< Device > &  grid, const Kokkos::View< double *, Kokkos::LayoutRight, Device > &  qty, const Kokkos::View< double *, Kokkos::LayoutRight, Device > &  qty_deriv_x, const Kokkos::View< double *, Kokkos::LayoutRight, Device > &  qty_deriv_y, bool  discard_when_basis_is_one  ) const

inline

Computes the gradient of grid based quantities If sml_grad_psitheta is defined, the output are the psi-theta components of the field, if sml_grad_psitheta is not defined, the output are the R-Z components Conversion to R-Z is done in efield routine.

Parameters

[in]	grid	is the grid object
[in]	qty	is the quantity you want the gradient of
[out]	qty_deriv_x	is grad_x(qty)
[out]	qty_deriv_y	is grad_y(qty)
[in]	discard_when_basis_is_one	is a flag for whether to check the basis and zero out grad_y(qty) if it is 1

Returns

void

Here is the caller graph for this function:

Member Data Documentation

template<class Device>

Matrix<Device> GradientMatrices< Device >::gradx

private

template<class Device>

Matrix<Device> GradientMatrices< Device >::grady

private

---

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

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