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 (const reducedUnits &)=delete
 Disallow default bitwise copy construction. 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
 
void operator= (const reducedUnits &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Attributes

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

Friends

Ostreamoperator<< (Ostream &, const reducedUnits &)
 

Detailed Description

Constructor & Destructor Documentation

◆ reducedUnits() [1/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.

◆ reducedUnits() [2/4]

reducedUnits ( scalar  refLength,
scalar  refTime,
scalar  refMass 
)

Construct from components.

Definition at line 84 of file reducedUnits.C.

◆ reducedUnits() [3/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() [4/4]

reducedUnits ( const reducedUnits )
delete

Disallow default bitwise copy construction.

◆ ~reducedUnits()

Destructor.

Definition at line 110 of file reducedUnits.C.

References reducedUnits::setRefValues().

Here is the call graph for this function:

Member Function Documentation

◆ setRefValues() [1/2]

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

Definition at line 117 of file reducedUnits.C.

References reducedUnits::refLength(), reducedUnits::refMass(), and reducedUnits::refTime().

Referenced by reducedUnits::reducedUnits(), and reducedUnits::~reducedUnits().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setRefValues() [2/2]

void setRefValues ( const IOdictionary reducedUnitsDict)

Definition at line 134 of file reducedUnits.C.

◆ refLength()

Foam::scalar refLength ( ) const
inline

Definition at line 28 of file reducedUnitsI.H.

Referenced by Foam::operator<<(), and reducedUnits::setRefValues().

Here is the caller graph for this function:

◆ refTime()

Foam::scalar refTime ( ) const
inline

Definition at line 34 of file reducedUnitsI.H.

Referenced by Foam::operator<<(), and reducedUnits::setRefValues().

Here is the caller graph for this function:

◆ refMass()

Foam::scalar refMass ( ) const
inline

Definition at line 40 of file reducedUnitsI.H.

Referenced by Foam::operator<<(), and reducedUnits::setRefValues().

Here is the caller graph for this function:

◆ refTemp()

Foam::scalar refTemp ( ) const
inline

Definition at line 46 of file reducedUnitsI.H.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ refEnergy()

Foam::scalar refEnergy ( ) const
inline

Definition at line 52 of file reducedUnitsI.H.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ refForce()

Foam::scalar refForce ( ) const
inline

Definition at line 58 of file reducedUnitsI.H.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ refVelocity()

Foam::scalar refVelocity ( ) const
inline

Definition at line 64 of file reducedUnitsI.H.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ refVolume()

Foam::scalar refVolume ( ) const
inline

Definition at line 70 of file reducedUnitsI.H.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ refPressure()

Foam::scalar refPressure ( ) const
inline

Definition at line 76 of file reducedUnitsI.H.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ refMassDensity()

Foam::scalar refMassDensity ( ) const
inline

Definition at line 82 of file reducedUnitsI.H.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ refNumberDensity()

Foam::scalar refNumberDensity ( ) const
inline

Definition at line 88 of file reducedUnitsI.H.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const reducedUnits )
delete

Disallow default bitwise assignment.

Friends And Related Function Documentation

◆ operator<<

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

Member Data Documentation

◆ kb

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: