GridFiles Struct Reference

#include <grid_files.hpp>

Public Types
using	GridCreateOpt = PlaneFiles::GridCreateOpt

Public Member Functions
	GridFiles (int nshells, double raxis, double zaxis, double rscale, double zscale, GridCreateOpt grid_opt=Hexagonal)
	GridFiles (MagneticField< HostType > &magnetic_field, int nshells, GridCreateOpt grid_opt=Hexagonal)
std::string	ifile_int2str (int ifile) const
const PlaneFiles &	lplane () const
const PlaneFiles &	midplane () const
const PlaneFiles &	rplane () const
int	n_planes () const
void	clear ()

Static Public Member Functions
static int	nshells_from_nnodes (int nnodes)

Public Attributes
std::vector< PlaneFiles >	plane_files_vec

Static Public Attributes
static constexpr GridCreateOpt	Hexagonal = PlaneFiles::Hexagonal
static constexpr GridCreateOpt	Circular = PlaneFiles::Circular

Member Typedef Documentation

using GridFiles::GridCreateOpt = PlaneFiles::GridCreateOpt

Constructor & Destructor Documentation

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

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

Member Function Documentation

void GridFiles::clear

(

)

Here is the caller graph for this function:

std::string GridFiles::ifile_int2str

(

int

ifile

)

const

Here is the call graph for this function:

const PlaneFiles & GridFiles::lplane

(

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

const PlaneFiles & GridFiles::midplane

(

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

int GridFiles::n_planes

(

)

const

Here is the caller graph for this function:

int GridFiles::nshells_from_nnodes ( int  nnodes )

static

Here is the call graph for this function:

const PlaneFiles & GridFiles::rplane

(

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

constexpr GridCreateOpt GridFiles::Circular = PlaneFiles::Circular

static

constexpr GridCreateOpt GridFiles::Hexagonal = PlaneFiles::Hexagonal

static

std::vector<PlaneFiles> GridFiles::plane_files_vec

---

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

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