GridFiles Struct Reference

#include <grid_files.hpp>

Public Types
using	GridCreateOpt = PlaneFiles::GridCreateOpt

Public Member Functions
const PlaneFiles &	operator[] (int i) const
	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)
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  )

inline

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

inline

Member Function Documentation

void GridFiles::clear ( )

inline

Here is the caller graph for this function:

int GridFiles::n_planes ( ) const

inline

static int GridFiles::nshells_from_nnodes ( int  nnodes )

inlinestatic

Here is the call graph for this function:

const PlaneFiles& GridFiles::operator[] ( int  i ) const

inline

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 file:

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