omega Class Reference

Convenience class to handle the input of constant rotational speed. Reads an omega entry with default units of [rad/s]. For backwards compatibility this will also alternatively read an rpm entry with default units of [rpm]. More...

Inheritance diagram for omega:
Collaboration diagram for omega:

Public Member Functions

 omega (const dictionary &dict)
 Construct from dictionary. More...
 
- Public Member Functions inherited from dimensioned< scalar >
 dimensioned ()
 Null constructor. More...
 
 dimensioned (const word &, const dimensionSet &, const scalar &)
 Construct given name, dimensions and value. More...
 
 dimensioned (const dimensionSet &, const scalar &)
 Construct given dimensions and value. More...
 
 dimensioned (const scalar &)
 Construct dimensionless given value only. More...
 
 dimensioned (const word &, const dimensioned< scalar > &)
 Construct from a dimensioned<Type> changing the name. More...
 
 dimensioned (Istream &)
 Construct from Istream. More...
 
 dimensioned (const word &, Istream &)
 Construct from an Istream with a given name. More...
 
 dimensioned (const word &, const dimensionSet &, Istream &)
 Construct from an Istream with a given name and dimensions. More...
 
 dimensioned (const word &, const dimensionSet &, const dictionary &)
 Construct from dictionary lookup with a given name and dimensions. More...
 
const wordname () const
 Return const reference to name. More...
 
wordname ()
 Return non-const reference to name. More...
 
const dimensionSetdimensions () const
 Return const reference to dimensions. More...
 
dimensionSetdimensions ()
 Return non-const reference to dimensions. More...
 
const scalar & value () const
 Return const reference to value. More...
 
scalar & value ()
 Return non-const reference to value. More...
 
dimensioned< cmptTypecomponent (const direction) const
 Return a component as a dimensioned<cmptType> More...
 
void replace (const direction, const dimensioned< cmptType > &)
 Return a component with a dimensioned<cmptType> More...
 
dimensioned< scalar > T () const
 Return transpose. More...
 
void read (const dictionary &)
 Update the value of dimensioned<Type> More...
 
bool readIfPresent (const dictionary &)
 Update the value of dimensioned<Type> if found in the dictionary. More...
 
dimensioned< cmptTypeoperator[] (const direction) const
 Return a component as a dimensioned<cmptType> More...
 
void operator+= (const dimensioned< scalar > &)
 
void operator-= (const dimensioned< scalar > &)
 
void operator*= (const scalar)
 
void operator/= (const scalar)
 

Additional Inherited Members

- Public Types inherited from dimensioned< scalar >
typedef pTraits< scalar >::cmptType cmptType
 Component type. More...
 
- Static Public Member Functions inherited from dimensioned< scalar >
static dimensioned< scalar > lookupOrDefault (const word &, const dictionary &, const dimensionSet &dims=dimless, const scalar &defaultValue=pTraits< scalar >::zero)
 Construct from dictionary, with default dimensions and value. More...
 
static dimensioned< scalar > lookupOrDefault (const word &, const dictionary &, const scalar &defaultValue=pTraits< scalar >::zero)
 Construct from dictionary dimensionless with value. More...
 
static dimensioned< scalar > lookupOrAddToDict (const word &, dictionary &, const dimensionSet &dims=dimless, const scalar &defaultValue=pTraits< scalar >::zero)
 Construct from dictionary, with default value. More...
 
static dimensioned< scalar > lookupOrAddToDict (const word &, dictionary &, const scalar &defaultValue=pTraits< scalar >::zero)
 Construct from dictionary, dimensionless with default value. More...
 

Detailed Description

Convenience class to handle the input of constant rotational speed. Reads an omega entry with default units of [rad/s]. For backwards compatibility this will also alternatively read an rpm entry with default units of [rpm].

Source files

Definition at line 51 of file omega.H.

Constructor & Destructor Documentation

◆ omega()

omega ( const dictionary dict)

Construct from dictionary.

Definition at line 31 of file omega.C.

References dict, Foam::dimTime, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::unitRadians, Foam::units(), and dimensioned< scalar >::value().

Here is the call graph for this function:

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