All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
GridFiles Struct Reference

#include <grid_files.hpp>

Public Types

using GridCreateOpt = PlaneFiles::GridCreateOpt

Public Member Functions

const PlaneFilesoperator[] (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< PlaneFilesplane_files_vec

Static Public Attributes

static constexpr GridCreateOpt Hexagonal = PlaneFiles::Hexagonal
static constexpr GridCreateOpt Circular = PlaneFiles::Circular

Member Typedef Documentation

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:

int GridFiles::n_planes ( ) const
static int GridFiles::nshells_from_nnodes ( int  nnodes)

Here is the call graph for this function:

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

Member Data Documentation

constexpr GridCreateOpt GridFiles::Circular = PlaneFiles::Circular
constexpr GridCreateOpt GridFiles::Hexagonal = PlaneFiles::Hexagonal
std::vector<PlaneFiles> GridFiles::plane_files_vec

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