Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | Friends
reducedUnits Class Reference

Public Member Functions

 reducedUnits ()
 Construct with no argument, uses default values: More...
 
 reducedUnits (scalar refLength, scalar refTime, scalar refMass)
 Construct from components. More...
 
 reducedUnits (const IOdictionary &reducedUnitsDict)
 Construct from dictionary. More...
 
 ~reducedUnits ()
 Destructor. More...
 
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. More...
 

Private Member Functions

void calcRefValues ()
 
 reducedUnits (const reducedUnits &)
 Disallow default bitwise copy construct. More...
 
void operator= (const reducedUnits &)
 Disallow default bitwise assignment. More...
 

Private Attributes

scalar refLength_
 
scalar refTime_
 
scalar refMass_
 
scalar refEnergy_
 
scalar refTemp_
 
scalar refForce_
 
scalar refVelocity_
 
scalar refVolume_
 
scalar refPressure_
 
scalar refMassDensity_
 
scalar refNumberDensity_
 

Friends

Ostreamoperator<< (Ostream &, const reducedUnits &)
 

Detailed Description

Source files

Definition at line 50 of file reducedUnits.H.

Constructor & Destructor Documentation

◆ reducedUnits() [1/4]

reducedUnits ( const reducedUnits )
private

Disallow default bitwise copy construct.

◆ reducedUnits() [2/4]

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.

References reducedUnits::calcRefValues().

Here is the call graph for this function:

◆ reducedUnits() [3/4]

reducedUnits ( scalar  refLength,
scalar  refTime,
scalar  refMass 
)

Construct from components.

Definition at line 84 of file reducedUnits.C.

◆ reducedUnits() [4/4]

reducedUnits ( const IOdictionary reducedUnitsDict)

Construct from dictionary.

Definition at line 98 of file reducedUnits.C.

References reducedUnits::setRefValues().

Here is the call graph for this function:

◆ ~reducedUnits()

Destructor.

Definition at line 110 of file reducedUnits.C.

Member Function Documentation

◆ calcRefValues()

void calcRefValues ( )
private

◆ operator=()

void operator= ( const reducedUnits rhs)
private

Disallow default bitwise assignment.

Definition at line 150 of file reducedUnits.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ setRefValues() [1/2]

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

Definition at line 117 of file reducedUnits.C.

Referenced by reducedUnits::reducedUnits().

Here is the caller graph for this function:

◆ setRefValues() [2/2]

void setRefValues ( const IOdictionary reducedUnitsDict)

Definition at line 134 of file reducedUnits.C.

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

Here is the call graph for this function:

◆ refLength()

Foam::scalar refLength ( ) const
inline

Definition at line 28 of file reducedUnitsI.H.

References reducedUnits::refLength_.

◆ refTime()

Foam::scalar refTime ( ) const
inline

Definition at line 34 of file reducedUnitsI.H.

◆ refMass()

Foam::scalar refMass ( ) const
inline

Definition at line 40 of file reducedUnitsI.H.

◆ refTemp()

Foam::scalar refTemp ( ) const
inline

Definition at line 46 of file reducedUnitsI.H.

◆ refEnergy()

Foam::scalar refEnergy ( ) const
inline

Definition at line 52 of file reducedUnitsI.H.

◆ refForce()

Foam::scalar refForce ( ) const
inline

Definition at line 58 of file reducedUnitsI.H.

◆ refVelocity()

Foam::scalar refVelocity ( ) const
inline

Definition at line 64 of file reducedUnitsI.H.

◆ refVolume()

Foam::scalar refVolume ( ) const
inline

Definition at line 70 of file reducedUnitsI.H.

◆ refPressure()

Foam::scalar refPressure ( ) const
inline

Definition at line 76 of file reducedUnitsI.H.

◆ refMassDensity()

Foam::scalar refMassDensity ( ) const
inline

Definition at line 82 of file reducedUnitsI.H.

◆ refNumberDensity()

Foam::scalar refNumberDensity ( ) const
inline

Definition at line 88 of file reducedUnitsI.H.

Friends And Related Function Documentation

◆ operator<<

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

Field Documentation

◆ refLength_

scalar refLength_
private

Definition at line 58 of file reducedUnits.H.

Referenced by reducedUnits::calcRefValues(), and reducedUnits::refLength().

◆ refTime_

scalar refTime_
private

Definition at line 60 of file reducedUnits.H.

Referenced by reducedUnits::calcRefValues().

◆ refMass_

scalar refMass_
private

Definition at line 62 of file reducedUnits.H.

Referenced by reducedUnits::calcRefValues().

◆ refEnergy_

scalar refEnergy_
private

Definition at line 66 of file reducedUnits.H.

Referenced by reducedUnits::calcRefValues().

◆ refTemp_

scalar refTemp_
private

Definition at line 68 of file reducedUnits.H.

Referenced by reducedUnits::calcRefValues().

◆ refForce_

scalar refForce_
private

Definition at line 70 of file reducedUnits.H.

Referenced by reducedUnits::calcRefValues().

◆ refVelocity_

scalar refVelocity_
private

Definition at line 72 of file reducedUnits.H.

Referenced by reducedUnits::calcRefValues().

◆ refVolume_

scalar refVolume_
private

Definition at line 74 of file reducedUnits.H.

Referenced by reducedUnits::calcRefValues().

◆ refPressure_

scalar refPressure_
private

Definition at line 76 of file reducedUnits.H.

Referenced by reducedUnits::calcRefValues().

◆ refMassDensity_

scalar refMassDensity_
private

Definition at line 78 of file reducedUnits.H.

Referenced by reducedUnits::calcRefValues().

◆ refNumberDensity_

scalar refNumberDensity_
private

Definition at line 80 of file reducedUnits.H.

Referenced by reducedUnits::calcRefValues().

◆ kb

const Foam::scalar kb = 1.3806504e-23
static

Static data someStaticData.

Definition at line 99 of file reducedUnits.H.

Referenced by reducedUnits::calcRefValues().


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