#include <grid_files.hpp>

Collaboration diagram for PlaneFiles:

Public Types
enum	FileRegion { Inside =0, OnWall }

enum	GridCreateOpt { Hexagonal =0, Circular =1 }

Public Member Functions
void	convert_to_x_rgn_format (const View< double *, CLayout, HostType > &tmp_nodes, View< RZPair , HostType > &x, View< int *, HostType > &rgn, bool is_stellarator)

void	convert_to_node_format (const View< int *, CLayout, HostType > &tmp_ele, View< Vertex , HostType > &nodes)

View< int *, HostType >	pack_scalars (int max_nodes_on_surface, int n_xpts, int n_separatrices) const

void	unpack_scalars (const View< int *, HostType > &scalars, int &max_nodes_on_surface, int &n_xpts, int &n_separatrices)

	PlaneFiles ()

void	construct_hex_grid (int nshells, double raxis, double zaxis, double rscale, double zscale)

double	node_to_node_dist (RZPair a, RZPair b)

void	construct_circular_grid (int nshells, double raxis, double zaxis, double rscale, double zscale)

	PlaneFiles (int nshells, double raxis, double zaxis, double rscale, double zscale, GridCreateOpt grid_opt=Hexagonal)

	PlaneFiles (MagneticField< HostType > &magnetic_field, int nshells, GridCreateOpt grid_opt=Hexagonal)

int	n_specified_xpts () const

View< Equil::XPoint *, HostType >	get_xpts () const

RZPair	get_axis () const

RZPair	get_reference_point () const

View< double *, HostType >	get_psiN () const

Static Public Member Functions
static int	nshells_from_nnodes (int nnodes)

Public Attributes
int	nnodes

View< RZPair *, HostType >	x

View< int *, HostType >	rgn

int	ntriangles

View< Vertex *, HostType >	nodes

View< int *, HostType >	i_x

int	nsurfaces

int	nsurfaces1

int	nsurfaces2

int	nsurfaces3a

int	nsurfaces3b

View< int *, HostType >	i_surf_separatrices

View< int *, HostType >	nnodes_on_surface

int	sum_nnodes_on_surfaces

int	num_non_aligned

View< int *, HostType >	non_aligned_vert

View< int *, HostType >	non_aligned_nsurf

View< int **, CLayout, HostType >	non_aligned_surf_idx

View< int **, CLayout, HostType >	surf_idx

View< double *, HostType >	psiN
	An array of normalized psi coordinates temporarily needed for the stellarator version. More...

Member Enumeration Documentation

enum PlaneFiles::FileRegion

Enumerator
Inside
OnWall

enum PlaneFiles::GridCreateOpt

Enumerator
Hexagonal
Circular

Constructor & Destructor Documentation

PlaneFiles::PlaneFiles ( )

inline

PlaneFiles::PlaneFiles	(	int	nshells,
		double	raxis,
		double	zaxis,
		double	rscale,
		double	zscale,
		GridCreateOpt	grid_opt = `Hexagonal`
	)

inline

Constructor to create analytic grid (hexagonal shells) given center and triangle scale

Parameters

[in]	nshells	is the number of concentric hexagons to be constructed
[in]	raxis	is where the grid is to be centered (r coord)
[in]	zaxis	is where the grid is to be centered (z coord)
[in]	rscale	is the length of the triangles
[in]	zscale	is the height of the triangles

Here is the call graph for this function:

PlaneFiles::PlaneFiles	(	MagneticField< HostType > &	magnetic_field,
		int	nshells,
		GridCreateOpt	grid_opt = `Hexagonal`
	)

inline

Constructor to create analytic grid (hexagonal shells) to fit the magnetic field provided

Parameters

[in]	magnetic_field	is the magnetic field that the grid should fit
[in]	nshells	is the number of concentric hexagons to be constructed

Here is the call graph for this function:

Member Function Documentation

void PlaneFiles::construct_circular_grid	(	int	nshells,
		double	raxis,
		double	zaxis,
		double	rscale,
		double	zscale
	)

inline

Construct the circular grid

Parameters

[in]	nshells	is the number of concentric circles to be constructed
[in]	raxis	is where the grid is to be centered (r coord)
[in]	zaxis	is where the grid is to be centered (z coord)
[in]	rscale	is the length of the triangles
[in]	zscale	is the height of the triangles

Here is the call graph for this function:

Here is the caller graph for this function:

void PlaneFiles::construct_hex_grid	(	int	nshells,
		double	raxis,
		double	zaxis,
		double	rscale,
		double	zscale
	)

inline

Construct the analytic hexagonal grid

Parameters

[in]	nshells	is the number of concentric hexagons to be constructed
[in]	raxis	is where the grid is to be centered (r coord)
[in]	zaxis	is where the grid is to be centered (z coord)
[in]	rscale	is the length of the triangles
[in]	zscale	is the height of the triangles

Here is the caller graph for this function:

void PlaneFiles::convert_to_node_format	(	const View< int **, CLayout, HostType > &	tmp_ele,
		View< Vertex *, HostType > &	nodes
	)

inline

Here is the call graph for this function:

void PlaneFiles::convert_to_x_rgn_format	(	const View< double **, CLayout, HostType > &	tmp_nodes,
		View< RZPair *, HostType > &	x,
		View< int *, HostType > &	rgn,
		bool	is_stellarator
	)

inline

Here is the call graph for this function:

RZPair PlaneFiles::get_axis ( ) const

inline

View<double*, HostType> PlaneFiles::get_psiN ( ) const

inline

RZPair PlaneFiles::get_reference_point ( ) const

inline

View<Equil::XPoint*, HostType> PlaneFiles::get_xpts ( ) const

inline

int PlaneFiles::n_specified_xpts ( ) const

inline

Here is the caller graph for this function:

double PlaneFiles::node_to_node_dist	(	RZPair	a,
		RZPair	b
	)

inline

Determine distance between two node points

Parameters

[in]	a	is the first point
[in]	b	is the second point

Here is the caller graph for this function:

static int PlaneFiles::nshells_from_nnodes ( int nnodes )

inlinestatic

Here is the caller graph for this function:

View<int*, HostType> PlaneFiles::pack_scalars	(	int	max_nodes_on_surface,
		int	n_xpts,
		int	n_separatrices
	)		const

inline

void PlaneFiles::unpack_scalars	(	const View< int *, HostType > &	scalars,
		int &	max_nodes_on_surface,
		int &	n_xpts,
		int &	n_separatrices
	)

inline

Member Data Documentation

View<int*, HostType> PlaneFiles::i_surf_separatrices

View<int*, HostType> PlaneFiles::i_x

int PlaneFiles::nnodes

View<int*, HostType> PlaneFiles::nnodes_on_surface

View<Vertex*, HostType> PlaneFiles::nodes

View<int*, HostType> PlaneFiles::non_aligned_nsurf

View<int**, CLayout, HostType> PlaneFiles::non_aligned_surf_idx

View<int*, HostType> PlaneFiles::non_aligned_vert

int PlaneFiles::nsurfaces

int PlaneFiles::nsurfaces1

int PlaneFiles::nsurfaces2

int PlaneFiles::nsurfaces3a

int PlaneFiles::nsurfaces3b

int PlaneFiles::ntriangles

int PlaneFiles::num_non_aligned

View<double*, HostType> PlaneFiles::psiN

An array of normalized psi coordinates temporarily needed for the stellarator version.

View<int*, HostType> PlaneFiles::rgn

int PlaneFiles::sum_nnodes_on_surfaces

View<int**, CLayout, HostType> PlaneFiles::surf_idx

View<RZPair*, HostType> PlaneFiles::x

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation