Stores simulation snapshot data. More...

#include <DataSnapshot.h>

Inheritance diagram for DataReader::DataSnapshot:

Public Member Functions
	DataSnapshot (const string &fileName="")
	Constructor. More...

virtual void	Read (const string &fileName)
	Parses and stores data from a snapshot file.

int	GetSnapshotID () const
	Returns the snapshot ID. More...

double	GetSimulationTime () const
	Returns the simulation time. More...

double	GetBubbleRadius () const
	Returns the bubble radius. More...

double	GetMeanVelocity () const
	Returns the average velocity. More...

double	GetMedianVelocity () const
	Returns the median velocity. More...

unsigned long long	GetTotalCollisions () const
	Returns the total number of collisions. More...

unsigned long long	GetTotalCellCrossings () const
	Returns the total number of cell crossings. More...

unsigned long long	GetTotalWallCollisions () const
	Returns the total number of wall collisions. More...

unsigned long long	GetTotalConeBoundaryCollisions () const
	Returns the total number of cone boundary collisions. More...

double	GetFusionRate () const
	Returns the rate at which fusion occurs. More...

int	GetGasTypes () const
	Returns the number of gas types. More...

vector< ShellData > &	GetShellData ()
	Returns the list of shell data.

double	GetWallVelocity () const
	Returns the wall velocity. More...

double	GetPressure () const
	Returns the pressure. More...

double	GetMaxTemperature () const
	Returns the maximum temperature. More...

double	GetAvgTemperature () const
	Returns the average temperature. More...

double	GetMaxEnergy () const
	Returns the maximum energy level. More...

double	GetAvgEnergy () const
	Returns the average energy level. More...

double	GetMaxDensity () const
	Returns the maximum density measured. More...

double	GetAvgDensity () const
	Returns the average density measured. More...

double	GetKineticEnergy () const
	Returns the kinetic energy measured. More...

double	GetKineticEnergyCom () const
	Returns the kinetic energy '?' measured. More...

int	GetParticleCount () const
	Returns the particle count measured. More...

vector< int >	GetIonizations () const
	Returns the number of ionizations, where the index is the gas type. More...

Public Member Functions inherited from DataReader::DataFile
	DataFile (const string &fileName="")
	Constructor. More...

string	GetFileName () const
	Returns the name of the file the data was read from.

EFileType	GetType () const
	Returns the type of data stored.

bool	GetDataStored () const
	Returns whether or not data has been stored.

Static Public Attributes
Snapshot Keys
The following is a list of all of the keys used by the read method to look up values within the JSON formatted snapshot files.
static const char *	SS_SnapshotID = "snap_shot"
	Snapshot ID.

static const char *	SS_SimTime = "t"
	Simulation time.

static const char *	SS_Radius = "r"
	Radius.

static const char *	SS_Bins = "bins"
	Shell data.

static const char *	SS_ParticleCount = "ParticleCount"
	Particle count.

static const char *	SD_Radius = "r"
	Shell radius.

static const char *	SD_Particles = "n"
	Shell particles.

static const char *	SD_Density = "density"
	Shell density.

static const char *	SD_Temperature = "temperature"
	Shell temperature.

static const char *	SD_MaxTemperature = "max_temperature"
	Shell temperature.

static const char *	SD_Velocity = "velocity"
	Shell velocity.

static const char *	SD_Ionization = "ionization"
	Shell ionization.

static const char *	SD_Percentage = "percentage"
	Shell gas percentages.

static const char *	SD_KineticEnergy = "kinetic_energy"
	Shell kinetic energy.

Static Public Attributes inherited from DataReader::DataFile
static const char *	Delimiters = " ,\n"
	List of delimiters that are used in files.

Protected Member Functions
ShellData	ReadShellData (Value &item)

Protected Attributes
int	SnapshotID_
	The numerical identification by which this snapshot can be recognized and ordered by.

double	SimulationTime_
	The time at which this snapshot was taken.

double	BubbleRadius_
	The radius, measured from the center of the gas bubble to the bubble wall.

double	MeanVelocity_
	The average velocity of the particles.

double	MedianVelocity_
	The median velocity of the particles.

unsigned long long	TotalCollisions_
	The number of active particle collisions.

unsigned long long	TotalCellCrossings_
	[details pending]

unsigned long long	TotalWallCollisions_
	[details pending]

unsigned long long	TotalConeBoundaryCollisions_
	[details pending]

double	FusionRate_
	[details pending]

vector< ShellData >	ShellData_
	The list of shells that the bubble is composed of.

int	GasTypes_
	The number of gas types in this snapshot.

double	WallVelocity_
	The velocity at which the wall is traveling in relations to the origin.

double	Pressure_
	The average pressure throughout the bubble during this snapshot.

double	MaxTemperature_
	The maximum temperature measured within the bubble during this snapshot.

double	AvgTemperature_
	The average temperature throughout the bubble during this snapshot.

double	MaxEnergy_
	The maximum energy level measured within the bubble during this snapshot.

double	AvgEnergy_
	The average energy level throughout the bubble during this snapshot.

double	MaxDensity_
	The maximum density measured within the bubble during this snapshot.

double	AvgDensity_
	The average density throughout the bubble during this snapshot.

double	KineticEnergy_
	The kinetic energy of particles in the bubble during this snapshot.

double	KineticEnergyCom_
	The kinetic energy '?' of particles in the bubble during this snapshot.

int	ParticleCount_
	The current particle count during this snapshot.

vector< int >	Ionizations_
	Number of ionizations during this snapshot.

Protected Attributes inherited from DataReader::DataFile
string	FileName_
	Name of the file that the data is read from.

EFileType	Type_
	Indicates the type of data stored.

bool	DataStored_
	Flag indicating if data has been stored.

Additional Inherited Members
Public Types inherited from DataReader::DataFile
enum	EFileType { RPK, Snapshot, Savepoint, CollisionEnergy }
	Lists the type of data the files are storing. More...

Detailed Description

Stores simulation snapshot data.

Constructor & Destructor Documentation

DataSnapshot::DataSnapshot ( const string & fileName = "" )

Constructor.

Initializes members and attempts to read from a file if a file name is passed.

Member Function Documentation

double DataSnapshot::GetAvgDensity ( ) const

Returns the average density measured.

See Also: AvgDensity_

double DataSnapshot::GetAvgEnergy ( ) const

Returns the average energy level.

See Also: AvgEnergy_

double DataSnapshot::GetAvgTemperature ( ) const

Returns the average temperature.

See Also: AvgTemperature_

double DataSnapshot::GetBubbleRadius ( ) const

Returns the bubble radius.

See Also: BubbleRadius_

double DataSnapshot::GetFusionRate ( ) const

Returns the rate at which fusion occurs.

See Also: FusionRate_

int DataSnapshot::GetGasTypes ( ) const

Returns the number of gas types.

See Also: GasTypes_

vector< int > DataSnapshot::GetIonizations ( ) const

Returns the number of ionizations, where the index is the gas type.

See Also: Ionizations_

double DataSnapshot::GetKineticEnergy ( ) const

Returns the kinetic energy measured.

See Also: KineticEnergy_

double DataSnapshot::GetKineticEnergyCom ( ) const

Returns the kinetic energy '?' measured.

See Also: KineticEnergyCom_

double DataSnapshot::GetMaxDensity ( ) const

Returns the maximum density measured.

See Also: MaxDensity_

double DataSnapshot::GetMaxEnergy ( ) const

Returns the maximum energy level.

See Also: MaxEnergy_

double DataSnapshot::GetMaxTemperature ( ) const

Returns the maximum temperature.

See Also: MaxTemperature_

double DataSnapshot::GetMeanVelocity ( ) const

Returns the average velocity.

See Also: MeanVelocity_

double DataSnapshot::GetMedianVelocity ( ) const

Returns the median velocity.

See Also: MedianVelocity_

int DataSnapshot::GetParticleCount ( ) const

Returns the particle count measured.

See Also: ParticleCount_

double DataSnapshot::GetPressure ( ) const

Returns the pressure.

See Also: Pressure_

double DataSnapshot::GetSimulationTime ( ) const

Returns the simulation time.

See Also: SimulationTime_

int DataSnapshot::GetSnapshotID ( ) const

Returns the snapshot ID.

See Also: SnapshotID_

unsigned long long DataSnapshot::GetTotalCellCrossings ( ) const

Returns the total number of cell crossings.

See Also: TotalCellCrossings_

unsigned long long DataSnapshot::GetTotalCollisions ( ) const

Returns the total number of collisions.

See Also: TotalCollisions_

unsigned long long DataSnapshot::GetTotalConeBoundaryCollisions ( ) const

Returns the total number of cone boundary collisions.

See Also: TotalConeBoundaryCollisions_

unsigned long long DataSnapshot::GetTotalWallCollisions ( ) const

Returns the total number of wall collisions.

See Also: TotalWallCollisions_

double DataSnapshot::GetWallVelocity ( ) const

Returns the wall velocity.

See Also: WallVelocity_

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

DataReader/DataSnapshot.h
DataReader/DataSnapshot.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation