Public Member Functions | Static Public Attributes | List of all members
fvSchemes Class Reference

Selector class for finite volume differencing schemes. fvMesh is derived from fvShemes so that all fields have access to the fvSchemes from the mesh reference they hold. More...

Inheritance diagram for fvSchemes:
Inheritance graph
[legend]
Collaboration diagram for fvSchemes:
Collaboration graph
[legend]

Public Member Functions

 fvSchemes (const objectRegistry &obr)
 Construct for objectRegistry. More...
 
const dictionaryschemesDict () const
 
ITstreamddtScheme (const word &name) const
 
ITstreamd2dt2Scheme (const word &name) const
 
ITstreaminterpolationScheme (const word &name) const
 
ITstreamdivScheme (const word &name) const
 
ITstreamgradScheme (const word &name) const
 
ITstreamsnGradScheme (const word &name) const
 
ITstreamlaplacianScheme (const word &name) const
 
void setFluxRequired (const word &name) const
 
bool fluxRequired (const word &name) const
 
bool steady () const
 Return true if the default ddtScheme is steadyState. More...
 
bool transient () const
 Return true if the default ddtScheme is not steadyState. More...
 
bool read ()
 Read the fvSchemes. More...
 
- Public Member Functions inherited from IOdictionary
 TypeName ("dictionary")
 
 IOdictionary (const IOobject &)
 Construct given an IOobject. More...
 
 IOdictionary (const IOobject &, const dictionary &)
 Construct given an IOobject and dictionary. More...
 
 IOdictionary (const IOobject &, Istream &)
 Construct given an IOobject and Istream. More...
 
virtual ~IOdictionary ()
 Destructor. More...
 
const wordname () const
 Name function is needed to disambiguate those inherited. More...
 
bool readData (Istream &)
 ReadData function required for regIOobject read operation. More...
 
bool writeData (Ostream &) const
 WriteData function required for regIOobject write operation. More...
 
void operator= (const IOdictionary &)
 Assignment of other IOdictionary's entries to this IOdictionary. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Construct as copy. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Construct as copy with new name, transfering registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Construct as copy with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set up to date (obviously) More...
 
virtual void rename (const word &newName)
 Rename. More...
 
IstreamreadStream (const word &)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
label watchIndex () const
 Return file-monitoring handle. More...
 
labelwatchIndex ()
 Return file-monitoring handle. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
 Write using given format, version and compression. More...
 
virtual bool write () const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
Foam::autoPtr< IOobjectclone () const
 Clone. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
bool & registerObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () const
 
fileName path () const
 Return complete path. More...
 
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read and check header info. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 
 dictionary ()
 Construct top-level dictionary null. More...
 
 dictionary (const fileName &name)
 Construct top-level empty dictionary with given name. More...
 
 dictionary (const fileName &name, const dictionary &parentDict, Istream &)
 Construct given the entry name, parent dictionary and Istream,. More...
 
 dictionary (Istream &)
 Construct top-level dictionary from Istream,. More...
 
 dictionary (Istream &, const bool keepHeader)
 Construct top-level dictionary from Istream,. More...
 
 dictionary (const dictionary &parentDict, const dictionary &)
 Construct as copy given the parent dictionary. More...
 
 dictionary (const dictionary &)
 Construct top-level dictionary as copy. More...
 
 dictionary (const dictionary *)
 Construct top-level dictionary as copy from pointer to dictionary. More...
 
 dictionary (const dictionary &parentDict, const Xfer< dictionary > &)
 Construct by transferring parameter contents given parent dictionary. More...
 
 dictionary (const Xfer< dictionary > &)
 Construct top-level dictionary by transferring parameter contents. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const dictionaryparent () const
 Return the parent dictionary. More...
 
const dictionarytopDict () const
 Return the top of the tree. More...
 
label startLineNumber () const
 Return line number of first token in dictionary. More...
 
label endLineNumber () const
 Return line number of last token in dictionary. More...
 
SHA1Digest digest () const
 Return the SHA1 digest of the dictionary contents. More...
 
tokenList tokens () const
 Return the dictionary as a list of tokens. More...
 
bool found (const word &, bool recursive=false, bool patternMatch=true) const
 Search dictionary for given keyword. More...
 
const entrylookupEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
entrylookupEntryPtr (const word &, bool recursive, bool patternMatch)
 Find and return an entry data stream pointer for manipulation. More...
 
const entrylookupEntry (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present otherwise error. More...
 
ITstreamlookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return an entry data stream. More...
 
template<class T >
T lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. More...
 
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. More...
 
template<class T >
bool readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const
 Find an entry if present, and assign to T. More...
 
const entrylookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
bool isDict (const word &) const
 Check if entry is a sub-dictionary. More...
 
const dictionarysubDictPtr (const word &) const
 Find and return a sub-dictionary pointer if present. More...
 
const dictionarysubDict (const word &) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (const word &)
 Find and return a sub-dictionary for manipulation. More...
 
dictionary subOrEmptyDict (const word &, const bool mustRead=false) const
 Find and return a sub-dictionary as a copy, or. More...
 
wordList toc () const
 Return the table of contents. More...
 
wordList sortedToc () const
 Return the sorted table of contents. More...
 
List< keyTypekeys (bool patterns=false) const
 Return the list of available keys or patterns. More...
 
bool substituteKeyword (const word &keyword)
 Substitute the given keyword prepended by '$' with the. More...
 
bool substituteScopedKeyword (const word &keyword)
 Substitute the given scoped keyword prepended by '$' with the. More...
 
bool add (entry *, bool mergeEntry=false)
 Add a new entry. More...
 
void add (const entry &, bool mergeEntry=false)
 Add an entry. More...
 
void add (const keyType &, const word &, bool overwrite=false)
 Add a word entry. More...
 
void add (const keyType &, const string &, bool overwrite=false)
 Add a string entry. More...
 
void add (const keyType &, const label, bool overwrite=false)
 Add a label entry. More...
 
void add (const keyType &, const scalar, bool overwrite=false)
 Add a scalar entry. More...
 
void add (const keyType &, const dictionary &, bool mergeEntry=false)
 Add a dictionary entry. More...
 
template<class T >
void add (const keyType &, const T &, bool overwrite=false)
 Add a T entry. More...
 
void set (entry *)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const entry &)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const keyType &, const dictionary &)
 Assign a dictionary entry, overwrite any existing entry. More...
 
template<class T >
void set (const keyType &, const T &)
 Assign a T entry, overwrite any existing entry. More...
 
bool remove (const word &)
 Remove an entry specified by keyword. More...
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false)
 Change the keyword for an entry,. More...
 
bool merge (const dictionary &)
 Merge entries from the given dictionary. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (dictionary &)
 Transfer the contents of the argument and annul the argument. More...
 
Xfer< dictionaryxfer ()
 Transfer contents to the Xfer container. More...
 
bool read (Istream &)
 Read dictionary from Istream. More...
 
bool read (Istream &, const bool keepHeader)
 Read dictionary from Istream, optionally keeping the header. More...
 
void write (Ostream &, const bool subDict=true) const
 Write dictionary, normally with sub-dictionary formatting. More...
 
ITstreamoperator[] (const word &) const
 Find and return entry. More...
 
void operator= (const dictionary &)
 
void operator+= (const dictionary &)
 Include entries from the given dictionary. More...
 
void operator|= (const dictionary &)
 Conditionally include entries from the given dictionary. More...
 
void operator<<= (const dictionary &)
 Unconditionally include entries from the given dictionary. More...
 
- Public Member Functions inherited from dictionaryName
 dictionaryName ()
 Construct dictionaryName null. More...
 
 dictionaryName (const fileName &name)
 Construct dictionaryName as copy of the given fileName. More...
 
const fileNamename () const
 Return the dictionary name. More...
 
fileNamename ()
 Return the dictionary name. More...
 
const word dictName () const
 Return the local dictionary name (final part of scoped name) More...
 
- Public Member Functions inherited from IDLList< entry >
 IDLList ()
 Null construct. More...
 
 IDLList (const entry &a)
 Construct given initial T. More...
 
 IDLList (Istream &is, const INew &inewt)
 Construct from Istream using given Istream constructor class. More...
 
 IDLList (Istream &is)
 Construct from Istream. More...
 
 IDLList (const IDLList< entry > &idll, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
- Public Member Functions inherited from ILList< DLListBase, entry >
 ILList ()
 Null construct. More...
 
 ILList (entry *a)
 Construct given initial T. More...
 
 ILList (Istream &)
 Construct from Istream. More...
 
 ILList (const ILList< DLListBase, entry > &)
 Construct as copy. More...
 
 ILList (const ILList< DLListBase, entry > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
 ILList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 ~ILList ()
 Destructor. More...
 
bool eraseHead ()
 Remove the head element specified from the list and delete it. More...
 
bool erase (entry *p)
 Remove the specified element from the list and delete it. More...
 
void clear ()
 Clear the contents of the list. More...
 
void transfer (ILList< DLListBase, entry > &)
 Transfer the contents of the argument into this List. More...
 
void operator= (const ILList< DLListBase, entry > &)
 
- Public Member Functions inherited from UILList< DLListBase, entry >
 UILList ()
 Null construct. More...
 
 UILList (entry *a)
 Construct given initial T. More...
 
 UILList (const UILList< DLListBase, entry > &)
 Construct as copy. More...
 
entryfirst ()
 Return the first entry. More...
 
const entryfirst () const
 Return the first entry. More...
 
entrylast ()
 Return the last entry. More...
 
const entrylast () const
 Return the last entry. More...
 
entryremoveHead ()
 Remove and return head. More...
 
entryremove (entry *p)
 Remove and return element. More...
 
entryremove (iterator &it)
 Remove and return specified by iterator. More...
 
void operator= (const UILList< DLListBase, entry > &)
 
iterator begin ()
 
const_iterator begin () const
 
const iteratorend ()
 
const const_iteratorend () const
 
const_iterator cbegin () const
 
const const_iteratorcend () const
 
const_reverse_iterator crbegin () const
 
const const_reverse_iteratorcrend () const
 
const_reverse_iterator rbegin () const
 
const const_reverse_iteratorrend () const
 
bool operator== (const UILList< DLListBase, entry > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UILList< DLListBase, entry > &) const
 The opposite of the equality operation. Takes linear time. More...
 
- Public Member Functions inherited from DLListBase
 DLListBase ()
 Null construct. More...
 
 DLListBase (link *)
 Construct given initial entry. More...
 
 ~DLListBase ()
 Destructor. More...
 
label size () const
 Return number of elements in list. More...
 
bool empty () const
 Return true if the list is empty. More...
 
linkfirst ()
 Return first entry. More...
 
const linkfirst () const
 Return const access to first entry. More...
 
linklast ()
 Return last entry. More...
 
const linklast () const
 Return const access to last entry. More...
 
void insert (link *)
 Add at head of list. More...
 
void append (link *)
 Add at tail of list. More...
 
bool swapUp (link *)
 Swap this element with the one above unless it is at the top. More...
 
bool swapDown (link *)
 Swap this element with the one below unless it is at the bottom. More...
 
linkremoveHead ()
 Remove and return head. More...
 
linkremove (link *)
 Remove and return element. More...
 
linkremove (iterator &)
 
linkreplace (link *oldLink, link *newLink)
 Replace oldLink with newLink and return element. More...
 
linkreplace (iterator &oldIter, link *newLink)
 Replace oldIter with newLink and return element. More...
 
void clear ()
 Clear the list. More...
 
void transfer (DLListBase &)
 Transfer the contents of the argument into this List. More...
 
iterator begin ()
 
const iteratorend ()
 
const_iterator cbegin () const
 
const const_iteratorcend () const
 
const_iterator begin () const
 
const const_iteratorend () const
 
const_reverse_iterator crbegin () const
 
const const_reverse_iteratorcrend () const
 
const_reverse_iterator rbegin () const
 
const const_reverse_iteratorrend () const
 

Static Public Attributes

static int debug
 Debug switch. More...
 
- Static Public Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static int fileModificationSkew
 
static fileCheckTypes fileModificationChecking
 
- Static Public Attributes inherited from dictionary
static const dictionary null
 Null dictionary. More...
 

Additional Inherited Members

- Public Types inherited from regIOobject
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Types of communications. More...
 
- Public Types inherited from IOobject
enum  objectState { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
- Public Types inherited from UILList< DLListBase, entry >
typedef entry value_type
 Type of values the DLList contains. More...
 
typedef entryreference
 Type that can be used for storing into DLList::value_type. More...
 
typedef const entryconst_reference
 Type that can be used for storing into constant. More...
 
typedef label size_type
 The type that can represent the size of a DLList. More...
 
typedef DLListBase::iterator LListBase_iterator
 
typedef DLListBase::const_iterator LListBase_const_iterator
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from dictionary
static autoPtr< dictionaryNew (Istream &)
 Construct top-level dictionary on freestore from Istream. More...
 
- Protected Member Functions inherited from IOobject
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
IstreamobjectStream (const fileName &)
 Construct and return an IFstream for the object given the. More...
 
void setBad (const string &)
 Set the object state to bad. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Selector class for finite volume differencing schemes. fvMesh is derived from fvShemes so that all fields have access to the fvSchemes from the mesh reference they hold.

Source files

Definition at line 50 of file fvSchemes.H.

Constructor & Destructor Documentation

fvSchemes ( const objectRegistry obr)

Member Function Documentation

const Foam::dictionary & schemesDict ( ) const

Definition at line 347 of file fvSchemes.C.

References dictionary::found(), dictionary::lookup(), and dictionary::subDict().

Referenced by fvSchemes::fvSchemes(), and fvSchemes::read().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::ITstream & ddtScheme ( const word name) const

Definition at line 360 of file fvSchemes.C.

References fvSchemes::debug, UList< T >::empty(), Foam::endl(), dictionary::found(), Foam::Info, and dictionary::lookup().

Referenced by Foam::fvc::ddt(), localEulerDdt::enabled(), and advectiveFvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::ITstream & d2dt2Scheme ( const word name) const

Definition at line 379 of file fvSchemes.C.

References fvSchemes::debug, UList< T >::empty(), Foam::endl(), dictionary::found(), Foam::Info, and dictionary::lookup().

Here is the call graph for this function:

Foam::ITstream & interpolationScheme ( const word name) const

Definition at line 398 of file fvSchemes.C.

References fvSchemes::debug, UList< T >::empty(), Foam::endl(), dictionary::found(), Foam::Info, and dictionary::lookup().

Here is the call graph for this function:

Foam::ITstream & divScheme ( const word name) const

Definition at line 421 of file fvSchemes.C.

References fvSchemes::debug, UList< T >::empty(), Foam::endl(), dictionary::found(), Foam::Info, and dictionary::lookup().

Here is the call graph for this function:

Foam::ITstream & gradScheme ( const word name) const

Definition at line 440 of file fvSchemes.C.

References fvSchemes::debug, UList< T >::empty(), Foam::endl(), dictionary::found(), Foam::Info, and dictionary::lookup().

Referenced by correctedSnGrad< Type >::fullGradCorrection().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::ITstream & snGradScheme ( const word name) const

Definition at line 459 of file fvSchemes.C.

References fvSchemes::debug, UList< T >::empty(), Foam::endl(), dictionary::found(), Foam::Info, and dictionary::lookup().

Here is the call graph for this function:

Foam::ITstream & laplacianScheme ( const word name) const

Definition at line 478 of file fvSchemes.C.

References fvSchemes::debug, UList< T >::empty(), Foam::endl(), dictionary::found(), Foam::Info, and dictionary::lookup().

Here is the call graph for this function:

void setFluxRequired ( const word name) const

Definition at line 497 of file fvSchemes.C.

References dictionary::add(), fvSchemes::debug, Foam::endl(), and Foam::Info.

Referenced by Implicit< CloudType >::cacheFields(), Foam::CorrectPhi(), and kinematicSingleLayer::solveThickness().

Here is the call graph for this function:

Here is the caller graph for this function:

bool fluxRequired ( const word name) const

Definition at line 508 of file fvSchemes.C.

References fvSchemes::debug, Foam::endl(), dictionary::found(), and Foam::Info.

Referenced by gaussLaplacianScheme< Type, GType >::fvmLaplacian().

Here is the call graph for this function:

Here is the caller graph for this function:

bool steady ( ) const
inline

Return true if the default ddtScheme is steadyState.

Definition at line 137 of file fvSchemes.H.

bool transient ( ) const
inline

Return true if the default ddtScheme is not steadyState.

Definition at line 143 of file fvSchemes.H.

References fvSchemes::read().

Here is the call graph for this function:

bool read ( )
virtual

Read the fvSchemes.

Reimplemented from regIOobject.

Definition at line 329 of file fvSchemes.C.

References regIOobject::read(), and fvSchemes::schemesDict().

Referenced by fvSchemes::fvSchemes(), and fvSchemes::transient().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

int debug
static

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