MagneticEquilFiles3D Struct Reference

#include <magnetic_equil_files.hpp>

Inheritance diagram for MagneticEquilFiles3D:

Collaboration diagram for MagneticEquilFiles3D:

Public Member Functions
void	read_eq_dims (FileReader &file_reader, int &mr, int &mz, int &mphi, int &wedge_n)
void	read_eq (FileReader &file_reader, int iphi)
	MagneticEquilFiles3D (const std::string &eq_filebase)
Public Member Functions inherited from MagneticEquilFiles
virtual	~MagneticEquilFiles ()=default

Static Public Member Functions
static MagneticEquilFiles3D	eq_files_from_namelist (NLReader::NamelistReader &nlr)
Static Public Member Functions inherited from MagneticEquilFiles
static Ptr	eq_files_ptr_from_namelist (NLReader::NamelistReader &nlr, bool is_3D)

Public Attributes
RZBounds	bounds
	Min and max for r and z (the same for all planes) More...
int	periodicity
	Toroidal periodicity or torus wedge number for a tokamak (not used but written to the output for diagnostics) More...
int	mp
	Number of planes (not used but written to the output for diagnostics) More...
View< double *, HostType >	rgrid
	Uniform grid in r. More...
View< double *, HostType >	zgrid
	Uniform grid in z. More...
View< double *, HostType >	phigrid
	Uniform grid in phi. More...
View< double ***, CLayout, HostType >	psi
	Normalized poloidal flux on phi-z-r grid. More...
View< double ***, CLayout, HostType >	VMEC_angle
	VMEC angle on phi-z-r grid (not used but written to the output for diagnostics) More...
View< double ***, CLayout, HostType >	PEST_angle
	PEST angle on phi-z-r grid (not used but written to the output for diagnostics) More...
View< double ***, CLayout, HostType >	Br
	r magnetic field component on phi-z-r grid More...
View< double ***, CLayout, HostType >	Bz
	z magnetic field component on phi-z-r grid More...
View< double ***, CLayout, HostType >	Bphi
	phi magnetic field component on phi-z-r grid More...

Additional Inherited Members
Public Types inherited from MagneticEquilFiles
using	Ptr = std::shared_ptr< MagneticEquilFiles >

Constructor & Destructor Documentation

MagneticEquilFiles3D::MagneticEquilFiles3D

(

const std::string &

eq_filebase

)

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

MagneticEquilFiles3D MagneticEquilFiles3D::eq_files_from_namelist ( NLReader::NamelistReader &  nlr )

static

< eq_filename is the name of the equilibrium input

Here is the call graph for this function:

Here is the caller graph for this function:

void MagneticEquilFiles3D::read_eq	(	FileReader &	file_reader,
		int	iphi
	)

Here is the call graph for this function:

Here is the caller graph for this function:

void MagneticEquilFiles3D::read_eq_dims	(	FileReader &	file_reader,
		int &	mr,
		int &	mz,
		int &	mphi,
		int &	wedge_n
	)

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

RZBounds MagneticEquilFiles3D::bounds

Min and max for r and z (the same for all planes)

View<double***, CLayout, HostType> MagneticEquilFiles3D::Bphi

phi magnetic field component on phi-z-r grid

View<double***, CLayout, HostType> MagneticEquilFiles3D::Br

r magnetic field component on phi-z-r grid

View<double***, CLayout, HostType> MagneticEquilFiles3D::Bz

z magnetic field component on phi-z-r grid

int MagneticEquilFiles3D::mp

Number of planes (not used but written to the output for diagnostics)

int MagneticEquilFiles3D::periodicity

Toroidal periodicity or torus wedge number for a tokamak (not used but written to the output for diagnostics)

View<double***, CLayout, HostType> MagneticEquilFiles3D::PEST_angle

PEST angle on phi-z-r grid (not used but written to the output for diagnostics)

View<double*, HostType> MagneticEquilFiles3D::phigrid

Uniform grid in phi.

View<double***, CLayout, HostType> MagneticEquilFiles3D::psi

Normalized poloidal flux on phi-z-r grid.

View<double*, HostType> MagneticEquilFiles3D::rgrid

Uniform grid in r.

View<double***, CLayout, HostType> MagneticEquilFiles3D::VMEC_angle

VMEC angle on phi-z-r grid (not used but written to the output for diagnostics)

View<double*, HostType> MagneticEquilFiles3D::zgrid

Uniform grid in z.

---

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

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