CodeUnits Class Reference

Class to set units for computation (normally all ones). More...

#include <CodeUnits.H>

List of all members.

Public Member Functions
	CodeUnits ()
	null constructor
	CodeUnits (const Real &a_unitTime, const Real &a_unitLength, const Real &a_unitDensity)
	full constructor
	CodeUnits (const CodeUnits &a_input)
	copy constructor
virtual	~CodeUnits ()
	Destructor.
void	define ()
	null constructor
void	define (const Real &a_unitTime, const Real &a_unitLength, const Real &a_unitDensity)
	full constructor
void	define (const CodeUnits &a_input)
	copy constructor
void	operator= (const CodeUnits &a_input)
	copy constructor
Real	length () const
Real	massDensity () const
Real	velocity () const
Real	time () const
Real	pressure () const
Real	temperature () const
Real	hydrogenMassFraction () const
Real	heliumMassFraction () const
Real	numDensityHydrogen () const
Real	numDensityHelium () const
bool	isDefined () const
	Has this object been defined?

---

Detailed Description

Class to set units for computation (normally all ones).

This class set the units used for the computation; allows use of alternate unit systems and scalings. In most uses, these are all ones

---

Constructor & Destructor Documentation

CodeUnits::CodeUnits (   )

null constructor

CodeUnits::CodeUnits (  const Real &  a_unitTime, const Real &  a_unitLength, const Real &  a_unitDensity )

full constructor

CodeUnits::CodeUnits (  const CodeUnits &  a_input  )

copy constructor

virtual CodeUnits::~CodeUnits (   )  [virtual]

Destructor.

---

Member Function Documentation

void CodeUnits::define (  const CodeUnits &  a_input  )

copy constructor

void CodeUnits::define (  const Real &  a_unitTime, const Real &  a_unitLength, const Real &  a_unitDensity )

full constructor

void CodeUnits::define (   )

null constructor

Real CodeUnits::heliumMassFraction (   )  const

Real CodeUnits::hydrogenMassFraction (   )  const

bool CodeUnits::isDefined (   )  const

Has this object been defined?

Real CodeUnits::length (   )  const

Real CodeUnits::massDensity (   )  const

Real CodeUnits::numDensityHelium (   )  const

Real CodeUnits::numDensityHydrogen (   )  const

void CodeUnits::operator= (  const CodeUnits &  a_input  )

copy constructor

Real CodeUnits::pressure (   )  const

Real CodeUnits::temperature (   )  const

Real CodeUnits::time (   )  const

Real CodeUnits::velocity (   )  const

---

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

• CodeUnits.H

---