fvDOM Class Reference

Finite Volume Discrete Ordinates Method. Solves the RTE equation for n directions in a participating media, not including scatter. More...

Inheritance diagram for fvDOM:
[legend]
Collaboration diagram for fvDOM:
[legend]

Public Member Functions

 TypeName ("fvDOM")
 Runtime type information. More...
 
 fvDOM (const volScalarField &T)
 Construct from components. More...
 
 fvDOM (const dictionary &dict, const volScalarField &T)
 Construct from components. More...
 
virtual ~fvDOM ()
 Destructor. More...
 
void calculate ()
 Solve radiation equation(s) More...
 
bool read ()
 Read radiation properties dictionary. More...
 
void updateG ()
 Update G and calculate total heat flux on boundary. More...
 
void setRayIdLambdaId (const word &name, label &rayId, label &lambdaId) const
 Set the rayId and lambdaId from by decomposing an intensity. More...
 
virtual tmp< volScalarFieldRp () const
 Source term component (for power of T^4) More...
 
virtual tmp< volScalarField::InternalRu () const
 Source term component (constant) More...
 
const radiativeIntensityRayIRay (const label rayI) const
 Ray intensity for rayI. More...
 
const volScalarFieldIRayLambda (const label rayI, const label lambdaI) const
 Ray intensity for rayI and lambda bandwidth. More...
 
label nTheta () const
 Number of angles in theta. More...
 
label nPhi () const
 Number of angles in phi. More...
 
label nRay () const
 Number of rays. More...
 
label nLambda () const
 Number of wavelengths. More...
 
label nBands () const
 Number of bands. More...
 
const volScalarFielda () const
 Const access to total absorption coefficient. More...
 
const volScalarFieldaLambda (const label lambdaI) const
 Const access to wavelength total absorption coefficient. More...
 
const volScalarFieldG () const
 Const access to incident radiation field. More...
 
const volScalarFieldqr () const
 Const access to total radiative heat flux field. More...
 
const volScalarFieldqin () const
 Const access to incident radiative heat flux field. More...
 
const volScalarFieldqem () const
 Const access to emitted radiative heat flux field. More...
 
const blackBodyEmissionblackBody () const
 Const access to black body. More...
 
scalar omegaMax () const
 Return omegaMax. More...
 
vector meshOrientation () const
 Return meshOrientation. More...
 
bool useSolarLoad () const
 Use solar load. More...
 
- Public Member Functions inherited from radiationModel
 TypeName ("radiationModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, radiationModel, T,(const volScalarField &T),(T))
 
 declareRunTimeSelectionTable (autoPtr, radiationModel, dictionary,(const dictionary &dict, const volScalarField &T),(dict, T))
 
 radiationModel (const volScalarField &T)
 Null constructor. More...
 
 radiationModel (const word &type, const volScalarField &T)
 Construct from components. More...
 
 radiationModel (const word &type, const dictionary &dict, const volScalarField &T)
 Construct from components. More...
 
virtual ~radiationModel ()
 Destructor. More...
 
virtual void correct ()
 Main update/correction routine. More...
 
const Switch radiation () const
 Radiation model on/off flag. More...
 
virtual tmp< fvScalarMatrixSh (const basicThermo &thermo, const volScalarField &he) const
 Energy source term. More...
 
virtual tmp< fvScalarMatrixST (const dimensionedScalar &rhoCp, volScalarField &T) const
 Temperature source term. More...
 
virtual tmp< fvScalarMatrixST (tmp< volScalarField > rhoCp, volScalarField &T) const
 Temperature source term. More...
 
virtual tmp< fvScalarMatrixST (volScalarField &T) const
 Temperature source term. More...
 
const absorptionEmissionModelabsorptionEmission () const
 Access to absorptionEmission model. More...
 
const sootModelsoot () const
 Access to soot Model. More...
 
- Public Member Functions inherited from IOdictionary
 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...
 
virtual bool global () const
 Is object global. More...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. More...
 
- Public Member Functions inherited from baseIOdictionary
 TypeName ("dictionary")
 
 baseIOdictionary (const IOobject &)
 Construct given an IOobject. More...
 
 baseIOdictionary (const IOobject &, const dictionary &)
 Construct given an IOobject and dictionary. More...
 
 baseIOdictionary (const IOobject &, Istream &)
 Construct given an IOobject and Istream. More...
 
virtual ~baseIOdictionary ()
 Destructor. More...
 
const wordname () const
 Name function is needed to disambiguate those inherited. More...
 
virtual bool readData (Istream &)
 ReadData function required for regIOobject read operation. More...
 
virtual bool writeData (Ostream &) const
 WriteData function required for regIOobject write operation. More...
 
void operator= (const baseIOdictionary &)
 Assignment of other baseIOdictionary's entries to this. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 
 regIOobject (const regIOobject &)
 Copy construct. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 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 all file watches and remove object from registry. More...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) 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 (const bool unregister=false)
 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...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool valid=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual label addWatch (const fileName &)
 Add file watch for fileName on object if not yet watched. Return. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. 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 bool valid) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool valid=true) 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, bool globalObject=false)
 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, bool globalObject=false)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct as copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct as copy resetting name. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()=default
 Destructor. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const Timetime () const
 Return time. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return non-constant access to the class name read from header. More...
 
const stringnote () const
 Return the optional note. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
boolregisterObject ()
 Register object created from this IOobject with registry if true. More...
 
bool globalObject () const
 Is object same for all processors. More...
 
boolglobalObject ()
 Is object same for all processors. More...
 
unsigned labelByteSize () const
 The label byte-size, possibly read from the header. More...
 
unsigned scalarByteSize () const
 The scalar byte-size, possibly read from the header. More...
 
bool isHeaderClassName (const word &clsName) const
 Test if headerClassName() equals the given class name. More...
 
template<class Type >
bool isHeaderClassName () const
 Test if headerClassName() equals Type::typeName. More...
 
readOption readOpt () const
 The read option. More...
 
readOptionreadOpt ()
 Non-constant access to the read option. More...
 
writeOption writeOpt () const
 The write option. More...
 
writeOptionwriteOpt ()
 Non-constant access to the write option. More...
 
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
 The complete path. More...
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 The complete path with alternative instance and local. More...
 
fileName objectPath () const
 The complete path + object name. More...
 
fileName localFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches up if in parallel. More...
 
bool readHeader (Istream &is)
 Read header. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 Read header (uses typeFilePath to find file) and check its info. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &os) const
 Write header. More...
 
bool writeHeader (Ostream &os, 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 &io)
 
template<>
bool isHeaderClassName () const
 Specialization for void always returns true (no headerClassName check). More...
 
template<class StringType >
Foam::word groupName (StringType 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 &is, bool keepHeader=false)
 
 dictionary (Istream &is)
 
 dictionary (Istream &is, bool keepHeader)
 
 dictionary (const dictionary &parentDict, const dictionary &dict)
 Copy construct given the parent dictionary. More...
 
 dictionary (const dictionary &dict)
 Copy construct top-level dictionary. More...
 
 dictionary (const dictionary *dict)
 Construct top-level dictionary as copy from pointer to dictionary. More...
 
 dictionary (const dictionary &parentDict, dictionary &&dict)
 Move construct for given parent dictionary. More...
 
 dictionary (dictionary &&dict)
 Move construct top-level dictionary. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const fileNamename () const
 The dictionary name. More...
 
fileNamename ()
 The dictionary name for modification (use with caution). More...
 
word dictName () const
 The local dictionary name (final part of scoped name) 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 &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Search for an entry (const access) with the given keyword. More...
 
entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find for an entry (non-const access) with the given keyword. More...
 
const entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find an entry (const access) with the given keyword. More...
 
const entryfindScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Search for a scoped entry (const access) with the given keyword. More...
 
dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a sub-dictionary pointer if present. More...
 
const dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a sub-dictionary pointer if present. More...
 
const entrylookupEntry (const word &keyword, enum keyType::option matchOpt) const
 Search for an entry (const access) with the given keyword. More...
 
ITstreamlookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T >
bool readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
 
template<class T >
bool readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T , class Predicate >
bool readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
 
template<class T , class Predicate >
bool readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
bool isDict (const word &keyword) const
 Check if entry is found and and is a sub-dictionary. More...
 
const dictionarysubDict (const word &keyword) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (const word &keyword)
 Find and return a sub-dictionary for manipulation. More...
 
dictionary subOrEmptyDict (const word &keyword, const bool mandatory=false) const
 
const dictionaryoptionalSubDict (const word &keyword) const
 Find and return a sub-dictionary, otherwise return this dictionary. More...
 
wordList toc () const
 Return the table of contents. More...
 
wordList sortedToc () const
 Return the sorted table of contents. More...
 
template<class Compare >
wordList sortedToc (const Compare &comp) const
 Return table of contents sorted using the specified comparator. More...
 
List< keyTypekeys (bool patterns=false) const
 Return the list of available keys or patterns. More...
 
bool substituteKeyword (const word &keyword, bool mergeEntry=false)
 Substitute the given keyword (which is prefixed by '$') More...
 
bool substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
 Substitute the given scoped keyword (which is prefixed by '$') More...
 
entryadd (entry *entryPtr, bool mergeEntry=false)
 Add a new entry. More...
 
entryadd (const entry &e, bool mergeEntry=false)
 Add an entry. More...
 
entryadd (const keyType &k, const word &v, bool overwrite=false)
 Add a word entry. More...
 
entryadd (const keyType &k, const string &v, bool overwrite=false)
 Add a string entry. More...
 
entryadd (const keyType &k, const label v, bool overwrite=false)
 Add a label entry. More...
 
entryadd (const keyType &k, const scalar v, bool overwrite=false)
 Add a scalar entry. More...
 
entryadd (const keyType &k, const dictionary &d, bool mergeEntry=false)
 Add a dictionary entry. More...
 
template<class T >
entryadd (const keyType &k, const T &v, bool overwrite=false)
 Add a T entry. More...
 
entryset (entry *entryPtr)
 Assign a new entry, overwriting any existing entry. More...
 
entryset (const entry &e)
 Assign a new entry, overwriting any existing entry. More...
 
entryset (const keyType &k, const dictionary &v)
 Assign a dictionary entry, overwriting any existing entry. More...
 
template<class T >
entryset (const keyType &k, const T &v)
 Assign a T entry, overwriting any existing entry. More...
 
bool remove (const word &keyword)
 Remove an entry specified by keyword. More...
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
 Change the keyword for an entry,. More...
 
bool merge (const dictionary &dict)
 Merge entries from the given dictionary. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (dictionary &dict)
 Transfer the contents of the argument and annul the argument. More...
 
void checkITstream (const ITstream &is, const word &keyword) const
 
bool read (Istream &is)
 Read dictionary from Istream. More...
 
bool read (Istream &is, bool keepHeader)
 Read dictionary from Istream, optionally keeping the header. More...
 
void writeEntry (const keyType &keyword, Ostream &os) const
 Write sub-dictionary with the keyword as its header. More...
 
void writeEntries (Ostream &os, const bool extraNewLine=false) const
 Write dictionary entries. More...
 
void write (Ostream &os, const bool subDict=true) const
 Write dictionary, normally with sub-dictionary formatting. More...
 
const_searcher csearch (const word &keyword, enum keyType::option=keyType::REGEX) const
 Search dictionary for given keyword. More...
 
const_searcher search (const word &keyword, enum keyType::option=keyType::REGEX) const
 Search dictionary for given keyword. More...
 
searcher search (const word &keyword, enum keyType::option=keyType::REGEX)
 Search dictionary for given keyword. More...
 
const_searcher csearchScoped (const word &keyword, enum keyType::option) const
 Search using scoping. More...
 
const_searcher searchScoped (const word &keyword, enum keyType::option) const
 Search using dot or slash scoping. More...
 
searcher searchScoped (const word &keyword, enum keyType::option)
 Search using dot or slash scoping. More...
 
const dictionarycfindScopedDict (const fileName &dictPath) const
 Locate a sub-dictionary using slash-scoping. More...
 
const dictionaryfindScopedDict (const fileName &dictPath) const
 Locate a sub-dictionary using slash-scoping. More...
 
dictionaryfindScopedDict (const fileName &dictPath)
 Locate a sub-dictionary using slash-scoping. More...
 
dictionarymakeScopedDict (const fileName &dictPath)
 Locate existing or create sub-dictionary using slash-scoping. More...
 
const_searcher csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 Search dictionary for given keyword and any compatibility names. More...
 
bool foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 Search dictionary for given keyword and any compatibility names. More...
 
const entryfindCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const
 
const entrylookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const
 
ITstreamlookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
template<class T >
T getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
template<class T >
T getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option=keyType::REGEX) const
 
template<class T >
bool readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX, bool mandatory=true) const
 
template<class T >
bool readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX) const
 
void operator= (const dictionary &rhs)
 Copy assignment. More...
 
void operator+= (const dictionary &rhs)
 Include entries from the given dictionary. More...
 
void operator|= (const dictionary &rhs)
 Conditionally include entries from the given dictionary. More...
 
void operator<<= (const dictionary &rhs)
 Unconditionally include entries from the given dictionary. More...
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T >
T lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
ITstreamFOAM_DEPRECATED_FOR (2018-07, "lookup() method") operator[](const word &keyword) const
 Deprecated(2018-07) find and return an entry data stream. More...
 
template<class T >
T FOAM_DEPRECATED_FOR (2018-10, "get() method") lookupType(const word &keyword
 Deprecated(2018-10) find and return a T. More...
 
label getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< label >(const word&, keyType::option) More...
 
scalar getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< scalar >(const word&, keyType::option) More...
 
string getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< string >(const word&, keyType::option) More...
 
word getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< word >(const word&, keyType::option) More...
 
fileName getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< fileName >(const word&, keyType::option) More...
 
template<class Compare >
Foam::wordList sortedToc (const Compare &comp) const
 
template<class T >
Foam::entryadd (const keyType &k, const T &v, bool overwrite)
 
template<class T >
Foam::entryset (const keyType &k, const T &v)
 
- Public Member Functions inherited from ILList< LListBase, T >
 ILList ()=default
 Null construct. More...
 
 ILList (T *item)
 Construct and insert the initial T item pointer. More...
 
 ILList (Istream &is)
 Construct from Istream. More...
 
 ILList (const ILList< LListBase, T > &lst)
 Copy construct using the 'clone()' method for each element. More...
 
 ILList (ILList< LListBase, T > &&lst)
 Move construct. More...
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone 'clone()'. More...
 
template<class INew >
 ILList (Istream &is, const INew &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 *item)
 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 > &lst)
 
void operator= (const ILList< LListBase, T > &lst)
 Copy assignment using the 'clone()' method for each element. More...
 
void operator= (ILList< LListBase, T > &&lst)
 Move assignment. More...
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState : char { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Public Types inherited from dictionary
typedef Searcher< true > const_searcher
 Searcher with const access. More...
 
typedef Searcher< false > searcher
 Searcher with non-const access. More...
 
- Static Public Member Functions inherited from radiationModel
static autoPtr< radiationModelNew (const volScalarField &T)
 Return a reference to the selected radiation model. More...
 
static autoPtr< radiationModelNew (const dictionary &dict, const volScalarField &T)
 Return a reference to the selected radiation model. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &aptr)
 
template<class Type >
static Type & store (autoPtr< Type > &&aptr)
 
- 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 StringType >
static word groupName (StringType name, const word &group)
 Create dot-delimited name.group. More...
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 Return the IOobject, but also consider an alternative file name. More...
 
static OstreamwriteBanner (Ostream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
static OstreamwriteDivider (Ostream &os)
 Write the standard file section divider. More...
 
static OstreamwriteEndDivider (Ostream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from dictionary
static autoPtr< dictionaryNew (Istream &is)
 Construct top-level dictionary on freestore from Istream. More...
 
- Public Attributes inherited from dictionary
friend const_searcher
 Declare friendship with the searcher classes. More...
 
friend searcher
 
T bool recursive = false
 
T bool bool patternMatch
 
- Static Public Attributes inherited from radiationModel
static const word externalRadHeatFieldName_
 Static name external radiative fluxes. More...
 
static const word primaryFluxName_
 Static name for primary solar fluxes. More...
 
static const word relfectedFluxName_
 Static name for reflected solar fluxes. More...
 
- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 Names for the fileCheckTypes. More...
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
- Static Public Attributes inherited from dictionary
static const dictionary null
 An empty dictionary, which is also the parent for all dictionaries. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 Set the object state to bad. More...
 
- Protected Attributes inherited from radiationModel
const fvMeshmesh_
 Reference to the mesh database. More...
 
const Timetime_
 Reference to the time database. More...
 
const volScalarFieldT_
 Reference to the temperature field. More...
 
Switch radiation_
 Radiation model on/off flag. More...
 
dictionary coeffs_
 Radiation model dictionary. More...
 
label solverFreq_
 Radiation solver frequency - number flow solver iterations per. More...
 
bool firstIter_
 Flag to enable radiation model to be evaluated on first iteration. More...
 
autoPtr< absorptionEmissionModelabsorptionEmission_
 Absorption/emission model. More...
 
autoPtr< scatterModelscatter_
 Scatter model. More...
 
autoPtr< sootModelsoot_
 Soot model. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Finite Volume Discrete Ordinates Method. Solves the RTE equation for n directions in a participating media, not including scatter.

Available absorption models:

Usage
    fvDOMCoeffs
    {
        nPhi        4;          // azimuthal angles in PI/2 on X-Y.
                                //(from Y to X)
        nTheta      0;          // polar angles in PI (from Z to X-Y plane)
        tolerance   1e-3;       // convergence tolerance for radiation
                                // iteration
        maxIter     4;          // maximum number of iterations
        meshOrientation    (1 1 1); //Mesh orientation used for 2D and 1D
    }

    solverFreq   1; // Number of flow iterations per radiation iteration

The total number of solid angles is 4*nPhi*nTheta in 3-D.

Operating modes:

  • 1-D:
    • ray directions are on X, Y or Z
    • nPhi and nTheta entries are ignored
    • meshOrientation vector can be used for any other 1-D direction.
  • 2-D:
    • ray directions are on X-Y, X-Z or Y-Z planes
    • only the nPhi entry is considered
    • meshOrientation vector can be used for non-aligned planes specifying the plane normal vector.
  • 3-D:
    • rays geberated in 3-D using the nPhi and nTheta entries
    • meshOrientation vector is not applicable.
Source files

Definition at line 97 of file fvDOM.H.

Constructor & Destructor Documentation

◆ fvDOM() [1/2]

fvDOM ( const volScalarField T)

Construct from components.

Definition at line 213 of file fvDOM.C.

◆ fvDOM() [2/2]

fvDOM ( const dictionary dict,
const volScalarField T 
)

Construct from components.

Definition at line 306 of file fvDOM.C.

◆ ~fvDOM()

~fvDOM ( )
virtual

Destructor.

Definition at line 403 of file fvDOM.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fvDOM"  )

Runtime type information.

◆ calculate()

void calculate ( )
virtual

Solve radiation equation(s)

Implements radiationModel.

Definition at line 427 of file fvDOM.C.

References Foam::endl(), forAll, Foam::Info, and Foam::max().

Here is the call graph for this function:

◆ read()

bool read ( )
virtual

Read radiation properties dictionary.

Implements radiationModel.

Definition at line 409 of file fvDOM.C.

References radiationModel::read().

Here is the call graph for this function:

◆ updateG()

void updateG ( )

Update G and calculate total heat flux on boundary.

Definition at line 566 of file fvDOM.C.

References Foam::dimMass, Foam::dimTime, forAll, Foam::pow3(), and Foam::Zero.

Here is the call graph for this function:

◆ setRayIdLambdaId()

void setRayIdLambdaId ( const word name,
label rayId,
label lambdaId 
) const

Set the rayId and lambdaId from by decomposing an intensity.

field name

Definition at line 585 of file fvDOM.C.

References Foam::name(), and Foam::readLabel().

Referenced by greyDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs().

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

◆ Rp()

Foam::tmp< Foam::volScalarField > Rp ( ) const
virtual

Source term component (for power of T^4)

Implements radiationModel.

Definition at line 469 of file fvDOM.C.

References IOobject::NO_READ, IOobject::NO_WRITE, tmp< T >::ref(), and sigma().

Here is the call graph for this function:

◆ Ru()

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::volMesh > > Ru ( ) const
virtual

Source term component (constant)

Implements radiationModel.

Definition at line 513 of file fvDOM.C.

References IOobject::NO_READ, IOobject::NO_WRITE, tmp< T >::ref(), and Foam::Zero.

Here is the call graph for this function:

◆ IRay()

const Foam::radiation::radiativeIntensityRay & IRay ( const label  rayI) const
inline

Ray intensity for rayI.

Definition at line 29 of file fvDOMI.H.

◆ IRayLambda()

const Foam::volScalarField & IRayLambda ( const label  rayI,
const label  lambdaI 
) const
inline

Ray intensity for rayI and lambda bandwidth.

Definition at line 37 of file fvDOMI.H.

◆ nTheta()

Foam::label nTheta ( ) const
inline

Number of angles in theta.

Definition at line 46 of file fvDOMI.H.

◆ nPhi()

Foam::label nPhi ( ) const
inline

Number of angles in phi.

Definition at line 52 of file fvDOMI.H.

◆ nRay()

Foam::label nRay ( ) const
inline

Number of rays.

Definition at line 58 of file fvDOMI.H.

◆ nLambda()

Foam::label nLambda ( ) const
inline

Number of wavelengths.

Definition at line 64 of file fvDOMI.H.

◆ nBands()

Foam::label nBands ( ) const
inlinevirtual

Number of bands.

Implements radiationModel.

Definition at line 70 of file fvDOMI.H.

◆ a()

const Foam::volScalarField & a ( ) const
inline

Const access to total absorption coefficient.

Definition at line 75 of file fvDOMI.H.

◆ aLambda()

const Foam::volScalarField & aLambda ( const label  lambdaI) const
inline

Const access to wavelength total absorption coefficient.

Definition at line 82 of file fvDOMI.H.

◆ G()

const Foam::volScalarField & G ( ) const
inline

Const access to incident radiation field.

Definition at line 90 of file fvDOMI.H.

◆ qr()

const Foam::volScalarField & qr ( ) const
inline

Const access to total radiative heat flux field.

Definition at line 96 of file fvDOMI.H.

◆ qin()

const Foam::volScalarField & qin ( ) const
inline

Const access to incident radiative heat flux field.

Definition at line 101 of file fvDOMI.H.

◆ qem()

const Foam::volScalarField & qem ( ) const
inline

Const access to emitted radiative heat flux field.

Definition at line 107 of file fvDOMI.H.

◆ blackBody()

const Foam::radiation::blackBodyEmission & blackBody ( ) const
inline

Const access to black body.

Definition at line 114 of file fvDOMI.H.

◆ omegaMax()

Foam::scalar omegaMax ( ) const
inline

Return omegaMax.

Definition at line 120 of file fvDOMI.H.

◆ meshOrientation()

Foam::vector meshOrientation ( ) const
inline

Return meshOrientation.

Definition at line 126 of file fvDOMI.H.

◆ useSolarLoad()

bool useSolarLoad ( ) const
inline

Use solar load.

Definition at line 132 of file fvDOMI.H.


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