Public Member Functions | List of all members
omega Class Reference

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

Public Member Functions

 omega (const Time &time, const dictionary &dict)
 Construct from dictionary. More...
 
 omega (const omega &)
 Copy constructor. More...
 
autoPtr< omega > clone () const
 Construct and return a clone. More...
 
scalar value (const scalar t) const
 Return value for time t. More...
 
scalar integral (const scalar t1, const scalar t2) const
 Return the integral between times t1 and t2. More...
 
void write (Ostream &os) const
 Write data to dictionary stream. More...
 
void operator= (const omega &)=delete
 Disallow default bitwise assignment. More...
 

Detailed Description

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

Usage
For specifying a constant rotational speed of an MRF zone: 
    MRF
    {
        cellZone    rotor;

        origin     (0 0 0);
        axis       (0 0 1);

        omega      6.28319;  // <-- Basic specification in [rad/s]

    //  omega      60 [rpm]; // <-- Equivalent specification with unit
                             //     conversion from [rpm]

    //  rpm        60;       // <-- Equivalent backwards compatible
                             //     specification for rpm. May be
                             //     removed in future.
    }
or for a tabulated ramped rotational speed of a solid body: 
    mover
    {
        type            motionSolver;

        libs            ("libfvMotionSolvers.so");

        motionSolver    solidBody;

        cellZone        innerCylinder;

        solidBodyMotionFunction  rotatingMotion;

        origin      (0 0 0);
        axis        (0 1 0);

        omega       table            // <-- Basic specification in [rad/s]
        (
            (0      0)
            (0.01   628.319)
            (0.022  628.319)
            (0.03   418.879)
            (100    418.879)
        );

    //  omega                        // <-- Equivalent specification with
    //  {                            //     unit conversion from [rpm].
    //      type        table;       //     Note that the dictionary form
    //      units       ([s] [rpm]); //     is needed for the units entry.
    //      values
    //      (
    //          (0      0)
    //          (0.01   6000)
    //          (0.022  6000)
    //          (0.03   4000)
    //          (100    4000)
    //      );
    //  }

    //  rpm         table            // <-- Equivalent backwards compatible
    //  (                            //     specification for rpm. May be
    //      (0      0)               //     removed in future.
    //      (0.01   6000)
    //      (0.022  6000)
    //      (0.03   4000)
    //      (100    4000)
    //  );
    }
See also
Foam::Function1s
Source files

Definition at line 131 of file omega1.H.

Constructor & Destructor Documentation

◆ omega() [1/2]

omega ( const Time &  time,
const dictionary &  dict 
)

Construct from dictionary.

Definition at line 67 of file omega1.C.

Referenced by omega::clone().

Here is the caller graph for this function:

◆ omega() [2/2]

omega ( const omega &  o)

Copy constructor.

Definition at line 74 of file omega1.C.

Member Function Documentation

◆ clone()

autoPtr<omega> clone ( ) const
inline

Construct and return a clone.

Definition at line 163 of file omega1.H.

References omega::omega().

Here is the call graph for this function:

◆ value()

Foam::scalar value ( const scalar  t) const
inline

Return value for time t.

Definition at line 30 of file omega1I.H.

◆ integral()

Foam::scalar integral ( const scalar  t1,
const scalar  t2 
) const
inline

Return the integral between times t1 and t2.

Definition at line 36 of file omega1I.H.

◆ write()

void write ( Ostream &  os) const

Write data to dictionary stream.

Definition at line 83 of file omega1.C.

References Foam::dimTime, IOstream::name(), Foam::unitRadians, Foam::units(), and Foam::Function1s::writeEntry().

Referenced by Foam::Function1s::writeEntry().

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

◆ operator=()

void operator= ( const omega &  )
delete

Disallow default bitwise assignment.

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