Public Member Functions | Protected Member Functions | List of all members
noFilm Class Reference
Inheritance diagram for noFilm:
Inheritance graph
[legend]
Collaboration diagram for noFilm:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("none")
 Runtime type information. More...
 
 noFilm (const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType)
 Construct from components. More...
 
virtual ~noFilm ()
 Destructor. More...
 
virtual void addSources (const label patchI, const label faceI, const scalar massSource, const vector &momentumSource, const scalar pressureSource, const scalar energySource)
 External hook to add sources to the film. More...
 
virtual const volScalarFielddelta () const
 Return the film thickness [m]. More...
 
virtual const volScalarFieldalpha () const
 Return the film coverage, 1 = covered, 0 = uncovered / []. More...
 
virtual const volVectorFieldU () const
 Return the film velocity [m/s]. More...
 
virtual const volScalarFieldrho () const
 Return the film density [kg/m3]. More...
 
virtual const volVectorFieldUs () const
 Return the film surface velocity [m/s]. More...
 
virtual const volVectorFieldUw () const
 Return the film wall velocity [m/s]. More...
 
virtual const volScalarFieldT () const
 Return the film mean temperature [K]. More...
 
virtual const volScalarFieldTs () const
 Return the film surface temperature [K]. More...
 
virtual const volScalarFieldTw () const
 Return the film wall temperature [K]. More...
 
virtual const volScalarFieldCp () const
 Return the film specific heat capacity [J/kg/K]. More...
 
virtual const volScalarFieldkappa () const
 Return the film thermal conductivity [W/m/K]. More...
 
const volScalarFieldsigma () const
 Return const access to the surface tension / [m/s2]. More...
 
virtual tmp< volScalarFieldprimaryMassTrans () const
 Return mass transfer source - Eulerian phase only. More...
 
virtual const volScalarFieldcloudMassTrans () const
 Return the film mass available for transfer. More...
 
virtual const volScalarFieldcloudDiameterTrans () const
 Return the parcel diameters originating from film. More...
 
virtual tmp< DimensionedField< scalar, volMesh > > Srho () const
 Return total mass source - Eulerian phase only. More...
 
virtual tmp< DimensionedField< scalar, volMesh > > Srho (const label i) const
 Return mass source for specie i - Eulerian phase only. More...
 
virtual tmp< DimensionedField< scalar, volMesh > > Sh () const
 Return enthalpy source - Eulerian phase only. More...
 
- Public Member Functions inherited from surfaceFilmModel
 TypeName ("surfaceFilmModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, surfaceFilmModel, mesh,( const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType ),(modelType, mesh, g, regionType))
 
 surfaceFilmModel (const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType)
 Construct from type name, mesh and gravity vector. More...
 
virtual ~surfaceFilmModel ()
 Destructor. More...
 
const dimensionedVectorg () const
 Return the accleration due to gravity. More...
 
virtual scalar CourantNumber () const
 Courant number evaluation. More...
 
- Public Member Functions inherited from singleLayerRegion
 TypeName ("regionModel")
 Runtime type information. More...
 
 singleLayerRegion (const fvMesh &mesh, const word &regionType)
 Construct null. More...
 
 singleLayerRegion (const fvMesh &mesh, const word &regionType, const word &modelName, bool readFields=true)
 Construct from mesh, region type and name. More...
 
virtual ~singleLayerRegion ()
 Destructor. More...
 
virtual const volVectorFieldnHat () const
 Return the patch normal vectors. More...
 
virtual const volScalarFieldmagSf () const
 Return the face area magnitudes / [m2]. More...
 
virtual const labelListpassivePatchIDs () const
 Return the list of patch IDs opposite to internally. More...
 
template<class Type >
wordList mappedFieldAndInternalPatchTypes () const
 Return boundary types for mapped field patches. More...
 
template<class Type >
wordList mappedPushedFieldPatchTypes () const
 Return boundary types for pushed mapped field patches. More...
 
template<class Type >
Foam::wordList mappedFieldAndInternalPatchTypes () const
 
template<class Type >
Foam::wordList mappedPushedFieldPatchTypes () const
 
- Public Member Functions inherited from regionModel
 TypeName ("regionModel")
 Runtime type information. More...
 
 regionModel (const fvMesh &mesh, const word &regionType)
 Construct null. More...
 
 regionModel (const fvMesh &mesh, const word &regionType, const word &modelName, bool readFields=true)
 Construct from mesh, region type and name. More...
 
 regionModel (const fvMesh &mesh, const word &regionType, const word &modelName, const dictionary &dict, bool readFields=true)
 Construct from mesh and name and dict. More...
 
virtual ~regionModel ()
 Destructor. More...
 
const fvMeshprimaryMesh () const
 Return the reference to the primary mesh database. More...
 
const Timetime () const
 Return the reference to the time database. More...
 
const Switchactive () const
 Return the active flag. More...
 
const SwitchinfoOutput () const
 Return the information flag. More...
 
const wordmodelName () const
 Return the model name. More...
 
const fvMeshregionMesh () const
 Return the region mesh database. More...
 
fvMeshregionMesh ()
 Return the region mesh database for manipulation. More...
 
const dictionarycoeffs () const
 Return the model coefficients dictionary. More...
 
const dictionarysolution () const
 Return the solution dictionary. More...
 
const IOdictionaryoutputProperties () const
 Return const access to the output properties dictionary. More...
 
IOdictionaryoutputProperties ()
 Return output properties dictionary. More...
 
bool isCoupledPatch (const label regionPatchI) const
 Return true if patchI on the local region is a coupled. More...
 
bool isRegionPatch (const label primaryPatchI) const
 Return true if patchI on the primary region is a coupled. More...
 
const labelListprimaryPatchIDs () const
 Return the list of patch IDs on the primary region coupled. More...
 
const labelListintCoupledPatchIDs () const
 Return the list of patch IDs internally coupled with the. More...
 
label regionPatchID (const label primaryPatchID) const
 Return region ID corresponding to primaryPatchID. More...
 
label nbrCoupledPatchID (const regionModel &nbrRegion, const label regionPatchI) const
 Return the coupled patch ID paired with coupled patch. More...
 
template<class Type >
tmp< Foam::Field< Type > > mapRegionPatchField (const regionModel &nbrRegion, const label regionPatchI, const label nbrPatchI, const Field< Type > &nbrField, const bool flip=false) const
 Map patch field from another region model to local patch. More...
 
template<class Type >
tmp< Field< Type > > mapRegionPatchField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchI, const bool flip=false) const
 Map patch field from another region model to local patch. More...
 
template<class Type >
tmp< Field< Type > > mapRegionPatchInternalField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchI, const bool flip=false) const
 Map patch internal field from another region model to local. More...
 
template<class Type >
void toPrimary (const label regionPatchI, List< Type > &regionField) const
 Convert a local region field to the primary region. More...
 
template<class Type >
void toRegion (const label regionPatchI, List< Type > &primaryFieldField) const
 Convert a primary region field to the local region. More...
 
template<class Type , class CombineOp >
void toPrimary (const label regionPatchI, List< Type > &regionField, const CombineOp &cop) const
 Convert a local region field to the primary region with op. More...
 
template<class Type , class CombineOp >
void toRegion (const label regionPatchI, List< Type > &primaryFieldField, const CombineOp &cop) const
 Convert a primary region field to the local region with op. More...
 
virtual void evolve ()
 Main driver routing to evolve the region - calls other evolves. More...
 
virtual void preEvolveRegion ()
 Pre-evolve region. More...
 
virtual void evolveRegion ()
 Evolve the region. More...
 
virtual void postEvolveRegion ()
 Post-evolve region. More...
 
virtual void info ()
 Provide some feedback. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > mapRegionPatchField (const regionModel &nbrRegion, const label regionPatchI, const label nbrPatchI, const Field< Type > &nbrField, const bool flip) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > mapRegionPatchField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchI, const bool flip) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > mapRegionPatchInternalField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchI, const bool flip) const
 
- 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...
 
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
 

Protected Member Functions

virtual bool read ()
 Read control parameters from dictionary. More...
 
- Protected Member Functions inherited from regionModel
virtual bool read (const dictionary &dict)
 Read control parameters from dictionary. More...
 
virtual const AMIPatchToPatchInterpolationinterRegionAMI (const regionModel &nbrRegion, const label regionPatchI, const label nbrPatchI, const bool flip) const
 Create or return a new inter-region AMI object. 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...
 

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 surfaceFilmModel
static autoPtr< surfaceFilmModelNew (const fvMesh &mesh, const dimensionedVector &g, const word &regionType="surfaceFilm")
 Return a reference to the selected surface film model. More...
 
- 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...
 
- 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...
 
- Protected Attributes inherited from surfaceFilmModel
const dimensionedVectorg_
 Acceleration due to gravity [m/s2]. More...
 
- Protected Attributes inherited from singleLayerRegion
autoPtr< volVectorFieldnHatPtr_
 Patch normal vectors. More...
 
autoPtr< volScalarFieldmagSfPtr_
 Face area magnitudes / [m2]. More...
 
labelList passivePatchIDs_
 List of patch IDs opposite to internally coupled patches. More...
 
- Protected Attributes inherited from regionModel
const fvMeshprimaryMesh_
 Reference to the primary mesh database. More...
 
const Timetime_
 Reference to the time database. More...
 
Switch active_
 Active flag. More...
 
Switch infoOutput_
 Active information output. More...
 
const word modelName_
 Model name. More...
 
autoPtr< fvMeshregionMeshPtr_
 Pointer to the region mesh database. More...
 
dictionary coeffs_
 Model coefficients dictionary. More...
 
autoPtr< IOdictionaryoutputPropertiesPtr_
 Dictionary of output properties. More...
 
labelList primaryPatchIDs_
 List of patch IDs on the primary region coupled to this region. More...
 
labelList intCoupledPatchIDs_
 List of patch IDs internally coupled with the primary region. More...
 
word regionName_
 Region name. More...
 
regionModelFunctionObjectList functions_
 Region model function objects. More...
 
wordList interRegionAMINames_
 List of region names this region is coupled to. More...
 
PtrList< PtrList< AMIPatchToPatchInterpolation > > interRegionAMI_
 List of AMI objects per coupled region. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Definition at line 52 of file noFilm.H.

Constructor & Destructor Documentation

noFilm ( const word modelType,
const fvMesh mesh,
const dimensionedVector g,
const word regionType 
)

Construct from components.

Definition at line 64 of file noFilm.C.

~noFilm ( )
virtual

Destructor.

Definition at line 77 of file noFilm.C.

References noFilm::addSources().

Here is the call graph for this function:

Member Function Documentation

bool read ( )
protectedvirtual

Read control parameters from dictionary.

Reimplemented from surfaceFilmModel.

Definition at line 47 of file noFilm.C.

References surfaceFilmModel::read().

Here is the call graph for this function:

TypeName ( "none"  )

Runtime type information.

void addSources ( const label  patchI,
const label  faceI,
const scalar  massSource,
const vector momentumSource,
const scalar  pressureSource,
const scalar  energySource 
)
virtual

External hook to add sources to the film.

Implements surfaceFilmModel.

Definition at line 84 of file noFilm.C.

Referenced by noFilm::~noFilm().

Here is the caller graph for this function:

const volScalarField & delta ( ) const
virtual

Return the film thickness [m].

Implements surfaceFilmModel.

Definition at line 97 of file noFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

const volScalarField & alpha ( ) const
virtual

Return the film coverage, 1 = covered, 0 = uncovered / [].

Implements surfaceFilmModel.

Definition at line 106 of file noFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

const volVectorField & U ( ) const
virtual

Return the film velocity [m/s].

Implements surfaceFilmModel.

Definition at line 115 of file noFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, GeometricField< vector, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

const volScalarField & rho ( ) const
virtual

Return the film density [kg/m3].

Implements surfaceFilmModel.

Definition at line 142 of file noFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

const volVectorField & Us ( ) const
virtual

Return the film surface velocity [m/s].

Implements surfaceFilmModel.

Definition at line 124 of file noFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, GeometricField< vector, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

const volVectorField & Uw ( ) const
virtual

Return the film wall velocity [m/s].

Implements surfaceFilmModel.

Definition at line 133 of file noFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, GeometricField< vector, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

const volScalarField & T ( ) const
virtual

Return the film mean temperature [K].

Implements surfaceFilmModel.

Definition at line 151 of file noFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

const volScalarField & Ts ( ) const
virtual

Return the film surface temperature [K].

Implements surfaceFilmModel.

Definition at line 160 of file noFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

const volScalarField & Tw ( ) const
virtual

Return the film wall temperature [K].

Implements surfaceFilmModel.

Definition at line 169 of file noFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

const volScalarField & Cp ( ) const
virtual

Return the film specific heat capacity [J/kg/K].

Implements surfaceFilmModel.

Definition at line 178 of file noFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

const volScalarField & kappa ( ) const
virtual

Return the film thermal conductivity [W/m/K].

Implements surfaceFilmModel.

Definition at line 187 of file noFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

const volScalarField & sigma ( ) const
inlinevirtual

Return const access to the surface tension / [m/s2].

Implements surfaceFilmModel.

Definition at line 196 of file noFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

tmp< volScalarField > primaryMassTrans ( ) const
virtual

Return mass transfer source - Eulerian phase only.

Implements surfaceFilmModel.

Definition at line 205 of file noFilm.C.

References Foam::dimMass, Foam::dimTime, Foam::dimVolume, IOobject::NO_READ, IOobject::NO_WRITE, regionModel::primaryMesh(), regionModel::time(), and timeName.

Here is the call graph for this function:

const volScalarField & cloudMassTrans ( ) const
virtual

Return the film mass available for transfer.

Implements surfaceFilmModel.

Definition at line 227 of file noFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

const volScalarField & cloudDiameterTrans ( ) const
virtual

Return the parcel diameters originating from film.

Implements surfaceFilmModel.

Definition at line 237 of file noFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

tmp< DimensionedField< scalar, volMesh > > Srho ( ) const
virtual

Return total mass source - Eulerian phase only.

Reimplemented from surfaceFilmModel.

Definition at line 247 of file noFilm.C.

References Foam::dimMass, Foam::dimTime, Foam::dimVolume, IOobject::IOobject(), IOobject::NO_READ, IOobject::NO_WRITE, regionModel::primaryMesh(), regionModel::time(), and timeName.

Here is the call graph for this function:

tmp< DimensionedField< scalar, volMesh > > Srho ( const label  i) const
virtual

Return mass source for specie i - Eulerian phase only.

Reimplemented from surfaceFilmModel.

Definition at line 269 of file noFilm.C.

References Foam::dimMass, Foam::dimTime, Foam::dimVolume, IOobject::IOobject(), Foam::name(), IOobject::NO_READ, IOobject::NO_WRITE, regionModel::primaryMesh(), regionModel::time(), and timeName.

Here is the call graph for this function:

tmp< DimensionedField< scalar, volMesh > > Sh ( ) const
virtual

Return enthalpy source - Eulerian phase only.

Reimplemented from surfaceFilmModel.

Definition at line 291 of file noFilm.C.

References Foam::dimEnergy, Foam::dimTime, Foam::dimVolume, IOobject::IOobject(), IOobject::NO_READ, IOobject::NO_WRITE, regionModel::primaryMesh(), regionModel::time(), and timeName.

Here is the call graph for this function:


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