Athena: OutputS Struct Reference

Everything for outputs. More...

#include <athena.h>

List of all members.

Public Attributes
int	n
	the N from the <outputN> block of this output
Real	dt
	time interval between outputs
Real	t
	next time to output
int	num
	dump number (0=first)
char *	out
	variable (or user fun) to be output
char *	id
	filename is of the form <basename>[.idump][.id].
int	out_pargrid
	output grid binned particles (=1) or not (=0)
PropFun_t	par_prop
	particle property selection function
int	nlevel
int	ndomain
Real	dmin
Real	dmax
	user defined min/max for scaling data
Real	gmin
Real	gmax
	computed global min/max (over all output data)
int	sdmin
int	sdmax
	0 = auto scale, otherwise use dmin/dmax
int	ndim
	3=cube 2=slice 1=vector 0=scalar
int	reduce_x1
	flag to denote reduction in x1 (0=no reduction)
int	reduce_x2
	flag to denote reduction in x2 (0=no reduction)
int	reduce_x3
	flag to denote reduction in x3 (0=no reduction)
Real	x1l
Real	x1u
	lower/upper x1 range for data slice
Real	x2l
Real	x2u
	lower/upper x2 range for data slice
Real	x3l
Real	x3u
	lower/upper x3 range for data slice
char *	out_fmt
	output format = {bin, tab, hdf, hst, pgm, ppm, ...}
char *	dat_fmt
	format string for tabular type output, e.g.
char *	palette
	name of palette for RGB conversions
float *	rgb
	array of RGB[256*3] values derived from palette
float *	der
	helper array of derivatives for interpolation into RGB
VOutFun_t	out_fun
	output function pointer
VResFun_t	res_fun
	restart function pointer
ConsFun_t	expr
	pointer to expression that computes quant for output

Detailed Description

Everything for outputs.

Definition at line 412 of file athena.h.

Member Data Documentation

char* OutputS::dat_fmt

format string for tabular type output, e.g.

"%10.5e"

Definition at line 444 of file athena.h.

Referenced by data_output_destruct(), dump_history(), dump_tab_cons(), dump_tab_prim(), free_output(), init_output(), out_ktab(), output_pdf(), output_tab_1d(), output_tab_2d(), and output_tab_3d().

float* OutputS::der

helper array of derivatives for interpolation into RGB

Definition at line 447 of file athena.h.

Referenced by compute_rgb(), and init_output().

Real OutputS::dmax

user defined min/max for scaling data

Definition at line 429 of file athena.h.

Referenced by init_output(), output_pgm(), and output_ppm().

Real OutputS::dmin

Definition at line 429 of file athena.h.

Referenced by init_output(), output_pgm(), and output_ppm().

Real OutputS::dt

time interval between outputs

Definition at line 414 of file athena.h.

Referenced by data_output(), and init_output().

ConsFun_t OutputS::expr

pointer to expression that computes quant for output

Definition at line 452 of file athena.h.

Referenced by init_output(), OutData1(), OutData2(), OutData3(), and output_pdf().

Real OutputS::gmax

computed global min/max (over all output data)

Definition at line 430 of file athena.h.

Referenced by data_output_destruct(), init_output(), out_ktab(), output_pdf(), output_pgm(), output_ppm(), output_tab_1d(), output_tab_2d(), output_tab_3d(), output_vtk_2d(), and output_vtk_3d().

Real OutputS::gmin

Definition at line 430 of file athena.h.

Referenced by data_output_destruct(), init_output(), out_ktab(), output_pdf(), output_pgm(), output_ppm(), output_tab_1d(), output_tab_2d(), output_tab_3d(), output_vtk_2d(), and output_vtk_3d().

char* OutputS::id

filename is of the form <basename>[.idump][.id].

<ext>

Definition at line 418 of file athena.h.

Referenced by data_output_destruct(), free_output(), init_output(), out_ktab(), output_pdf(), output_pgm(), output_ppm(), output_tab_1d(), output_tab_2d(), output_tab_3d(), output_vtk_2d(), and output_vtk_3d().

the N from the <outputN> block of this output

Definition at line 413 of file athena.h.

Referenced by data_output(), init_output(), OutData1(), OutData2(), and OutData3().

int OutputS::ndim

3=cube 2=slice 1=vector 0=scalar

Definition at line 434 of file athena.h.

Referenced by init_output(), OutData1(), OutData2(), OutData3(), output_pgm(), output_ppm(), output_tab(), and output_vtk().

int OutputS::ndomain

Definition at line 426 of file athena.h.

Referenced by dump_binary(), dump_tab_cons(), dump_tab_prim(), dump_vtk(), init_output(), output_pdf(), output_pgm(), output_ppm(), output_tab(), and output_vtk().

int OutputS::nlevel

Definition at line 426 of file athena.h.

Referenced by dump_binary(), dump_tab_cons(), dump_tab_prim(), dump_vtk(), init_output(), output_pdf(), output_pgm(), output_ppm(), output_tab(), and output_vtk().

int OutputS::num

dump number (0=first)

Definition at line 416 of file athena.h.

Referenced by data_output(), dump_binary(), dump_history(), dump_restart(), dump_tab_cons(), dump_tab_prim(), dump_vtk(), dump_vtksub(), init_output(), out_ktab(), output_pdf(), output_pgm(), output_ppm(), output_tab_1d(), output_tab_2d(), output_tab_3d(), output_vtk_2d(), and output_vtk_3d().

char* OutputS::out

variable (or user fun) to be output

Definition at line 417 of file athena.h.

Referenced by data_output_destruct(), dump_binary(), dump_vtk(), free_output(), init_output(), OutData1(), OutData2(), OutData3(), and output_pdf().

char* OutputS::out_fmt

output format = {bin, tab, hdf, hst, pgm, ppm, ...}

Definition at line 443 of file athena.h.

Referenced by data_output_destruct(), free_output(), and init_output().

VOutFun_t OutputS::out_fun

output function pointer

Definition at line 450 of file athena.h.

Referenced by data_output(), and init_output().

int OutputS::out_pargrid

output grid binned particles (=1) or not (=0)

Definition at line 420 of file athena.h.

Referenced by dump_binary(), dump_tab_cons(), dump_tab_prim(), dump_vtk(), and init_output().

char* OutputS::palette

name of palette for RGB conversions

Definition at line 445 of file athena.h.

Referenced by init_output().

PropFun_t OutputS::par_prop

particle property selection function

Definition at line 421 of file athena.h.

Referenced by init_output().

int OutputS::reduce_x1

flag to denote reduction in x1 (0=no reduction)

Definition at line 435 of file athena.h.

Referenced by init_output(), OutData1(), OutData2(), and output_vtk_2d().

int OutputS::reduce_x2

flag to denote reduction in x2 (0=no reduction)

Definition at line 436 of file athena.h.

Referenced by init_output(), OutData1(), OutData2(), and output_vtk_2d().

int OutputS::reduce_x3

flag to denote reduction in x3 (0=no reduction)

Definition at line 437 of file athena.h.

Referenced by init_output(), OutData1(), OutData2(), and output_vtk_2d().

VResFun_t OutputS::res_fun

restart function pointer

Definition at line 451 of file athena.h.

Referenced by data_output(), and init_output().

float* OutputS::rgb

array of RGB[256*3] values derived from palette

Definition at line 446 of file athena.h.

Referenced by compute_rgb(), and init_output().

int OutputS::sdmax

0 = auto scale, otherwise use dmin/dmax

Definition at line 431 of file athena.h.

Referenced by init_output(), output_pgm(), and output_ppm().

int OutputS::sdmin

Definition at line 431 of file athena.h.

Referenced by init_output(), output_pgm(), and output_ppm().

Real OutputS::t

next time to output

Definition at line 415 of file athena.h.

Referenced by data_output(), and init_output().

Real OutputS::x1l

Definition at line 438 of file athena.h.

Referenced by init_output(), OutData1(), and OutData2().

Real OutputS::x1u

lower/upper x1 range for data slice

Definition at line 438 of file athena.h.

Referenced by init_output(), OutData1(), and OutData2().

Real OutputS::x2l

Definition at line 439 of file athena.h.

Referenced by init_output(), OutData1(), and OutData2().

Real OutputS::x2u

lower/upper x2 range for data slice

Definition at line 439 of file athena.h.

Referenced by init_output(), OutData1(), and OutData2().

Real OutputS::x3l

Definition at line 440 of file athena.h.

Referenced by init_output(), OutData1(), and OutData2().

Real OutputS::x3u

lower/upper x3 range for data slice

Definition at line 440 of file athena.h.

Referenced by init_output(), OutData1(), and OutData2().

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

athena.h