Matrix Outputs

This page is generated from in-code XGC I/O metadata by utils/python/document_outputs.py.

Sparse matrix and field-following projection matrix outputs. Known matrix files written through this path include xgc.cnv_to_surf.bp, xgc.cnv_from_surf.bp, xgc.smooth_pol.bp, xgc.hyp_vis_rad.bp, xgc.ff_1dp_fwd.bp, xgc.ff_1dp_rev.bp, xgc.ff_hdp_fwd.bp, xgc.ff_hdp_rev.bp, xgc.ff_mdp_fwd.bp, and xgc.ff_mdp_rev.bp.

matrix .bp files

Variable	Units	Description
cidx	index	CSR column indices for the stored matrix.
eindex	index	Column indices for stored entries of the fixed-width matrix representation.
ncols	Positive integer	Number of columns in the stored matrix.
nelement	Non-negative integer	Number of stored nonzero entries in each row of the fixed-width matrix representation.
nnz	Non-negative integer	Total number of nonzero entries in the CSR matrix.
nrows	Positive integer	Number of rows in the stored matrix.
ridx	index	CSR row-pointer array for the stored matrix.
v	matrix-dependent	CSR nonzero values for the stored matrix.
value	matrix-dependent	Stored matrix coefficients in fixed-width row representation.
width	Positive integer	Maximum number of stored nonzero entries per row in the stored matrix.

field-following projection matrix .bp files

Variable	Units	Description
dl_par	m	Parallel distance along the magnetic field associated with the field-following projection.
eindex	index	Column indices for stored entries of the field-following projection matrix.
ncols	Positive integer	Number of columns in the field-following projection matrix.
nelement	Non-negative integer	Number of stored nonzero entries in each row of the field-following projection matrix.
nrows	Positive integer	Number of rows in the field-following projection matrix.
value	dimensionless	Interpolation weights for stored entries of the field-following projection matrix.
width	Positive integer	Maximum number of stored nonzero entries per row in the field-following projection matrix.