Top level model for single rotating frame. More...
#include <finiteVolume/SRFModel.H>
Top level model for single rotating frame.
- Steady state only - no time derivatives included
Definition at line 62 of file SRFModel.H.
Inheritance diagram for SRFModel: Collaboration diagram for SRFModel:Public Member Functions | |
| TypeName ("SRFModel") | |
| Runtime type information. | |
| declareRunTimeSelectionTable (autoPtr, SRFModel, dictionary,(const volVectorField &Urel),(Urel)) | |
| SRFModel (const word &type, const volVectorField &Urel) | |
| Construct from components. | |
| virtual | ~SRFModel () |
| virtual bool | read () |
| Read radiationProperties dictionary. | |
| const vector & | axis () const |
| Return the axis of rotation. | |
| const dimensionedVector & | omega () const |
| Return the angular velocity field [rad/s]. | |
| tmp< DimensionedField< vector, volMesh > > | Fcoriolis () const |
| Return the coriolis force. | |
| tmp< DimensionedField< vector, volMesh > > | Fcentrifugal () const |
| Return the centrifugal force. | |
| tmp< DimensionedField< vector, volMesh > > | Su () const |
| Source term component for momentum equation. | |
| vectorField | velocity (const vectorField &positions) const |
| Return velocity vector from positions. | |
| tmp< volVectorField > | U () const |
| Return velocity of SRF for complete mesh. | |
| tmp< volVectorField > | Uabs () const |
| Return absolute velocity for complete mesh. | |
| Public Member Functions inherited from IOdictionary | |
| TypeName ("dictionary") | |
| IOdictionary (const IOobject &) | |
| Construct given an IOobject. | |
| IOdictionary (const IOobject &, const dictionary &) | |
| Construct given an IOobject and dictionary. | |
| virtual | ~IOdictionary () |
| const word & | name () const |
| Name function is needed to disambiguate those inherited. | |
| bool | readData (Istream &) |
| ReadData function required for regIOobject read operation. | |
| bool | writeData (Ostream &) const |
| WriteData function required for regIOobject write operation. | |
| virtual bool | write () const |
| Write using setting from DB. | |
| void | operator= (const IOdictionary &) |
| Assignment of other IOdictionary's entries to this IOdictionary. | |
| Public Member Functions inherited from regIOobject | |
| TypeName ("regIOobject") | |
| Runtime type information. | |
| regIOobject (const IOobject &, const bool isTime=false) | |
| Construct from IOobject. Optional flag for if IOobject is the. | |
| regIOobject (const regIOobject &) | |
| Construct as copy. | |
| regIOobject (const regIOobject &, bool registerCopy) | |
| Construct as copy, and transferring registry registration to copy. | |
| virtual | ~regIOobject () |
| bool | checkIn () |
| Add object to registry. | |
| bool | checkOut () |
| Remove object from registry. | |
| bool | ownedByRegistry () const |
| Is this object owned by the registry? | |
| void | store () |
| Transfer ownership of this object to its registry. | |
| void | release () |
| Release ownership of this object from its registry. | |
| label | eventNo () const |
| Event number at last update. | |
| label & | eventNo () |
| Event number at last update. | |
| bool | upToDate (const word &) const |
| Am I uptodate with respect to other regIOobjects. | |
| bool | upToDate (const word &, const word &) const |
| bool | upToDate (const word &, const word &, const word &) const |
| bool | upToDate (const word &, const word &, const word &, const word &) const |
| void | setUpToDate () |
| Flag me as up to date. | |
| virtual void | rename (const word &newName) |
| Rename. | |
| Istream & | readStream (const word &) |
| Return Istream and check object type against that given. | |
| void | close () |
| Close Istream. | |
| virtual bool | modified () const |
| Return true if the object's file has been modified. | |
| virtual bool | readIfModified () |
| Read object if modified. | |
| virtual bool | writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const |
| Write using given format, version and compression. | |
| void | operator= (const IOobject &) |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Runtime type information. | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from name, instance, registry, io options. | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from name, instance, local, registry, io options. | |
| IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from path, registry, io options. | |
| Foam::autoPtr< IOobject > | clone () const |
| Clone. | |
| virtual | ~IOobject () |
| const Time & | time () const |
| Return time. | |
| const objectRegistry & | db () const |
| Return the local objectRegistry. | |
| const word & | headerClassName () const |
| Return name of the class name read from header. | |
| string & | note () |
| Return non-constant access to the optional note. | |
| const string & | note () const |
| Return the optional note. | |
| bool | registerObject () const |
| Register object created from this IOobject with registry if true. | |
| readOption | readOpt () const |
| readOption & | readOpt () |
| writeOption | writeOpt () const |
| writeOption & | writeOpt () |
| const fileName & | rootPath () const |
| const fileName & | caseName () const |
| const fileName & | instance () const |
| fileName & | instance () |
| const fileName & | local () const |
| fileName | path () const |
| Return complete path. | |
| fileName | path (const word &instance, const fileName &local="") const |
| Return complete path with alternative instance and local. | |
| fileName | objectPath () const |
| Return complete path + object name. | |
| fileName | filePath () const |
| Return complete path + object name if the file exists. | |
| bool | readHeader (Istream &) |
| Read header. | |
| bool | headerOk () |
| Read and check header info. | |
| bool | writeHeader (Ostream &) const |
| Write header. | |
| bool | good () const |
| bool | bad () const |
| InfoProxy< IOobject > | info () const |
| Return info proxy. | |
| Public Member Functions inherited from dictionary | |
| ClassName ("dictionary") | |
| dictionary () | |
| Construct top-level dictionary null. | |
| dictionary (const fileName &name) | |
| Construct top-level empty dictionary with given name. | |
| dictionary (const fileName &name, const dictionary &parentDict, Istream &) | |
| Construct given the entry name, parent dictionary and Istream,. | |
| dictionary (Istream &) | |
| Construct top-level dictionary from Istream, reading entries. | |
| dictionary (const dictionary &parentDict, const dictionary &) | |
| Construct as copy given the parent dictionary. | |
| dictionary (const dictionary &) | |
| Construct top-level dictionary as copy. | |
| dictionary (const dictionary *) | |
| Construct top-level dictionary as copy from pointer to dictionary. | |
| dictionary (const dictionary &parentDict, const Xfer< dictionary > &) | |
| Construct by transferring parameter contents given parent dictionary. | |
| dictionary (const Xfer< dictionary > &) | |
| Construct top-level dictionary by transferring parameter contents. | |
| autoPtr< dictionary > | clone () const |
| Construct and return clone. | |
| ~dictionary () | |
| const dictionary & | parent () const |
| Return the parent dictionary. | |
| label | startLineNumber () const |
| Return line number of first token in dictionary. | |
| label | endLineNumber () const |
| Return line number of last token in dictionary. | |
| SHA1Digest | digest () const |
| Return the SHA1 digest of the dictionary contents. | |
| bool | found (const word &, bool recursive=false) const |
| Search dictionary for given keyword. | |
| const entry * | lookupEntryPtr (const word &, bool recursive, bool patternMatch) const |
| Find and return an entry data stream pointer if present. | |
| entry * | lookupEntryPtr (const word &, bool recursive, bool patternMatch) |
| Find and return an entry data stream pointer for manipulation. | |
| const entry & | lookupEntry (const word &, bool recursive, bool patternMatch) const |
| Find and return an entry data stream if present otherwise error. | |
| ITstream & | lookup (const word &, bool recursive=false, bool patternMatch=true) const |
| Find and return an entry data stream. | |
| template<class T > | |
| T | lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const |
| Find and return a T,. | |
| template<class T > | |
| T | lookupOrAddDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) |
| Find and return a T, if not found return the given. | |
| template<class T > | |
| bool | readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const |
| Find an entry if present, and assign to T. | |
| bool | isDict (const word &) const |
| Check if entry is a sub-dictionary. | |
| const dictionary * | subDictPtr (const word &) const |
| Find and return a sub-dictionary pointer if present. | |
| const dictionary & | subDict (const word &) const |
| Find and return a sub-dictionary. | |
| dictionary & | subDict (const word &) |
| Find and return a sub-dictionary for manipulation. | |
| dictionary | subOrEmptyDict (const word &) const |
| Find and return a sub-dictionary as a copy, or. | |
| wordList | toc () const |
| Return the table of contents. | |
| List< keyType > | keys (bool patterns=false) const |
| Return the list of available keys or patterns. | |
| bool | substituteKeyword (const word &keyword) |
| Substitute the given keyword prepended by '$' with the. | |
| bool | add (entry *, bool mergeEntry=false) |
| Add a new entry. | |
| void | add (const entry &, bool mergeEntry=false) |
| Add an entry. | |
| void | add (const keyType &, const word &, bool overwrite=false) |
| Add a word entry. | |
| void | add (const keyType &, const string &, bool overwrite=false) |
| Add a string entry. | |
| void | add (const keyType &, const label, bool overwrite=false) |
| Add a label entry. | |
| void | add (const keyType &, const scalar, bool overwrite=false) |
| Add a scalar entry. | |
| void | add (const keyType &, const dictionary &, bool mergeEntry=false) |
| Add a dictionary entry. | |
| template<class T > | |
| void | add (const keyType &, const T &, bool overwrite=false) |
| Add a T entry. | |
| void | set (entry *) |
| Assign a new entry, overwrite any existing entry. | |
| void | set (const entry &) |
| Assign a new entry, overwrite any existing entry. | |
| void | set (const keyType &, const dictionary &) |
| Assign a dictionary entry, overwrite any existing entry. | |
| template<class T > | |
| void | set (const keyType &, const T &) |
| Assign a T entry, overwrite any existing entry. | |
| bool | remove (const word &) |
| Remove an entry specified by keyword. | |
| bool | changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false) |
| Change the keyword for an entry,. | |
| bool | merge (const dictionary &) |
| Merge entries from the given dictionary. | |
| void | clear () |
| Clear the dictionary. | |
| void | transfer (dictionary &) |
| Transfer the contents of the argument and annul the argument. | |
| Xfer< dictionary > | xfer () |
| Transfer contents to the Xfer container. | |
| bool | read (Istream &) |
| Read dictionary from Istream. | |
| void | write (Ostream &, bool subDict=true) const |
| ITstream & | operator[] (const word &) const |
| Find and return entry. | |
| void | operator= (const dictionary &) |
| void | operator+= (const dictionary &) |
| Include entries from the given dictionary. | |
| void | operator|= (const dictionary &) |
| Conditionally include entries from the given dictionary. | |
| void | operator<<= (const dictionary &) |
| Unconditionally include entries from the given dictionary. | |
| Public Member Functions inherited from dictionaryName | |
| dictionaryName () | |
| Construct dictionaryName null. | |
| dictionaryName (const fileName &name) | |
| Construct dictionaryName as copy of the given fileName. | |
| fileName & | name () |
| Return the dictionary name. | |
| Public Member Functions inherited from IDLList< entry > | |
| IDLList () | |
| Null construct. | |
| IDLList (const entry &a) | |
| Construct given initial T. | |
| IDLList (Istream &is, const INew &inewt) | |
| Construct from Istream using given Istream constructor class. | |
| IDLList (Istream &is) | |
| Construct from Istream. | |
| IDLList (const IDLList< entry > &idll, const CloneArg &cloneArg) | |
| Copy constructor with additional argument for clone. | |
| Public Member Functions inherited from ILList< DLListBase, entry > | |
| ILList () | |
| Null construct. | |
| ILList (entry *a) | |
| Construct given initial T. | |
| ILList (Istream &) | |
| Construct from Istream. | |
| ILList (const ILList< DLListBase, entry > &) | |
| Construct as copy. | |
| ILList (const ILList< DLListBase, entry > &lst, const CloneArg &cloneArg) | |
| Copy constructor with additional argument for clone. | |
| ILList (Istream &, const INew &) | |
| Construct from Istream using given Istream constructor class. | |
| ~ILList () | |
| bool | eraseHead () |
| Remove the head element specified from the list and delete it. | |
| bool | erase (entry *p) |
| Remove the specified element from the list and delete it. | |
| void | transfer (ILList< DLListBase, entry > &) |
| Transfer the contents of the argument into this List. | |
| void | operator= (const ILList< DLListBase, entry > &) |
| Public Member Functions inherited from UILList< DLListBase, entry > | |
| UILList () | |
| Null construct. | |
| UILList (entry *a) | |
| Construct given initial T. | |
| UILList (const UILList< DLListBase, entry > &) | |
| Construct as copy. | |
| entry * | first () |
| Return the first entry. | |
| const entry * | first () const |
| Return the first entry. | |
| entry * | last () |
| Return the last entry. | |
| const entry * | last () const |
| Return the last entry. | |
| entry * | removeHead () |
| Remove and return head. | |
| entry * | remove (entry *p) |
| Remove and return element. | |
| entry * | remove (iterator &it) |
| Remove and return specified by iterator. | |
| void | operator= (const UILList< DLListBase, entry > &) |
| bool | operator== (const UILList< DLListBase, entry > &) const |
| Equality operation on ULists of the same type. | |
| bool | operator!= (const UILList< DLListBase, entry > &) const |
| The opposite of the equality operation. Takes linear time. | |
| Public Member Functions inherited from DLListBase | |
| DLListBase () | |
| Null construct. | |
| DLListBase (link *) | |
| Construct given initial entry. | |
| ~DLListBase () | |
| label | size () const |
| Return number of elements in list. | |
| bool | empty () const |
| Return true if the list is empty. | |
| void | insert (link *) |
| Add at head of list. | |
| void | append (link *) |
| Add at tail of list. | |
| bool | swapUp (link *) |
| Swap this element with the one above unless it is at the top. | |
| bool | swapDown (link *) |
| Swap this element with the one below unless it is at the bottom. | |
| link * | remove (link *) |
| Remove and return element. | |
| link * | replace (link *oldLink, link *newLink) |
| Replace oldLink with newLink and return element. | |
| link * | replace (iterator &oldIter, link *newLink) |
| Replace oldIter with newLink and return element. | |
| void | transfer (DLListBase &) |
| Transfer the contents of the argument into this List. | |
| iterator | begin () |
| const iterator & | end () |
| const_iterator | cbegin () const |
| const const_iterator & | cend () const |
| const_iterator | begin () const |
| const const_iterator & | end () const |
Static Public Member Functions | |
| static autoPtr< SRFModel > | New (const volVectorField &Urel) |
| Return a reference to the selected SRF model. | |
Protected Attributes | |
| const volVectorField & | Urel_ |
| Reference to the relative velocity field. | |
| const fvMesh & | mesh_ |
| Reference to the mesh. | |
| vector | axis_ |
| Axis of rotation. | |
| dictionary | SRFModelCoeffs_ |
| SRF model coeficients dictionary. | |
| dimensionedVector | omega_ |
| Angular velocity of the frame (rad/s) | |
| SRFModel | ( | const word & | type, |
| const volVectorField & | Urel | ||
| ) |
|
virtual |
Definition at line 73 of file SRFModel.C.
| TypeName | ( | "SRFModel" | ) |
Runtime type information.
| declareRunTimeSelectionTable | ( | autoPtr | , |
| SRFModel | , | ||
| dictionary | , | ||
| (const volVectorField &Urel) | , | ||
| (Urel) | |||
| ) |
|
static |
Return a reference to the selected SRF model.
Definition at line 40 of file newSRFModel.C.
References TimePaths::constant(), IOobject::db(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, dictionary::lookup(), IOobject::MUST_READ, Foam::nl, IOobject::NO_WRITE, and IOobject::time().
|
virtual |
Read radiationProperties dictionary.
Reimplemented from regIOobject.
Reimplemented in rpm.
Definition at line 79 of file SRFModel.C.
References Foam::mag(), regIOobject::read(), and Foam::type().
Referenced by rpm::read().
| const Foam::vector & axis | ( | ) | const |
Return the axis of rotation.
Definition at line 99 of file SRFModel.C.
Referenced by SRFFreestreamVelocityFvPatchVectorField::updateCoeffs().
| const Foam::dimensionedVector & omega | ( | ) | const |
Return the angular velocity field [rad/s].
Definition at line 105 of file SRFModel.C.
Referenced by SRFFreestreamVelocityFvPatchVectorField::updateCoeffs().
| Foam::tmp< Foam::DimensionedField< Foam::vector, Foam::volMesh > > Fcoriolis | ( | ) | const |
Return the coriolis force.
Definition at line 112 of file SRFModel.C.
References IOobject::NO_READ, and IOobject::NO_WRITE.
| Foam::tmp< Foam::DimensionedField< Foam::vector, Foam::volMesh > > Fcentrifugal | ( | ) | const |
Return the centrifugal force.
Definition at line 133 of file SRFModel.C.
References IOobject::NO_READ, and IOobject::NO_WRITE.
| Foam::tmp< Foam::DimensionedField< Foam::vector, Foam::volMesh > > Su | ( | ) | const |
Source term component for momentum equation.
Definition at line 154 of file SRFModel.C.
| Foam::vectorField velocity | ( | const vectorField & | positions | ) | const |
Return velocity vector from positions.
Definition at line 161 of file SRFModel.C.
Referenced by SRFFreestreamVelocityFvPatchVectorField::updateCoeffs(), and SRFVelocityFvPatchVectorField::updateCoeffs().
| Foam::tmp< Foam::volVectorField > U | ( | ) | const |
Return velocity of SRF for complete mesh.
Definition at line 169 of file SRFModel.C.
References IOobject::NO_READ, and IOobject::NO_WRITE.
| Foam::tmp< Foam::volVectorField > Uabs | ( | ) | const |
Return absolute velocity for complete mesh.
Definition at line 189 of file SRFModel.C.
References forAll, IOobject::NO_READ, IOobject::NO_WRITE, SRFVelocityFvPatchVectorField::relative(), and U.
|
protected |
Reference to the relative velocity field.
Definition at line 72 of file SRFModel.H.
|
protected |
Reference to the mesh.
Definition at line 75 of file SRFModel.H.
|
protected |
Axis of rotation.
Definition at line 78 of file SRFModel.H.
|
protected |
SRF model coeficients dictionary.
Definition at line 81 of file SRFModel.H.
|
protected |
Angular velocity of the frame (rad/s)
Definition at line 84 of file SRFModel.H.
