orb5x::Diag3dParameters Struct Reference

Configuration used to initialize distributed three-dimensional output. More...

#include "vis3d.hpp"

Collaboration diagram for orb5x::Diag3dParameters:

Public Attributes
Real	chilim [2] = {0.0, 0.0}
	Lower and upper poloidal-angle bounds, in radians.
MPI_Comm	comm_loc = MPI_COMM_WORLD
	Borrowed communicator for distributed output.
CoordFunc	coordf_ptr = nullptr
	Optional coordinate transform used to construct the curvilinear mesh.
char	data_type = 'd'
	Requested HDF5 scalar precision: ‘'s’(single) or'd'` (double).
bool	forcelocal = false
	Whether to align the toroidal mesh with selected MPI ranks.
int	mesh_size [3] = {0, 0, 0}
	Global cell-centre counts [ns,nchi,nphi].
std::string	mesh_type = "sc"
	"sc" for (s,chi,phi) or "fa" for field-aligned output.
bool	nlres = false
	Restart flag used to initialize the PIXIE writer state.
int	nphip = 0
	Reference number of toroidal grid points per simulation rank.
std::string	output_format = "PIXIE_one"
	Layout selector: PIXIE_* or XDMF_*.
Real	philim [2] = {0.0, 0.0}
	Lower and upper toroidal-angle bounds, in radians.
Real	slim [2] = {0.0, 0.0}
	Lower and upper normalized-radial bounds.
bool	verbose = false
	Emit mesh and communicator diagnostics to standard output.

Detailed Description

Configuration used to initialize distributed three-dimensional output.

Bounds and mesh sizes define a cell-centred grid. Angular bounds are in radians and s is the normalized radial coordinate. The structure mirrors DIAG3D_PARAMETERS in vis3d.F90.

Member Data Documentation

chilim

Real orb5x::Diag3dParameters::chilim[2] = {0.0, 0.0}

Lower and upper poloidal-angle bounds, in radians.

comm_loc

MPI_Comm orb5x::Diag3dParameters::comm_loc = MPI_COMM_WORLD

Borrowed communicator for distributed output.

coordf_ptr

CoordFunc orb5x::Diag3dParameters::coordf_ptr = nullptr

Optional coordinate transform used to construct the curvilinear mesh.

data_type

char orb5x::Diag3dParameters::data_type = 'd'

Requested HDF5 scalar precision: ‘'s’(single) or'd'` (double).

forcelocal

bool orb5x::Diag3dParameters::forcelocal = false

Whether to align the toroidal mesh with selected MPI ranks.

mesh_size

int orb5x::Diag3dParameters::mesh_size[3] = {0, 0, 0}

Global cell-centre counts [ns,nchi,nphi].

mesh_type

std::string orb5x::Diag3dParameters::mesh_type = "sc"

"sc" for (s,chi,phi) or "fa" for field-aligned output.

nlres

bool orb5x::Diag3dParameters::nlres = false

Restart flag used to initialize the PIXIE writer state.

nphip

int orb5x::Diag3dParameters::nphip = 0

Reference number of toroidal grid points per simulation rank.

output_format

std::string orb5x::Diag3dParameters::output_format = "PIXIE_one"

Layout selector: PIXIE_* or XDMF_*.

philim

Real orb5x::Diag3dParameters::philim[2] = {0.0, 0.0}

Lower and upper toroidal-angle bounds, in radians.

slim

Real orb5x::Diag3dParameters::slim[2] = {0.0, 0.0}

Lower and upper normalized-radial bounds.

verbose

bool orb5x::Diag3dParameters::verbose = false

Emit mesh and communicator diagnostics to standard output.

---

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

• vis3d.hpp