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...
Public Member Functions | |
fvSchemes (const objectRegistry &obr) | |
Construct for objectRegistry. More... | |
const dictionary & | schemesDict () const |
ITstream & | ddtScheme (const word &name) const |
ITstream & | d2dt2Scheme (const word &name) const |
ITstream & | interpolationScheme (const word &name) const |
ITstream & | divScheme (const word &name) const |
ITstream & | gradScheme (const word &name) const |
ITstream & | snGradScheme (const word &name) const |
ITstream & | laplacianScheme (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... | |
![]() | |
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 word & | name () 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... | |
![]() | |
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... | |
label & | eventNo () |
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... | |
Istream & | readStream (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... | |
label & | watchIndex () |
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 &) |
![]() | |
TypeName ("IOobject") | |
Runtime type information. More... | |
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. More... | |
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. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const word &name) | |
Construct as copy resetting name. More... | |
Foam::autoPtr< IOobject > | clone () const |
Clone. More... | |
virtual | ~IOobject () |
Destructor. More... | |
const Time & | time () const |
Return time. More... | |
const objectRegistry & | db () const |
Return the local objectRegistry. More... | |
const word & | name () const |
Return name. More... | |
const word & | headerClassName () const |
Return name of the class name read from header. More... | |
string & | note () |
Return non-constant access to the optional note. More... | |
const string & | note () 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 |
readOption & | readOpt () |
writeOption | writeOpt () const |
writeOption & | writeOpt () |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const |
const fileName & | caseName () const |
const fileName & | instance () const |
fileName & | instance () |
const fileName & | local () 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< IOobject > | info () const |
Return info proxy. More... | |
void | operator= (const IOobject &) |
template<class Name > | |
Foam::word | groupName (Name name, const word &group) |
![]() | |
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< dictionary > | clone () const |
Construct and return clone. More... | |
virtual | ~dictionary () |
Destructor. More... | |
const dictionary & | parent () const |
Return the parent dictionary. More... | |
const dictionary & | topDict () 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 entry * | lookupEntryPtr (const word &, bool recursive, bool patternMatch) const |
Find and return an entry data stream pointer if present. More... | |
entry * | lookupEntryPtr (const word &, bool recursive, bool patternMatch) |
Find and return an entry data stream pointer for manipulation. More... | |
const entry & | lookupEntry (const word &, bool recursive, bool patternMatch) const |
Find and return an entry data stream if present otherwise error. More... | |
ITstream & | lookup (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 entry * | lookupScopedEntryPtr (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 dictionary * | subDictPtr (const word &) const |
Find and return a sub-dictionary pointer if present. More... | |
const dictionary & | subDict (const word &) const |
Find and return a sub-dictionary. More... | |
dictionary & | subDict (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... | |
List< keyType > | keys (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< dictionary > | xfer () |
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... | |
ITstream & | operator[] (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... | |
![]() | |
dictionaryName () | |
Construct dictionaryName null. More... | |
dictionaryName (const fileName &name) | |
Construct dictionaryName as copy of the given fileName. More... | |
const fileName & | name () const |
Return the dictionary name. More... | |
fileName & | name () |
Return the dictionary name. More... | |
const word | dictName () const |
Return the local dictionary name (final part of scoped name) More... | |
![]() | |
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... | |
![]() | |
ILList () | |
Null construct. More... | |
ILList (T *a) | |
Construct given initial T. More... | |
ILList (Istream &) | |
Construct from Istream. More... | |
ILList (const ILList< LListBase, T > &) | |
Construct as copy. More... | |
ILList (const ILList< LListBase, T > &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 (T *p) |
Remove the specified element from the list and delete it. More... | |
void | clear () |
Clear the contents of the list. More... | |
void | transfer (ILList< LListBase, T > &) |
Transfer the contents of the argument into this List. More... | |
void | operator= (const ILList< LListBase, T > &) |
Static Public Attributes | |
static int | debug |
Debug switch. More... | |
![]() | |
static const NamedEnum< fileCheckTypes, 4 > | fileCheckTypesNames |
static int | fileModificationSkew |
static fileCheckTypes | fileModificationChecking |
![]() | |
static const dictionary | null |
Null dictionary. More... | |
Private Member Functions | |
void | clear () |
Clear the dictionaries and streams before reading. More... | |
void | read (const dictionary &) |
Read settings from the dictionary. More... | |
fvSchemes (const fvSchemes &) | |
Disallow default bitwise copy construct. More... | |
void | operator= (const fvSchemes &) |
Disallow default bitwise assignment. More... | |
Additional Inherited Members | |
![]() | |
enum | fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster } |
Types of communications. More... | |
![]() | |
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... | |
![]() | |
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 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 void | replaceFileName (const word &from, const word &to) |
![]() | |
static autoPtr< dictionary > | New (Istream &) |
Construct top-level dictionary on freestore from Istream. More... | |
![]() | |
Istream * | objectStream () |
Construct and return an IFstream for the object. More... | |
Istream * | objectStream (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 bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
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.
Definition at line 50 of file fvSchemes.H.
fvSchemes | ( | const objectRegistry & | obr | ) |
Construct for objectRegistry.
Definition at line 195 of file fvSchemes.C.
References IOobject::headerOk(), IOobject::MUST_READ, IOobject::MUST_READ_IF_MODIFIED, fvSchemes::read(), IOobject::READ_IF_PRESENT, IOobject::readOpt(), and fvSchemes::schemesDict().
|
private |
Clear the dictionaries and streams before reading.
Definition at line 37 of file fvSchemes.C.
References List::clear(), dictionary::clear(), fvSchemes::d2dt2Schemes_, fvSchemes::ddtSchemes_, fvSchemes::defaultD2dt2Scheme_, fvSchemes::defaultDdtScheme_, fvSchemes::defaultDivScheme_, fvSchemes::defaultGradScheme_, fvSchemes::defaultInterpolationScheme_, fvSchemes::defaultLaplacianScheme_, fvSchemes::defaultSnGradScheme_, fvSchemes::divSchemes_, fvSchemes::gradSchemes_, fvSchemes::interpolationSchemes_, fvSchemes::laplacianSchemes_, and fvSchemes::snGradSchemes_.
|
private |
Read settings from the dictionary.
Definition at line 57 of file fvSchemes.C.
References dictionary::add(), dict, dictionary::found(), dictionary::lookup(), dictionary::set(), and dictionary::subDict().
|
private |
Disallow default bitwise assignment.
const Foam::dictionary & schemesDict | ( | ) | const |
Definition at line 347 of file fvSchemes.C.
References found, and lookup().
Referenced by fvSchemes::fvSchemes().
Foam::ITstream & ddtScheme | ( | const word & | name | ) | const |
Definition at line 360 of file fvSchemes.C.
References Foam::endl(), Foam::Info, and Foam::name().
Referenced by gaussConvectionScheme< Type >::gaussConvectionScheme(), and advectiveFvPatchField< Type >::updateCoeffs().
Foam::ITstream & d2dt2Scheme | ( | const word & | name | ) | const |
Definition at line 379 of file fvSchemes.C.
References Foam::endl(), Foam::Info, and Foam::name().
Foam::ITstream & interpolationScheme | ( | const word & | name | ) | const |
Definition at line 398 of file fvSchemes.C.
References Foam::endl(), Foam::Info, and Foam::name().
Foam::ITstream & divScheme | ( | const word & | name | ) | const |
Definition at line 421 of file fvSchemes.C.
References Foam::endl(), Foam::Info, and Foam::name().
Foam::ITstream & gradScheme | ( | const word & | name | ) | const |
Definition at line 440 of file fvSchemes.C.
References Foam::endl(), Foam::Info, and Foam::name().
Foam::ITstream & snGradScheme | ( | const word & | name | ) | const |
Definition at line 459 of file fvSchemes.C.
References Foam::endl(), Foam::Info, and Foam::name().
Foam::ITstream & laplacianScheme | ( | const word & | name | ) | const |
Definition at line 478 of file fvSchemes.C.
References Foam::endl(), Foam::Info, and Foam::name().
void setFluxRequired | ( | const word & | name | ) | const |
Definition at line 497 of file fvSchemes.C.
References Foam::endl(), Foam::Info, and Foam::name().
bool fluxRequired | ( | const word & | name | ) | const |
Definition at line 508 of file fvSchemes.C.
References Foam::endl(), Foam::Info, and Foam::name().
|
inline |
Return true if the default ddtScheme is steadyState.
Definition at line 137 of file fvSchemes.H.
References fvSchemes::steady_.
|
inline |
Return true if the default ddtScheme is not steadyState.
Definition at line 143 of file fvSchemes.H.
References fvSchemes::steady_.
|
virtual |
Read the fvSchemes.
Reimplemented from regIOobject.
Definition at line 329 of file fvSchemes.C.
References clear(), Foam::read(), and regIOobject::read().
Referenced by fvSchemes::fvSchemes().
|
private |
Definition at line 56 of file fvSchemes.H.
Referenced by fvSchemes::clear().
|
private |
Definition at line 57 of file fvSchemes.H.
Referenced by fvSchemes::clear().
|
private |
Definition at line 59 of file fvSchemes.H.
Referenced by fvSchemes::clear().
|
private |
Definition at line 60 of file fvSchemes.H.
Referenced by fvSchemes::clear().
|
private |
Definition at line 62 of file fvSchemes.H.
Referenced by fvSchemes::clear().
|
private |
Definition at line 63 of file fvSchemes.H.
Referenced by fvSchemes::clear().
|
private |
Definition at line 65 of file fvSchemes.H.
Referenced by fvSchemes::clear().
|
private |
Definition at line 66 of file fvSchemes.H.
Referenced by fvSchemes::clear().
|
private |
Definition at line 68 of file fvSchemes.H.
Referenced by fvSchemes::clear().
|
private |
Definition at line 69 of file fvSchemes.H.
Referenced by fvSchemes::clear().
|
private |
Definition at line 71 of file fvSchemes.H.
Referenced by fvSchemes::clear().
|
private |
Definition at line 72 of file fvSchemes.H.
Referenced by fvSchemes::clear().
|
private |
Definition at line 74 of file fvSchemes.H.
Referenced by fvSchemes::clear().
|
private |
Definition at line 75 of file fvSchemes.H.
Referenced by fvSchemes::clear().
|
mutableprivate |
Definition at line 77 of file fvSchemes.H.
|
private |
Definition at line 78 of file fvSchemes.H.
|
private |
Steady-state run indicator.
Set true if the default ddtScheme is steadyState
Definition at line 82 of file fvSchemes.H.
Referenced by fvSchemes::steady(), and fvSchemes::transient().
|
static |
Debug switch.
Definition at line 103 of file fvSchemes.H.
Referenced by fvPatchMapper::calcAddressing(), fvMesh::delta(), fvMesh::fvMesh(), fvMesh::makeC(), fvMesh::makeCf(), fvMesh::makeMagSf(), fvMesh::makeSf(), fvMesh::V(), and fvMesh::V00().
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.