reducedUnits Class Reference

#include <molecule/reducedUnits.H>

---

Detailed Description

Source files

• src/lagrangian/molecularDynamics/molecule/reducedUnits/reducedUnits.H
• src/lagrangian/molecularDynamics/molecule/reducedUnits/reducedUnitsI.H
• src/lagrangian/molecularDynamics/molecule/reducedUnits/reducedUnits.C
• src/lagrangian/molecularDynamics/molecule/reducedUnits/reducedUnitsIO.C

Definition at line 51 of file reducedUnits.H.

List of all members.

Public Member Functions
	reducedUnits ()
	Construct with no argument, uses default values:
	reducedUnits (scalar refLength, scalar refTime, scalar refMass)
	Construct from components.
	reducedUnits (const IOdictionary &reducedUnitsDict)
	Construct from dictionary.
	~reducedUnits ()
void	setRefValues (scalar refLength, scalar refTime, scalar refMass)
void	setRefValues (const IOdictionary &reducedUnitsDict)
scalar	refLength () const
scalar	refTime () const
scalar	refMass () const
scalar	refTemp () const
scalar	refEnergy () const
scalar	refForce () const
scalar	refVelocity () const
scalar	refVolume () const
scalar	refPressure () const
scalar	refMassDensity () const
scalar	refNumberDensity () const

Static Public Attributes
static const scalar	kb = 1.3806504e-23
	Static data someStaticData.

Friends
Ostream &	operator<< (Ostream &, const reducedUnits &)

---

Constructor & Destructor Documentation

reducedUnits

(

)

Construct with no argument, uses default values:

length = 1nm mass = 1.660538782e-27kg (unified atomic mass unit) temperature = 1K (therefore, energy = 1*kb)

Definition at line 73 of file reducedUnits.C.

reducedUnits	(	scalar	refLength,
		scalar	refTime,
		scalar	refMass
	)

Construct from components.

Definition at line 84 of file reducedUnits.C.

reducedUnits

(

const IOdictionary &

reducedUnitsDict

)

Construct from dictionary.

Definition at line 98 of file reducedUnits.C.

References reducedUnits::setRefValues().

~reducedUnits

(

)

Definition at line 110 of file reducedUnits.C.

---

Member Function Documentation

void setRefValues	(	scalar	refLength,
		scalar	refTime,
		scalar	refMass
	)

Definition at line 117 of file reducedUnits.C.

Referenced by reducedUnits::reducedUnits().

void setRefValues

(

const IOdictionary &

reducedUnitsDict

)

Definition at line 134 of file reducedUnits.C.

References dictionary::lookup(), and Foam::readScalar().

Foam::scalar refLength ( ) const

inline

Definition at line 28 of file reducedUnitsI.H.

Foam::scalar refTime ( ) const

inline

Definition at line 34 of file reducedUnitsI.H.

Foam::scalar refMass ( ) const

inline

Definition at line 40 of file reducedUnitsI.H.

Foam::scalar refTemp ( ) const

inline

Definition at line 46 of file reducedUnitsI.H.

Foam::scalar refEnergy ( ) const

inline

Definition at line 52 of file reducedUnitsI.H.

Foam::scalar refForce ( ) const

inline

Definition at line 58 of file reducedUnitsI.H.

Foam::scalar refVelocity ( ) const

inline

Definition at line 64 of file reducedUnitsI.H.

Foam::scalar refVolume ( ) const

inline

Definition at line 70 of file reducedUnitsI.H.

Foam::scalar refPressure ( ) const

inline

Definition at line 76 of file reducedUnitsI.H.

Foam::scalar refMassDensity ( ) const

inline

Definition at line 82 of file reducedUnitsI.H.

Foam::scalar refNumberDensity ( ) const

inline

Definition at line 88 of file reducedUnitsI.H.

---

Friends And Related Function Documentation

Ostream& operator<< ( Ostream &  , const reducedUnits &    )

friend

---

Member Data Documentation

const Foam::scalar kb = 1.3806504e-23

static

Static data someStaticData.

Definition at line 100 of file reducedUnits.H.

---

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

• src/lagrangian/molecularDynamics/molecule/reducedUnits/reducedUnits.H
• src/lagrangian/molecularDynamics/molecule/reducedUnits/reducedUnits.C
• src/lagrangian/molecularDynamics/molecule/reducedUnits/reducedUnitsI.H