#include <grid_files.hpp>

Inheritance diagram for PlaneFiles:

Collaboration diagram for PlaneFiles:

[legend]

Public Types
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)

	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	get_nnodes () const override

View< RZPair *, HostType >	get_x () const override

View< int *, HostType >	get_rgn () const override

int	get_ntriangles () const override

View< Vertex *, HostType >	get_nodes () const override

View< int *, HostType >	get_i_x () const override

int	get_nsurfaces () const override

int	get_nsurfaces1 () const override

int	get_nsurfaces2 () const override

int	get_nsurfaces3a () const override

int	get_nsurfaces3b () const override

View< int *, HostType >	get_i_surf_separatrices () const override

View< int *, HostType >	get_nnodes_on_surface () const override

int	get_sum_nnodes_on_surfaces () const override

int	get_num_non_aligned () const override

View< int *, HostType >	get_non_aligned_vert () const override

View< int *, HostType >	get_non_aligned_nsurf () const override

View< int **, CLayout, HostType >	get_non_aligned_surf_idx () const override

View< int **, CLayout, HostType >	get_surf_idx () const override

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

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

int	n_specified_xpts () const override

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

RZPair	get_axis () const override

RZPair	get_reference_point () const override

View< double *, HostType >	get_psiN () const override

Public Member Functions inherited from PlaneFilesInterface
virtual	~PlaneFilesInterface ()=default

Static Public Member Functions
static int	nshells_from_nnodes (int nnodes)

Additional Inherited Members
Protected Types inherited from PlaneFilesBase
enum	FileRegion { Inside =0 , OnWall }

Protected Attributes inherited from PlaneFilesBase
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

◆ GridCreateOpt

enum PlaneFiles::GridCreateOpt

Enumerator
Hexagonal
Circular

Constructor & Destructor Documentation

◆ PlaneFiles() [1/3]

PlaneFiles::PlaneFiles ( )

inline

◆ PlaneFiles() [2/3]

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

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() [3/3]

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

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

◆ construct_circular_grid()

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

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:

◆ construct_hex_grid()

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

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:

◆ convert_to_node_format()

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

Here is the call graph for this function:

◆ convert_to_x_rgn_format()

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
	)