MDSimulation::InfoStruct Class Reference

Defines the structure used to hold the configurable constants of the simulation. More...

#include <InfoStruct.h>

Public Member Functions
	InfoStruct ()
	Empty constructor simply initializes the values to zero. More...
InfoStruct	ToSimulationUnits () const
	Converts the current InfoStruct to simulation units. More...
void	Read (const rapidjson::Value &reader)
bool	operator== (const InfoStruct &rhs)
template<typename Writer >
void	Serialize (Writer &writer) const

Static Public Member Functions
static InfoStruct	ParseInfoStruct (const std::string &fname)
	Parser function to read in a JSON formatted text file and convert it to an InfoStruct. More...
static InfoStruct	DefaultInfoStruct ()
	Returns an InfoStruct with default values. More...

Public Attributes
std::vector< double >	AtomicParts
double	ConeAngle
double	ConeTan2
double	ConeSolidAngle
double	Density
double	Frequency
double	DriverPressure
double	AmbientPressure
double	AmbientRadius
double	AdiabaticRadius
double	InitialRadius
double	IsothermalRadius
double	Temperature
double	InitialTime
double	InitialVelocity
double	WallTemperature
double	EquilibriumPressure
int	LiquidType
double	LiquidDensity
double	LiquidSpeedOfSound
double	LiquidViscosity
double	LiquidSurfaceTension
double	FusionBarrier
double	AtomicDiameter [ET]
double	AtomicDiameterSquared [ET][ET]
double	AtomicMass [ET]
double	ReducedMass [ET][ET]
double	VWallThermal [ET]
double	BirdConstant [ET]
DriverMode	Driver
double	CollisionThreshold

Static Public Attributes
static const int	ET = Constants::ELEMENT_TYPES

Friends
std::ostream &	operator<< (std::ostream &stream, const InfoStruct &matrix)
	Make this easier to output.

Detailed Description

Defines the structure used to hold the configurable constants of the simulation.

These are values read in from a file and must then be g to simulation units.

Author

Spenser Bauman

Constructor & Destructor Documentation

MDSimulation::InfoStruct::InfoStruct

(

)

Empty constructor simply initializes the values to zero.

They must be set by the function deserializing the input and stored in this container. Kept private as much of its data needs to be read in from a file before values can be initialized.

Member Function Documentation

InfoStruct MDSimulation::InfoStruct::DefaultInfoStruct ( )

static

Returns an InfoStruct with default values.

(Used for testing)

Returns

The generated InfoStruct.

InfoStruct MDSimulation::InfoStruct::ParseInfoStruct ( const std::string &  fname )

static

Parser function to read in a JSON formatted text file and convert it to an InfoStruct.

This makes use of the Boost Property Tree library internally.

Parameters

fname

The name of the file to be read.

Returns

The generated InfoStruct.

InfoStruct MDSimulation::InfoStruct::ToSimulationUnits

(

)

const

Converts the current InfoStruct to simulation units.

Uses the information provided by the Units module to convert the given parameters to simulation units and returns a new InfoStruct containing the simulation applicable constants.

NOTE: This method makes the assumption that the current object is not in simulation units and is, in fact, using real world units.

Returns

A new InfoStruct where the units are transformed to simulation units.

---

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

• MDSimulation/InfoStruct/InfoStruct.h
• MDSimulation/InfoStruct/InfoStruct.cpp