Plane< Device > Class Template Reference

#include <plane.hpp>

Collaboration diagram for Plane< Device >:

Public Member Functions
	Plane (NLReader::NamelistReader &nlr, const PlaneFiles &plane_files, const MagneticField< DeviceType > &magnetic_field, double plane_index_dbl, bool use_as_fortran_grid=false)
	Plane ()
template<class Device2 >
Plane< Device2 >	mirror () const
void	setup_1d_flux_surface_grid (const PlaneFiles &plane_files, const MagneticField< DeviceType > &magnetic_field, const View< double *, CLayout, HostType > &node_vol_h)
KOKKOS_INLINE_FUNCTION void	t_coeff (const SimdVector2D &x, const Simd< int > &itr, SimdGridVec &p) const
KOKKOS_INLINE_FUNCTION void	t_coeff_mod (const MagneticField< Device > &magnetic_field, const double r, const double z, const double psiin, const int itr, double(&p)[3]) const
KOKKOS_INLINE_FUNCTION void	t_coeff_mod (const MagneticField< Device > &magnetic_field, const SimdVector2D &xy, const Simd< double > &psiin, const Simd< int > &itr, SimdGridVec &p) const
KOKKOS_INLINE_FUNCTION void	search_tr2_no_precheck (const double r, const double z, int &itr, double(&p)[3]) const
KOKKOS_INLINE_FUNCTION void	search_tr2 (const SimdVector2D &xy, Simd< int > &itr, SimdGridVec &pout) const
KOKKOS_INLINE_FUNCTION void	search_tr_check_guess (const SimdVector2D &x, const Simd< int > &old_itr, Simd< int > &itr, SimdGridVec &p) const
KOKKOS_INLINE_FUNCTION void	psi_search (double psi, double &wp, int &ip) const
KOKKOS_INLINE_FUNCTION void	follow_field_to_nearest_midplane (const MagneticField< Device > &magnetic_field, const SimdVector2D &x, const Simd< double > &phi, SimdVector2D &xff) const
KOKKOS_INLINE_FUNCTION void	get_grid_weights_ff (const MagneticField< Device > &magnetic_field, const SimdVector &v, const Simd< double > &psi_in, SimdVector2D &xff, SimdGridWeights< Order::One, PhiInterpType::Planes > &grid_wts) const
KOKKOS_INLINE_FUNCTION void	get_grid_weights_plane_ff (const MagneticField< Device > &magnetic_field, const SimdVector &v, double phi_plane, SimdGridWeights< Order::One, PhiInterpType::Planes > &grid_wts) const
KOKKOS_INLINE_FUNCTION void	get_grid_weights_no_ff (const MagneticField< Device > &magnetic_field, const SimdVector2D &x, const Simd< double > &psi_in, SimdGridWeights< Order::One, PhiInterpType::None > &grid_wts) const
template<PhiInterpType PIT>
KOKKOS_INLINE_FUNCTION void	nearest_node (const SimdGridWeights< Order::One, PIT > &grid_wts, SimdGridWeights< Order::Zero, PIT > &grid_wts0) const
template<PhiInterpType PIT>
KOKKOS_INLINE_FUNCTION void	get_grid_weights (const MagneticField< Device > &magnetic_field, const SimdVector &v, const Simd< double > &psi, SimdVector2D &xff, SimdGridWeights< Order::One, PIT > &grid_wts) const
template<PhiInterpType PIT>
KOKKOS_INLINE_FUNCTION void	get_grid_weights (const MagneticField< Device > &magnetic_field, const SimdVector &v, SimdVector2D &xff, SimdGridWeights< Order::One, PIT > &grid_wts) const
template<PhiInterpType PIT>
KOKKOS_INLINE_FUNCTION void	get_grid_weights (const MagneticField< Device > &magnetic_field, const SimdVector &v, const Simd< double > &psi_in, SimdGridWeights< Order::Zero, PIT > &grid_wts) const
template<PhiInterpType PIT>
KOKKOS_INLINE_FUNCTION void	get_grid_weights (const MagneticField< Device > &magnetic_field, const SimdVector &v, const Simd< double > &psi_in, SimdGridWeights< Order::One, PIT > &grid_wts) const
template<PhiInterpType PIT>
KOKKOS_INLINE_FUNCTION void	get_grid_weights (const MagneticField< Device > &magnetic_field, const SimdVector &v, SimdGridWeights< Order::Zero, PIT > &grid_wts) const
template<PhiInterpType PIT>
KOKKOS_INLINE_FUNCTION void	get_grid_weights (const MagneticField< Device > &magnetic_field, const SimdVector &v, SimdGridWeights< Order::One, PIT > &grid_wts) const
KOKKOS_INLINE_FUNCTION void	get_wall_index (const Simd< bool > &just_left_the_grid, const SimdVector2D &x, const SimdGridWeights< Order::One, PIT_GLOBAL > &grid_wts, Simd< int > &widx) const
KOKKOS_INLINE_FUNCTION void	wedge_modulo_phi (Simd< double > &phi_mod) const
KOKKOS_INLINE_FUNCTION double	wedge_modulo_phi (double phi) const
KOKKOS_INLINE_FUNCTION bool	node_is_inside_psi_range (const MagneticField< Device > &magnetic_field, const int node) const
KOKKOS_INLINE_FUNCTION int	get_plane_index (double phi) const
KOKKOS_INLINE_FUNCTION int	get_node_index (int triangle_index, int tri_vertex_index) const
KOKKOS_INLINE_FUNCTION double	node_area_to_volume (const MagneticField< Device > &magnetic_field, double area, int node_index) const
KOKKOS_INLINE_FUNCTION void	get_triangle_area_and_volume (const MagneticField< Device > &magnetic_field, int i, double &area, double &volume) const
KOKKOS_INLINE_FUNCTION double	get_r_center_of_mass (int itr) const
KOKKOS_INLINE_FUNCTION bool	node_is_in_region_1_or_2_no_wall (const int inode) const
KOKKOS_INLINE_FUNCTION bool	node_is_in_region_2_or_3_no_wall (const int inode) const
KOKKOS_INLINE_FUNCTION bool	node_is_in_private_region_no_wall (const int inode) const
KOKKOS_INLINE_FUNCTION bool	node_is_in_included_region (const int inode, const bool exclude_private_region) const
KOKKOS_INLINE_FUNCTION bool	node_is_in_region_1_or_2 (const MagneticField< Device > &magnetic_field, const int inode) const
template<class Device2 >
KOKKOS_INLINE_FUNCTION bool	node_is_in_region_3b (const MagneticField< Device2 > &magnetic_field, const int inode) const
KOKKOS_INLINE_FUNCTION bool	node_is_on_wall (const int inode) const
template<class Device2 >
KOKKOS_INLINE_FUNCTION bool	node_is_in_region_3a_no_wall (const MagneticField< Device2 > &magnetic_field, const int inode) const
template<class Device2 >
KOKKOS_INLINE_FUNCTION bool	node_is_in_region_3b_no_wall (const MagneticField< Device2 > &magnetic_field, const int inode) const
KOKKOS_INLINE_FUNCTION int	uses_rz_basis (const int inode) const
KOKKOS_INLINE_FUNCTION double	get_r (const int inode) const
KOKKOS_INLINE_FUNCTION double	get_dist2_from_node (const int inode, const double r, const double z) const
KOKKOS_INLINE_FUNCTION double	get_dist_from_node (const int inode, const double r, const double z) const
KOKKOS_INLINE_FUNCTION void	get_rz_coordinates (const int inode, double &r, double &z) const
KOKKOS_INLINE_FUNCTION void	get_rz_coordinates (const Simd< int > &grid_inds, SimdVector2D &x) const
KOKKOS_INLINE_FUNCTION void	get_rz_coordinates (const int itr, const double(&p)[3], double &r, double &z) const
KOKKOS_INLINE_FUNCTION void	get_rz_coordinates (const Simd< int > &itr, const SimdGridVec &p, SimdVector2D &x) const
KOKKOS_INLINE_FUNCTION int	get_nearest_node (const Simd< int > &itr, const SimdGridVec &p, int i_simd) const
KOKKOS_INLINE_FUNCTION int	get_nearest_node (const int itr, const double(&p)[3]) const
KOKKOS_INLINE_FUNCTION double	get_nearest_midplane (double phi) const
KOKKOS_INLINE_FUNCTION void	set_gradient_mat_triangle (const View< int *, CLayout, DeviceType > &num_t_node, const View< int **, CLayout, DeviceType > &tr_node, const View< double *, CLayout, DeviceType > &tr_area, const View< double ***, CLayout, DeviceType > &unit_vecs, const int i, const GradientMatrices< Device > &gradient_matrices) const
KOKKOS_INLINE_FUNCTION int	get_characteristic_length (const View< int *, CLayout, DeviceType > &num_t_node, const View< int **, CLayout, DeviceType > &tr_node, const int i, double &dist_triangle, double &dist_psi, double &dist_theta) const
KOKKOS_INLINE_FUNCTION void	set_grad_matrix_from_psi_theta (bool is_psi_dir, int itr_pos, int itr_neg, double(&p_pos)[3], double(&p_neg)[3], double dl_pos, double dl_neg, int inode, const Matrix< Device > &matrix) const
KOKKOS_INLINE_FUNCTION RZPair	get_wall_rz (int i_wall) const
void	write_to_file (const XGC_IO_Stream &stream, const DomainDecomposition< DeviceType > &pol_decomp, bool is_stellarator) const
void	draw_ascii_grid (MagneticField< Device > magnetic_field, double rmin, double rmax, double dr, double zmin, double zmax, double dz)
template<>
void	setup_1d_flux_surface_grid (const PlaneFiles &plane_files, const MagneticField< DeviceType > &magnetic_field, const View< double *, CLayout, HostType > &node_vol_h)
template<>
void	write_to_file (const XGC_IO_Stream &stream, const DomainDecomposition< DeviceType > &pol_decomp, bool is_stellarator) const

Public Attributes
int	ntriangle
	Number of grid triangles. More...
int	nnode
	Number of grid nodes. More...
int	nplanes
	Number of planes. More...
double	plane_phi
	phi coordinate of this plane More...
double	wedge_angle
	The size of the wedge (the model is periodic in phi, a angle of e.g. pi means half the tokamak is modeled) More...
double	delta_phi
	Distance between planes. More...
double	inv_delta_phi
	1/delta_phi More...
Kokkos::View< double *, Kokkos::LayoutRight, Device >	psi
	An array of psi coordinates. More...
Kokkos::View< double *, Kokkos::LayoutRight, Device >	bfield
	Magnetic field magnitude at nodes. More...
int	npsi_surf2
double	minval_psi_surf2
double	maxval_psi_surf2
Kokkos::View< double *, Kokkos::LayoutRight, Device >	psi_surf2
UniformRange	psi00
int	nwall
Kokkos::View< int *, Kokkos::LayoutRight, Device >	wall_nodes
Kokkos::View< int *, Kokkos::LayoutRight, Device >	node_to_wall
double	eps_flux_surface
	The minimum difference in psi that counts as being on two different flux surfaces. More...

Private Member Functions
template<>
	Plane (NLReader::NamelistReader &nlr, const PlaneFiles &plane_files, const MagneticField< DeviceType > &magnetic_field, double plane_index_dbl, bool use_as_fortran_grid)

Private Attributes
Kokkos::View< int *, Kokkos::LayoutRight, Device >	basis
	0 for Psi-theta, 1 for R-Z ; should be enum (and bool/char?) More...
Kokkos::View< Vertex *, Kokkos::LayoutRight, Device >	nodes
Kokkos::View< VertexMap *, Kokkos::LayoutRight, Device >	mapping
Kokkos::View< int *, Kokkos::LayoutRight, Device >	rgn
Kokkos::View< RZPair *, Kokkos::LayoutRight, Device >	gx
GuessTable< Device >	guess
GuessList1D< Device >	psi_guess
View< int **, CLayout, Device >	adj
	The indices of the three adjacent triangles for each triangle. More...

Friends
template<class Device2 >
class	Plane

Constructor & Destructor Documentation

template<class Device>

Plane< Device >::Plane	(	NLReader::NamelistReader &	nlr,
		const PlaneFiles &	plane_files,
		const MagneticField< DeviceType > &	magnetic_field,
		double	plane_index_dbl,
		bool	use_as_fortran_grid = false
	)

template<class Device>

Plane< Device >::Plane ( )

inline

template<>

Plane< HostType >::Plane ( NLReader::NamelistReader &  nlr, const PlaneFiles &  plane_files, const MagneticField< DeviceType > &  magnetic_field, double  plane_index_dbl, bool  use_as_fortran_grid  )

private

< Size of the hash table used to narrow down the number of triangles in which to search a particle

< If \(|\nabla\psi|\) is smaller than this threshold, \(\nabla\psi\) is computed

< Size of the uniform 1D psi-grid

Here is the call graph for this function:

Member Function Documentation

template<class Device>

void Plane< Device >::draw_ascii_grid ( MagneticField< Device >  magnetic_field, double  rmin, double  rmax, double  dr, double  zmin, double  zmax, double  dz  )

inline

template<class Device>

KOKKOS_INLINE_FUNCTION void Plane< Device >::follow_field_to_nearest_midplane	(	const MagneticField< Device > &	magnetic_field,
		const SimdVector2D &	x,
		const Simd< double > &	phi,
		SimdVector2D &	xff
	)		const

Follow the magnetic field to the nearest midplane.

Parameters

[in]	magnetic_field	The magnetic field object
[in]	x	Vector of (r,z) coordinates
[in]	phi	Vector of phi coordinates
[out]	xff	Vector of (r,z) coordinates mapped along B-field to midplane

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Device >

KOKKOS_INLINE_FUNCTION int Plane< Device >::get_characteristic_length	(	const View< int *, CLayout, DeviceType > &	num_t_node,
		const View< int **, CLayout, DeviceType > &	tr_node,
		const int	i,
		double &	dist_triangle,
		double &	dist_psi,
		double &	dist_theta
	)		const

Determines characteristic distance in grad(psi) and grad(theta) direction

Parameters

[in]	num_t_node
[in]	tr_node
[in]	i	node index
[out]	dist_triangle
[out]	dist_psi
[out]	dist_theta

Returns

int error code: -3 is fatal, -2 means all vertices are on the same surface, -1 means?

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Device >

KOKKOS_INLINE_FUNCTION double Plane< Device >::get_dist2_from_node	(	const int	inode,
		const double	r,
		const double	z
	)		const

Gets the square of the distance from a grid vertex of the input (r,z) coordinates. The square of the distance is sufficient in some algorithms, and avoids a costly square root. If the distance itself is needed, use get_dist_from_node

Parameters

[in]	inode	grid node
[in]	r	r coordinate of input point
[in]	z	z coordinate of input point

Returns

double the square of the distance

Here is the caller graph for this function:

template<class Device >

KOKKOS_INLINE_FUNCTION double Plane< Device >::get_dist_from_node	(	const int	inode,
		const double	r,
		const double	z
	)		const

Gets the distance from a grid vertex of the input (r,z) coordinates.

Parameters

[in]	inode	grid node
[in]	r	r coordinate of input point
[in]	z	z coordinate of input point

Returns

double the distance

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Device>

template<PhiInterpType PIT>

KOKKOS_INLINE_FUNCTION void Plane< Device >::get_grid_weights	(	const MagneticField< Device > &	magnetic_field,
		const SimdVector &	v,
		const Simd< double > &	psi_in,
		SimdVector2D &	xff,
		SimdGridWeights< Order::One, PIT > &	grid_wts
	)		const

Get the grid triangle and vertex weights for a vector of locations.

Parameters

[in]	magnetic_field	The magnetic field object (currently global so technically unnecessary)
[in]	v	Vector of (r,z, phi) coordinates
[in]	psi_in	Vector of psi coordinates
[out]	xff	Vector of (r,z) coordinates mapped along B-field to midplane
[out]	grid_wts	Grid weights

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Device>

template<PhiInterpType PIT>

KOKKOS_INLINE_FUNCTION void Plane< Device >::get_grid_weights	(	const MagneticField< Device > &	magnetic_field,
		const SimdVector &	v,
		SimdVector2D &	xff,
		SimdGridWeights< Order::One, PIT > &	grid_wts
	)		const

template<class Device>

template<PhiInterpType PIT>

KOKKOS_INLINE_FUNCTION void Plane< Device >::get_grid_weights	(	const MagneticField< Device > &	magnetic_field,
		const SimdVector &	v,
		const Simd< double > &	psi_in,
		SimdGridWeights< Order::Zero, PIT > &	grid_wts
	)		const

Here is the call graph for this function:

template<class Device>

template<PhiInterpType PIT>

KOKKOS_INLINE_FUNCTION void Plane< Device >::get_grid_weights	(	const MagneticField< Device > &	magnetic_field,
		const SimdVector &	v,
		const Simd< double > &	psi,
		SimdGridWeights< Order::One, PIT > &	grid_wts
	)		const

Get the grid triangle and vertex weights for a vector of locations.

Parameters

[in]	magnetic_field	The magnetic field object
[in]	v	Vector of (r,z,phi) coordinates
[in]	psi	Vector of psi coordinates
[out]	grid_wts	Grid weights

Here is the call graph for this function:

template<class Device>

template<PhiInterpType PIT>

KOKKOS_INLINE_FUNCTION void Plane< Device >::get_grid_weights	(	const MagneticField< Device > &	magnetic_field,
		const SimdVector &	v,
		SimdGridWeights< Order::Zero, PIT > &	grid_wts
	)		const

Here is the call graph for this function:

template<class Device>

template<PhiInterpType PIT>

KOKKOS_INLINE_FUNCTION void Plane< Device >::get_grid_weights	(	const MagneticField< Device > &	magnetic_field,
		const SimdVector &	v,
		SimdGridWeights< Order::One, PIT > &	grid_wts
	)		const

Get the grid triangle and vertex weights for a vector of locations.

Parameters

[in]	magnetic_field	The magnetic field object
[in]	v	Vector of (r,z,phi) coordinates
[out]	grid_wts	Grid weights

Here is the call graph for this function:

template<class Device>

KOKKOS_INLINE_FUNCTION void Plane< Device >::get_grid_weights_ff	(	const MagneticField< Device > &	magnetic_field,
		const SimdVector &	v,
		const Simd< double > &	psi_in,
		SimdVector2D &	xff,
		SimdGridWeights< Order::One, PhiInterpType::Planes > &	grid_wts
	)		const

Get the grid triangle and vertex weights for a vector of locations.

Parameters

[in]	magnetic_field	The magnetic field object
[in]	v	Vector of (r,z,phi) coordinates
[in]	psi_in	Vector of psi coordinates
[out]	xff	Vector of (r,z) coordinates mapped along B-field to midplane
[out]	grid_wts	Grid weights

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Device>

KOKKOS_INLINE_FUNCTION void Plane< Device >::get_grid_weights_no_ff	(	const MagneticField< Device > &	magnetic_field,
		const SimdVector2D &	x,
		const Simd< double > &	psi_in,
		SimdGridWeights< Order::One, PhiInterpType::None > &	grid_wts
	)		const

Get the grid triangle and vertex weights for a vector of locations.

Parameters

[in]	magnetic_field	The magnetic field object
[in]	x	Vector of (r,z) coordinates
[in]	phi	Vector of phi coordinates
[in]	psi_in	Vector of psi coordinates
[out]	grid_wts	Grid weights

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Device>

KOKKOS_INLINE_FUNCTION void Plane< Device >::get_grid_weights_plane_ff	(	const MagneticField< Device > &	magnetic_field,
		const SimdVector &	v,
		double	phi_plane,
		SimdGridWeights< Order::One, PhiInterpType::Planes > &	grid_wts
	)		const

Get the grid triangle and vertex weights for a vector of locations. Assumes that the locations are in the local wedge

Parameters

[in]	magnetic_field	The magnetic field object
[in]	v	Vector of (r,z,phi) coordinates
[in]	phi_plane	The phi coordinate of the plane. This should probably be a member of Plane rather than an argument
[out]	grid_wts	Grid weights

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Device >

KOKKOS_INLINE_FUNCTION double Plane< Device >::get_nearest_midplane

(

double

phi

)

const

Returns nearest midplane for a given phi

Parameters

[in]

phi

input phi coordinate

template<class Device >

KOKKOS_INLINE_FUNCTION int Plane< Device >::get_nearest_node	(	const Simd< int > &	itr,
		const SimdGridVec &	p,
		int	i_simd
	)		const

Returns nearest node given a triangle and barycentric coordinates

Parameters

[in]	itr	triangle index (1-indexed)
[in]	p	barycentric weights
[in]	i_simd	simd index

Returns

nearest node (1-indexed)

template<class Device >

KOKKOS_INLINE_FUNCTION int Plane< Device >::get_nearest_node	(	const int	itr,
		const double(&)	p[3]
	)		const

Returns nearest node given a triangle and barycentric coordinates

Parameters

[in]	itr	triangle index (1-indexed)
[in]	p	barycentric weights

Returns

nearest node (1-indexed)

template<class Device >

KOKKOS_INLINE_FUNCTION int Plane< Device >::get_node_index	(	int	triangle_index,
		int	tri_vertex_index
	)		const

Returns the index of the node (0-indexed), for a given triangle and triangle vertex index

Parameters

[in]	triangle_index	the index of the triangle (1-indexed)
[in]	tri_vertex_index	the index of the requested vertex on the triangle

Returns

int the index of the node (0-indexed)

Here is the caller graph for this function:

template<class Device >

KOKKOS_INLINE_FUNCTION int Plane< Device >::get_plane_index

(

double

phi

)

const

Returns the index of the plane, rounded down.

Parameters

[in]

phi

the phi value

Returns

int the index of the plane

template<class Device >

KOKKOS_INLINE_FUNCTION double Plane< Device >::get_r

(

const int

inode

)

const

Accesses the r coordinate of the grid node

Parameters

[in]

inode

grid node to check

Returns

double the r coordinate

template<class Device >

KOKKOS_INLINE_FUNCTION double Plane< Device >::get_r_center_of_mass

(

int

itr

)

const

Returns r coordinate of center of mass of a triangle

Parameters

[in]

i

is the triangle index (0-indexed)

Returns

double r_center_of_mass

template<class Device >

KOKKOS_INLINE_FUNCTION void Plane< Device >::get_rz_coordinates	(	const int	inode,
		double &	r,
		double &	z
	)		const

Returns rz coordinates of a single node

Parameters

[in]	inode	node index
[out]	r	r coordinate
[out]	z	z coordinate

Here is the caller graph for this function:

template<class Device >

KOKKOS_INLINE_FUNCTION void Plane< Device >::get_rz_coordinates	(	const Simd< int > &	grid_inds,
		SimdVector2D &	x
	)		const

Returns vector of rz coordinates of the input node indices

Parameters

[in]	grid_inds	Vector of node indices
[out]	x	Vector of rz coordinates

template<class Device >

KOKKOS_INLINE_FUNCTION void Plane< Device >::get_rz_coordinates	(	const int	itr,
		const double(&)	p[3],
		double &	r,
		double &	z
	)		const

Returns rz coordinates given a triangle index and barycentric weights

Parameters

[in]	itr	triangle index (1-indexed)
[in]	p	barycentric weights
[out]	r	r coordinate of input point
[out]	z	z coordinate of input point

Here is the call graph for this function:

template<class Device >

KOKKOS_INLINE_FUNCTION void Plane< Device >::get_rz_coordinates	(	const Simd< int > &	itr,
		const SimdGridVec &	p,
		SimdVector2D &	x
	)		const

Returns rz coordinates given a triangle index and barycentric weights

Parameters

[in]	itr	triangle index (1-indexed)
[in]	p	barycentric weights
[out]	x	r,z coordinates of input point

Here is the call graph for this function:

template<class Device>

KOKKOS_INLINE_FUNCTION void Plane< Device >::get_triangle_area_and_volume	(	const MagneticField< Device > &	magnetic_field,
		int	i,
		double &	area,
		double &	volume
	)		const

Returns analytical calculation of triangle area and projected volume

Parameters

[in]	magnetic_field	is the magnetic field
[in]	i	is the triangle index (0-indexed)
[out]	area	is the triangle area
[out]	volume	is the triangle projected volume

Returns

void

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Device >

KOKKOS_INLINE_FUNCTION void Plane< Device >::get_wall_index	(	const Simd< bool > &	just_left_the_grid,
		const SimdVector2D &	x,
		const SimdGridWeights< Order::One, PIT_GLOBAL > &	grid_wts,
		Simd< int > &	widx
	)		const

Find nearest wall point for a vector of locations.

Parameters

[in]	just_left_the_grid	Vector of whether particles have left the grid
[in]	x	Vector of (r,z) coordinates
[in]	grid_wts	Grid weights
[out]	widx	Vector of wall point indices

template<class Device >

KOKKOS_INLINE_FUNCTION RZPair Plane< Device >::get_wall_rz

(

int

i_wall

)

const

Returns the (r,z) coordinates of a wall vertex given the index in wall_nodes

Parameters

[in]

i_wall

is the wall index requested

Returns

RZPair the (r,z) coordinates of the wall vertex

template<class Device>

template<class Device2 >

Plane<Device2> Plane< Device >::mirror ( ) const

inline

template<class Device >

template<PhiInterpType PIT>

KOKKOS_INLINE_FUNCTION void Plane< Device >::nearest_node	(	const SimdGridWeights< Order::One, PIT > &	grid_wts,
		SimdGridWeights< Order::Zero, PIT > &	grid_wts0
	)		const

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Device>

KOKKOS_INLINE_FUNCTION double Plane< Device >::node_area_to_volume	(	const MagneticField< Device > &	magnetic_field,
		double	area,
		int	node_index
	)		const

Returns analytical calculation of node volume by projecting the node area into the toroidal direction Assumes the center of mass is the node

Parameters

[in]	magnetic_field	is the magnetic field
[in]	area	is the area of the node
[in]	node_index	is the node index

Returns

double the area owned by the node

Here is the call graph for this function:

template<class Device >

KOKKOS_INLINE_FUNCTION bool Plane< Device >::node_is_in_included_region	(	const int	inode,
		const bool	exclude_private_region
	)		const

Checks if a grid node lies within an included region. This excludes wall nodes and the private region if specified.

Parameters

[in]	inode	grid node to check
[in]	exclude_private_region	whether to private region is excluded

Returns

bool true if in included region

Here is the caller graph for this function:

template<class Device >

KOKKOS_INLINE_FUNCTION bool Plane< Device >::node_is_in_private_region_no_wall

(

const int

inode

)

const

Checks if a grid node lies within region 3. Excludes wall since rgn is a different value there

Parameters

[in]

inode

grid node to check

Returns

bool true if in region 3

Here is the caller graph for this function:

template<class Device>

KOKKOS_INLINE_FUNCTION bool Plane< Device >::node_is_in_region_1_or_2	(	const MagneticField< Device > &	magnetic_field,
		const int	inode
	)		const

Checks if a grid node lies within region 1 or 2. Note this is subtly different from rgn, because rgn also has a wall option

Parameters

[in]	magnetic_field	the magnetic field object
[in]	inode	grid node to check

Returns

bool true if in region 1 or 2

Here is the call graph for this function:

template<class Device >

KOKKOS_INLINE_FUNCTION bool Plane< Device >::node_is_in_region_1_or_2_no_wall

(

const int

inode

)

const

Checks if a grid node lies within region 1 or 2. Excludes wall since rgn is a different value there

Parameters

[in]

inode

grid node to check

Returns

bool true if in region 1 or 2

template<class Device >

KOKKOS_INLINE_FUNCTION bool Plane< Device >::node_is_in_region_2_or_3_no_wall

(

const int

inode

)

const

Checks if a grid node lies within region 2 or 3. Excludes wall since rgn is a different value there

Parameters

[in]

inode

grid node to check

Returns

bool true if in region 2 or 3

template<class Device >

template<class Device2 >

KOKKOS_INLINE_FUNCTION bool Plane< Device >::node_is_in_region_3a_no_wall	(	const MagneticField< Device2 > &	magnetic_field,
		const int	inode
	)		const

Checks if a grid node lies within region 3a. This method may be inconsistent with the others

Parameters

[in]	magnetic_field	the magnetic field object
[in]	inode	grid node to check

Returns

bool true if in region 3a

Here is the call graph for this function:

template<class Device >

template<class Device2 >

KOKKOS_INLINE_FUNCTION bool Plane< Device >::node_is_in_region_3b	(	const MagneticField< Device2 > &	magnetic_field,
		const int	inode
	)		const

Checks if a grid node lies within region 3b. Note this is based on magnetic field geometry so it doesn't care if the node is a wall node

Parameters

[in]	magnetic_field	the magnetic field object
[in]	inode	grid node to check

Returns

bool true if in region 3b

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Device >

template<class Device2 >

KOKKOS_INLINE_FUNCTION bool Plane< Device >::node_is_in_region_3b_no_wall	(	const MagneticField< Device2 > &	magnetic_field,
		const int	inode
	)		const

Checks if a grid node lies within region 3b. This method may be inconsistent with the others

Parameters

[in]	magnetic_field	the magnetic field object
[in]	inode	grid node to check

Returns

bool true if in region 3b

Here is the call graph for this function:

template<class Device>

KOKKOS_INLINE_FUNCTION bool Plane< Device >::node_is_inside_psi_range	(	const MagneticField< Device > &	magnetic_field,
		const int	node
	)		const

Checks if a grid node lies within the simulation domain (radially).

Parameters

[in]	magnetic_field	the magnetic field object (currently global so technically unnecessary)
[in]	node	grid node to check (0-indexed)

Returns

bool true if inside, false if outside

template<class Device >

KOKKOS_INLINE_FUNCTION bool Plane< Device >::node_is_on_wall

(

const int

inode

)

const

Checks if a grid node is a wall node

Parameters

[in]

inode

grid node to check

Returns

bool true if on wall

Here is the caller graph for this function:

template<class Device >

KOKKOS_INLINE_FUNCTION void Plane< Device >::psi_search	(	double	psi,
		double &	wp,
		int &	ip
	)		const

Here is the call graph for this function:

template<class Device >

KOKKOS_INLINE_FUNCTION void Plane< Device >::search_tr2	(	const SimdVector2D &	xy,
		Simd< int > &	itr,
		SimdGridVec &	pout
	)		const

Determine triangle location and triangle vertex weights of vector of locations, first checking the particles have left their previous triangle, and if so doing a search

Parameters

[in]	xy	Vector of (r,z) coordinates
[out]	itr	Vector of triangle locations
[out]	pout	Vector of triangle vertex weights

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Device >

KOKKOS_INLINE_FUNCTION void Plane< Device >::search_tr2_no_precheck	(	const double	r,
		const double	z,
		int &	itr,
		double(&)	p[3]
	)		const

Here is the caller graph for this function:

template<class Device >

KOKKOS_INLINE_FUNCTION void Plane< Device >::search_tr_check_guess	(	const SimdVector2D &	x,
		const Simd< int > &	old_itr,
		Simd< int > &	itr,
		SimdGridVec &	p
	)		const

A check to see if vector of particles has stayed in the same triangle since last time. If so just recalculate p weights

Parameters

[in]	x	Vector of (r,z) coordinates
[in]	old_itr	Vector of old triangle location
[out]	itr	Vector of new triangle location (same as old if unchanged, -1 if search is needed)
[out]	p	Vector of p weights if in same triangle

Here is the call graph for this function:

template<class Device>

KOKKOS_INLINE_FUNCTION void Plane< Device >::set_grad_matrix_from_psi_theta	(	bool	is_psi_dir,
		int	itr_pos,
		int	itr_neg,
		double(&)	p_pos[3],
		double(&)	p_neg[3],
		double	dl_pos,
		double	dl_neg,
		int	inode,
		const Matrix< Device > &	matrix
	)		const

Sets gradient matrix values based on psi-theta triangle weights

Parameters

[in]	is_psi_dir	whether the gradient matrix is psi or theta direction (just for the error message)
[in]	itr_pos	the triangle index in the positive direction
[in]	itr_neg	the triangle index in the negative direction
[in]	p_pos	the triangle weights in the positive direction
[in]	p_neg	the triangle weights in the negative direction
[in]	dl_pos	the distance in the positive direction
[in]	dl_neg	the distance in the negative direction
[in]	inode	the node index
[out]	matrix	the gradient matrix being updates

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Device>

KOKKOS_INLINE_FUNCTION void Plane< Device >::set_gradient_mat_triangle	(	const View< int *, CLayout, DeviceType > &	num_t_node,
		const View< int **, CLayout, DeviceType > &	tr_node,
		const View< double *, CLayout, DeviceType > &	tr_area,
		const View< double ***, CLayout, DeviceType > &	unit_vecs,
		const int	i,
		const GradientMatrices< Device > &	gradient_matrices
	)		const

Sets gradient matrix values for a given vertex

Parameters

[in]	num_t_node
[in]	tr_node
[in]	tr_area
[in]	unit_vecs
[in]	i	node index
[out]	gradient_matrices	Gradient matrices

Here is the caller graph for this function:

template<class Device>

void Plane< Device >::setup_1d_flux_surface_grid	(	const PlaneFiles &	plane_files,
		const MagneticField< DeviceType > &	magnetic_field,
		const View< double *, CLayout, HostType > &	node_vol_h
	)

template<>

void Plane< HostType >::setup_1d_flux_surface_grid	(	const PlaneFiles &	plane_files,
		const MagneticField< DeviceType > &	magnetic_field,
		const View< double *, CLayout, HostType > &	node_vol_h
	)

Here is the call graph for this function:

template<class Device >

KOKKOS_INLINE_FUNCTION void Plane< Device >::t_coeff	(	const SimdVector2D &	x,
		const Simd< int > &	itr,
		SimdGridVec &	p
	)		const

Calculate a vector of barycentric coordinates p from real-space coordinates x in triangle itr.

Parameters

[in]	x	Vector of (r,z) coordinates
[in]	itr	Vector of triangles
[out]	p	Vector of the weights of the triangle vertices

Here is the caller graph for this function:

template<class Device>

KOKKOS_INLINE_FUNCTION void Plane< Device >::t_coeff_mod	(	const MagneticField< Device > &	magnetic_field,
		const double	r,
		const double	z,
		const double	psiin,
		const int	itr,
		double(&)	p[3]
	)		const

Here is the caller graph for this function:

template<class Device>

KOKKOS_INLINE_FUNCTION void Plane< Device >::t_coeff_mod	(	const MagneticField< Device > &	magnetic_field,
		const SimdVector2D &	xy,
		const Simd< double > &	psiin,
		const Simd< int > &	itr,
		SimdGridVec &	p
	)		const

template<class Device >

KOKKOS_INLINE_FUNCTION int Plane< Device >::uses_rz_basis

(

const int

inode

)

const

Whether the field uses an r-z or a psi-theta basis.

Parameters

[in]

inode

grid node to check

Returns

int 1 if rz basis, 0 if psi-theta basis

template<class Device >

KOKKOS_INLINE_FUNCTION void Plane< Device >::wedge_modulo_phi

(

Simd< double > &

phi_mod

)

const

Modulo phi in place: Keep phi between 0 and wedge_angle. Best algorithm as long as the particles haven't left the wedge multiple times over

Parameters

[in,out]

phi_mod

Vector of phi coordinates

Here is the caller graph for this function:

template<class Device >

KOKKOS_INLINE_FUNCTION double Plane< Device >::wedge_modulo_phi

(

double

phi

)

const

Modulo phi in place: Keep phi between 0 and wedge_angle. Best algorithm as long as the particles haven't left the wedge multiple times over

Parameters

[in,out]

phi_mod

Vector of phi coordinates

template<class Device>

void Plane< Device >::write_to_file	(	const XGC_IO_Stream &	stream,
		const DomainDecomposition< DeviceType > &	pol_decomp,
		bool	is_stellarator
	)		const

template<>

void Plane< HostType >::write_to_file	(	const XGC_IO_Stream &	stream,
		const DomainDecomposition< DeviceType > &	pol_decomp,
		bool	is_stellarator
	)		const

Here is the call graph for this function:

Friends And Related Function Documentation

template<class Device>

template<class Device2 >

friend class Plane

friend

Member Data Documentation

template<class Device>

View<int**,CLayout,Device> Plane< Device >::adj

private

The indices of the three adjacent triangles for each triangle.

template<class Device>

Kokkos::View<int*, Kokkos::LayoutRight,Device> Plane< Device >::basis

private

0 for Psi-theta, 1 for R-Z ; should be enum (and bool/char?)

template<class Device>

Kokkos::View<double*,Kokkos::LayoutRight,Device> Plane< Device >::bfield

Magnetic field magnitude at nodes.

template<class Device>

double Plane< Device >::delta_phi

Distance between planes.

template<class Device>

double Plane< Device >::eps_flux_surface

The minimum difference in psi that counts as being on two different flux surfaces.

template<class Device>

GuessTable<Device> Plane< Device >::guess

private

template<class Device>

Kokkos::View<RZPair*,Kokkos::LayoutRight,Device> Plane< Device >::gx

private

template<class Device>

double Plane< Device >::inv_delta_phi

1/delta_phi

template<class Device>

Kokkos::View<VertexMap*,Kokkos::LayoutRight,Device> Plane< Device >::mapping

private

template<class Device>

double Plane< Device >::maxval_psi_surf2

template<class Device>

double Plane< Device >::minval_psi_surf2

template<class Device>

int Plane< Device >::nnode

Number of grid nodes.

template<class Device>

Kokkos::View<int*,Kokkos::LayoutRight,Device> Plane< Device >::node_to_wall

template<class Device>

Kokkos::View<Vertex*,Kokkos::LayoutRight,Device> Plane< Device >::nodes

private

template<class Device>

int Plane< Device >::nplanes

Number of planes.

template<class Device>

int Plane< Device >::npsi_surf2

template<class Device>

int Plane< Device >::ntriangle

Number of grid triangles.

template<class Device>

int Plane< Device >::nwall

template<class Device>

double Plane< Device >::plane_phi

phi coordinate of this plane

template<class Device>

Kokkos::View<double*,Kokkos::LayoutRight,Device> Plane< Device >::psi

An array of psi coordinates.

template<class Device>

UniformRange Plane< Device >::psi00

template<class Device>

GuessList1D<Device> Plane< Device >::psi_guess

private

template<class Device>

Kokkos::View<double*,Kokkos::LayoutRight,Device> Plane< Device >::psi_surf2

template<class Device>

Kokkos::View<int*,Kokkos::LayoutRight,Device> Plane< Device >::rgn

private

template<class Device>

Kokkos::View<int*,Kokkos::LayoutRight,Device> Plane< Device >::wall_nodes

template<class Device>

double Plane< Device >::wedge_angle

The size of the wedge (the model is periodic in phi, a angle of e.g. pi means half the tokamak is modeled)

---

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

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