Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
thermoSingleLayer Class Reference

Thermodynamic form of single-cell layer surface film model. More...

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

Public Member Functions

 TypeName ("thermoSingleLayer")
 
 thermoSingleLayer (const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType, const bool readFields=true)
 
virtual ~thermoSingleLayer ()
 
const SLGThermothermo () const
 
virtual const volScalarFieldCp () const
 
virtual const volScalarFieldkappa () const
 
virtual const volScalarFieldT () const
 
virtual const volScalarFieldTs () const
 
virtual const volScalarFieldTw () const
 
virtual const volScalarFieldhs () const
 
tmp< scalarFieldhs (const scalarField &T, const label patchi) const
 
tmp< volScalarFieldhs (const volScalarField &T) const
 
tmp< volScalarFieldT (const volScalarField &hs) const
 
virtual void addSources (const label patchi, const label facei, const scalar massSource, const vector &momentumSource, const scalar pressureSource, const scalar energySource)
 
const volScalarFieldhsSp () const
 
const volScalarFieldhsSpPrimary () const
 
const volScalarFieldTPrimary () const
 
const PtrList< volScalarField > & YPrimary () const
 
const heatTransferModelhtcs () const
 
const heatTransferModelhtcw () const
 
const phaseChangeModelphaseChange () const
 
const filmRadiationModelradiation () const
 
tmp< scalarFieldqconvw (const label patchi) const
 
tmp< scalarFieldqconvp (const label patchi) const
 
virtual void preEvolveRegion ()
 
virtual void evolveRegion ()
 
virtual tmp< volScalarField::InternalSrho () const
 
virtual tmp< volScalarField::InternalSrho (const label i) const
 
virtual tmp< volScalarField::InternalSh () const
 
virtual void info ()
 
- Public Member Functions inherited from kinematicSingleLayer
 TypeName ("kinematicSingleLayer")
 
 kinematicSingleLayer (const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType, const bool readFields=true)
 
virtual ~kinematicSingleLayer ()
 
virtual scalar CourantNumber () const
 
Switch momentumPredictor () const
 
label nOuterCorr () const
 
label nCorr () const
 
label nNonOrthCorr () const
 
const dimensionedScalardeltaSmall () const
 
const volScalarFieldmu () const
 
const volScalarFieldsigma () const
 
const volScalarFielddelta () const
 
const volScalarFieldalpha () const
 
virtual const volVectorFieldU () const
 
virtual const volVectorFieldUs () const
 
virtual const volVectorFieldUw () const
 
virtual const volScalarFielddeltaRho () const
 
virtual const surfaceScalarFieldphi () const
 
virtual const volScalarFieldrho () const
 
virtual tmp< volScalarFieldprimaryMassTrans () const
 
virtual const volScalarFieldcloudMassTrans () const
 
virtual const volScalarFieldcloudDiameterTrans () const
 
volVectorFieldUSpPrimary ()
 
volScalarFieldpSpPrimary ()
 
volScalarFieldrhoSpPrimary ()
 
volVectorFieldUSp ()
 
volScalarFieldpSp ()
 
volScalarFieldrhoSp ()
 
const volVectorFieldUSp () const
 
const volScalarFieldpSp () const
 
const volScalarFieldrhoSp () const
 
const volVectorFieldUPrimary () const
 
const volScalarFieldpPrimary () const
 
const volScalarFieldrhoPrimary () const
 
const volScalarFieldmuPrimary () const
 
const filmThermoModelfilmThermo () const
 
injectionModelListinjection ()
 
transferModelListtransfer ()
 
const filmTurbulenceModelturbulence () const
 
tmp< volScalarFieldmass () const
 
tmp< volScalarFielddeltaMass () const
 
tmp< volScalarFieldgNorm () const
 
tmp< volScalarFieldgNormClipped () const
 
tmp< volVectorFieldgTan () const
 
tmp< vectorFieldgTan (const label patchI) const
 
virtual void postEvolveRegion ()
 
- Public Member Functions inherited from surfaceFilmRegionModel
 TypeName ("surfaceFilmRegionModel")
 
 surfaceFilmRegionModel (const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType)
 
virtual ~surfaceFilmRegionModel ()
 
const dimensionedVectorg () const
 
virtual void evolve ()
 
- Public Member Functions inherited from surfaceFilmModel
 TypeName ("surfaceFilmModel")
 
 declareRunTimeSelectionTable (autoPtr, surfaceFilmModel, mesh,(const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType),(modelType, mesh, g, regionType))
 
 surfaceFilmModel ()
 
virtual ~surfaceFilmModel ()
 
- Public Member Functions inherited from singleLayerRegion
 TypeName ("regionModel")
 
 singleLayerRegion (const fvMesh &mesh, const word &regionType)
 
 singleLayerRegion (const fvMesh &mesh, const word &regionType, const word &modelName, bool readFields=true)
 
virtual ~singleLayerRegion ()
 
virtual const volVectorFieldnHat () const
 
virtual const volScalarFieldmagSf () const
 
virtual const labelListpassivePatchIDs () const
 
template<class Type >
wordList mappedFieldAndInternalPatchTypes () const
 
template<class Type >
wordList mappedPushedFieldPatchTypes () const
 
template<class Type >
Foam::wordList mappedFieldAndInternalPatchTypes () const
 
template<class Type >
Foam::wordList mappedPushedFieldPatchTypes () const
 
- Public Member Functions inherited from regionModel
 TypeName ("regionModel")
 
 regionModel (const fvMesh &mesh, const word &regionType)
 
 regionModel (const fvMesh &mesh, const word &regionType, const word &modelName, bool readFields=true)
 
 regionModel (const fvMesh &mesh, const word &regionType, const word &modelName, const dictionary &dict, bool readFields=true)
 
virtual ~regionModel ()=default
 
const fvMeshprimaryMesh () const
 
const Timetime () const
 
Switch active () const
 
Switch infoOutput () const
 
const wordmodelName () const
 
const fvMeshregionMesh () const
 
fvMeshregionMesh ()
 
const dictionarycoeffs () const
 
const dictionarysolution () const
 
const IOdictionaryoutputProperties () const
 
IOdictionaryoutputProperties ()
 
bool isCoupledPatch (const label regionPatchi) const
 
bool isRegionPatch (const label primaryPatchi) const
 
const labelListprimaryPatchIDs () const
 
const labelListintCoupledPatchIDs () const
 
label regionPatchID (const label primaryPatchID) const
 
label nbrCoupledPatchID (const regionModel &nbrRegion, const label regionPatchi) const
 
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
 
template<class Type >
tmp< Field< Type > > mapRegionPatchField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchi, const bool flip=false) const
 
template<class Type >
tmp< Field< Type > > mapRegionPatchInternalField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchi, const bool flip=false) const
 
template<class Type >
void toPrimary (const label regionPatchi, List< Type > &regionField) const
 
template<class Type >
void toRegion (const label regionPatchi, List< Type > &primaryFieldField) const
 
template<class Type , class CombineOp >
void toPrimary (const label regionPatchi, List< Type > &regionField, const CombineOp &cop) const
 
template<class Type , class CombineOp >
void toRegion (const label regionPatchi, List< Type > &primaryFieldField, const CombineOp &cop) const
 
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
 IOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 
 IOdictionary (const IOobject &io, const dictionary &dict)
 
 IOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr)
 
 IOdictionary (const IOobject &io, Istream &is)
 
virtual ~IOdictionary ()=default
 
virtual bool global () const
 
virtual fileName filePath () const
 
- Public Member Functions inherited from baseIOdictionary
 TypeName ("dictionary")
 
 baseIOdictionary (const baseIOdictionary &)=default
 
 baseIOdictionary (baseIOdictionary &&)=default
 
virtual ~baseIOdictionary ()=default
 
 baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 
 baseIOdictionary (const IOobject &io, const dictionary &dict)
 
 baseIOdictionary (const IOobject &io, Istream &is)
 
const wordname () const
 
virtual bool readData (Istream &)
 
virtual bool writeData (Ostream &) const
 
void operator= (const baseIOdictionary &rhs)
 
void operator= (const dictionary &rhs)
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 
 regIOobject (const regIOobject &rio)
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 
virtual ~regIOobject ()
 
bool checkIn ()
 
bool checkOut ()
 
virtual void addWatch ()
 
bool ownedByRegistry () const
 
bool store ()
 
void release (const bool unregister=false)
 
label eventNo () const
 
label & eventNo ()
 
bool upToDate (const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 
void setUpToDate ()
 
virtual void rename (const word &newName)
 
const dictionaryfindMetaData () const noexcept
 
dictionarygetMetaData () noexcept
 
void removeMetaData ()
 
virtual void updateMetaData ()
 
bool headerOk ()
 
IstreamreadStream (const word &, const bool valid=true)
 
void close ()
 
virtual label addWatch (const fileName &)
 
const labelListwatchIndices () const
 
labelListwatchIndices ()
 
virtual bool modified () const
 
virtual bool readIfModified ()
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 
virtual bool write (const bool valid=true) const
 
void operator= (const IOobject &io)
 
virtual bool writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 
 IOobject (const IOobject &)=default
 
virtual ~IOobject ()=default
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 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)
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 
 IOobject (const IOobject &io, const word &name)
 
 IOobject (const IOobject &io, readOption, writeOption)
 
autoPtr< IOobjectclone () const
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 
const objectRegistrydb () const noexcept
 
const Timetime () const
 
const wordname () const noexcept
 
const wordheaderClassName () const noexcept
 
wordheaderClassName () noexcept
 
const stringnote () const noexcept
 
stringnote () noexcept
 
bool registerObject () const noexcept
 
bool registerObject (bool on) noexcept
 
bool globalObject () const noexcept
 
bool globalObject (bool on) noexcept
 
unsigned labelByteSize () const noexcept
 
unsigned scalarByteSize () const noexcept
 
bool isHeaderClassName (const word &clsName) const
 
template<class Type >
bool isHeaderClassName () const
 
readOption readOpt () const noexcept
 
readOption readOpt (readOption opt) noexcept
 
writeOption writeOpt () const noexcept
 
writeOption writeOpt (writeOption opt) noexcept
 
word group () const
 
word member () const
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const noexcept
 
fileNameinstance () noexcept
 
const fileNamelocal () const noexcept
 
fileName path () const
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 
fileName objectPath () const
 
fileName objectRelPath () const
 
fileName localFilePath (const word &typeName, const bool search=true) const
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 
IOstreamOption parseHeader (const dictionary &headerDict)
 
bool readHeader (Istream &is)
 
bool readHeader (dictionary &headerDict, Istream &is)
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 
template<class Type >
void warnNoRereading () const
 
bool writeHeader (Ostream &os) const
 
bool writeHeader (Ostream &os, const word &objectType) const
 
void writeHeader (dictionary &dict, IOstreamOption streamOpt) const
 
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 
bool good () const noexcept
 
bool bad () const noexcept
 
InfoProxy< IOobjectinfo () const
 
void operator= (const IOobject &io)
 
readOptionreadOpt () noexcept
 
writeOptionwriteOpt () noexcept
 
boolregisterObject () noexcept
 
boolglobalObject () noexcept
 
template<>
bool isHeaderClassName () const
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 
 dictionary ()
 
 dictionary (const fileName &name)
 
 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)
 
 dictionary (const dictionary &dict)
 
 dictionary (const dictionary *dict)
 
 dictionary (const dictionary &parentDict, dictionary &&dict)
 
 dictionary (dictionary &&dict)
 
autoPtr< dictionaryclone () const
 
virtual ~dictionary ()
 
const fileNamename () const noexcept
 
fileNamename () noexcept
 
word dictName () const
 
fileName relativeName (const bool caseTag=false) const
 
bool isNullDict () const noexcept
 
const dictionaryparent () const noexcept
 
const dictionarytopDict () const
 
label startLineNumber () const
 
label endLineNumber () const
 
SHA1Digest digest () const
 
tokenList tokens () const
 
bool found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
const entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
const entryfindScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
const dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
const entrylookupEntry (const word &keyword, enum keyType::option matchOpt) const
 
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, enum keyType::option matchOpt=keyType::REGEX) const
 
const dictionarysubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
dictionarysubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
dictionarysubDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
dictionary subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const
 
const dictionaryoptionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
wordList toc () const
 
wordList sortedToc () const
 
template<class Compare >
wordList sortedToc (const Compare &comp) const
 
List< keyTypekeys (bool patterns=false) const
 
bool substituteKeyword (const word &keyword, bool mergeEntry=false)
 
bool substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
 
entryadd (entry *entryPtr, bool mergeEntry=false)
 
entryadd (const entry &e, bool mergeEntry=false)
 
entryadd (const keyType &k, const word &v, bool overwrite=false)
 
entryadd (const keyType &k, const string &v, bool overwrite=false)
 
entryadd (const keyType &k, const label v, bool overwrite=false)
 
entryadd (const keyType &k, const scalar v, bool overwrite=false)
 
entryadd (const keyType &k, const dictionary &d, bool mergeEntry=false)
 
template<class T >
entryadd (const keyType &k, const T &v, bool overwrite=false)
 
entryset (entry *entryPtr)
 
entryset (const entry &e)
 
entryset (const keyType &k, const dictionary &v)
 
template<class T >
entryset (const keyType &k, const T &v)
 
bool remove (const word &keyword)
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
 
bool merge (const dictionary &dict)
 
void clear ()
 
void transfer (dictionary &dict)
 
void checkITstream (const ITstream &is, const word &keyword) const
 
bool read (Istream &is)
 
bool read (Istream &is, bool keepHeader)
 
void writeEntry (Ostream &os) const
 
void writeEntry (const keyType &keyword, Ostream &os) const
 
void writeEntries (Ostream &os, const bool extraNewLine=false) const
 
void write (Ostream &os, const bool subDict=true) const
 
const_searcher csearch (const word &keyword, enum keyType::option=keyType::REGEX) const
 
const_searcher search (const word &keyword, enum keyType::option=keyType::REGEX) const
 
searcher search (const word &keyword, enum keyType::option=keyType::REGEX)
 
const_searcher csearchScoped (const word &keyword, enum keyType::option) const
 
const_searcher searchScoped (const word &keyword, enum keyType::option) const
 
searcher searchScoped (const word &keyword, enum keyType::option)
 
const dictionarycfindScopedDict (const fileName &dictPath) const
 
const dictionaryfindScopedDict (const fileName &dictPath) const
 
dictionaryfindScopedDict (const fileName &dictPath)
 
dictionarymakeScopedDict (const fileName &dictPath)
 
const_searcher csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
bool foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
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)
 
void operator+= (const dictionary &rhs)
 
void operator|= (const dictionary &rhs)
 
void operator<<= (const dictionary &rhs)
 
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
 
ITstreamoperator[] (const word &keyword) const
 
bool found (const word &keyword, bool recursive, bool patternMatch=true) const
 
entrylookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
 
const entrylookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 
const entrylookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 
const dictionarysubDictPtr (const word &keyword) const
 
dictionarysubDictPtr (const word &keyword)
 
const entrylookupEntry (const word &keyword, bool recursive, bool patternMatch) const
 
ITstreamlookup (const word &keyword, bool recursive, bool patternMatch=true) const
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
 
template<class T >
bool readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
 
template<class T >
T lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
 
bool getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< bool >(const word&, keyType::option) 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
 ILList ()=default
 
 ILList (T *item)
 
 ILList (Istream &is)
 
 ILList (const ILList< LListBase, T > &lst)
 
 ILList (ILList< LListBase, T > &&lst)
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 
template<class INew >
 ILList (Istream &is, const INew &inew)
 
 ~ILList ()
 
bool eraseHead ()
 
bool erase (T *item)
 
void clear ()
 
void transfer (ILList< LListBase, T > &lst)
 
void operator= (const ILList< LListBase, T > &lst)
 
void operator= (ILList< LListBase, T > &&lst)
 

Protected Member Functions

virtual bool read ()
 
virtual void correctThermoFields ()
 
virtual void correctHsForMappedT ()
 
virtual void updateSurfaceTemperatures ()
 
virtual void resetPrimaryRegionSourceTerms ()
 
virtual void transferPrimaryRegionThermoFields ()
 
virtual void transferPrimaryRegionSourceFields ()
 
virtual void correctAlpha ()
 
virtual void updateSubmodels ()
 
virtual tmp< fvScalarMatrixq (volScalarField &hs) const
 
virtual void solveEnergy ()
 
- Protected Member Functions inherited from kinematicSingleLayer
virtual tmp< volScalarFieldpu ()
 
virtual tmp< volScalarFieldpp ()
 
virtual void continuityCheck ()
 
virtual void updateSurfaceVelocities ()
 
template<class Type >
void constrainFilmField (Type &field, const typename Type::cmptType &value)
 
virtual void solveContinuity ()
 
virtual tmp< fvVectorMatrixsolveMomentum (const volScalarField &pu, const volScalarField &pp)
 
virtual void solveThickness (const volScalarField &pu, const volScalarField &pp, fvVectorMatrix &UEqn)
 
- Protected Member Functions inherited from regionModel
virtual bool read (const dictionary &dict)
 
virtual const AMIPatchToPatchInterpolationinterRegionAMI (const regionModel &nbrRegion, const label regionPatchi, const label nbrPatchi, const bool flip) const
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 

Protected Attributes

const SLGThermothermo_
 
volScalarField Cp_
 
volScalarField kappa_
 
volScalarField T_
 
volScalarField Ts_
 
volScalarField Tw_
 
volScalarField hs_
 
volScalarField primaryEnergyTrans_
 
scalar deltaWet_
 
bool hydrophilic_
 
scalar hydrophilicDryScale_
 
scalar hydrophilicWetScale_
 
volScalarField hsSp_
 
volScalarField hsSpPrimary_
 
volScalarField TPrimary_
 
PtrList< volScalarFieldYPrimary_
 
autoPtr< filmViscosityModelviscosity_
 
autoPtr< heatTransferModelhtcs_
 
autoPtr< heatTransferModelhtcw_
 
autoPtr< phaseChangeModelphaseChange_
 
autoPtr< filmRadiationModelradiation_
 
scalar Tmin_
 
scalar Tmax_
 
- Protected Attributes inherited from kinematicSingleLayer
Switch momentumPredictor_
 
label nOuterCorr_
 
label nCorr_
 
label nNonOrthCorr_
 
scalar cumulativeContErr_
 
const dimensionedScalar deltaSmall_
 
scalar deltaCoLimit_
 
volScalarField rho_
 
volScalarField mu_
 
volScalarField sigma_
 
volScalarField delta_
 
volScalarField alpha_
 
volVectorField U_
 
volVectorField Us_
 
volVectorField Uw_
 
volScalarField deltaRho_
 
surfaceScalarField phi_
 
volScalarField primaryMassTrans_
 
volScalarField cloudMassTrans_
 
volScalarField cloudDiameterTrans_
 
volVectorField USp_
 
volScalarField pSp_
 
volScalarField rhoSp_
 
volVectorField USpPrimary_
 
volScalarField pSpPrimary_
 
volScalarField rhoSpPrimary_
 
volVectorField UPrimary_
 
volScalarField pPrimary_
 
volScalarField rhoPrimary_
 
volScalarField muPrimary_
 
autoPtr< filmThermoModelfilmThermo_
 
scalarField availableMass_
 
injectionModelList injection_
 
transferModelList transfer_
 
autoPtr< filmTurbulenceModelturbulence_
 
forceList forces_
 
scalar addedMassTotal_
 
- Protected Attributes inherited from surfaceFilmRegionModel
const dimensionedVectorg_
 
- Protected Attributes inherited from singleLayerRegion
autoPtr< volVectorFieldnHatPtr_
 
autoPtr< volScalarFieldmagSfPtr_
 
labelList passivePatchIDs_
 
- Protected Attributes inherited from regionModel
const fvMeshprimaryMesh_
 
const Timetime_
 
Switch active_
 
Switch infoOutput_
 
const word modelName_
 
dictionary coeffs_
 
autoPtr< IOdictionaryoutputPropertiesPtr_
 
labelList primaryPatchIDs_
 
labelList intCoupledPatchIDs_
 
word regionName_
 
regionModelFunctionObjectList functions_
 
wordList interRegionAMINames_
 
PtrList< PtrList< AMIPatchToPatchInterpolation > > interRegionAMI_
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState : char { GOOD, BAD }
 
enum  readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 
enum  writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 
- Public Types inherited from dictionary
typedef Searcher< true > const_searcher
 
typedef Searcher< false > searcher
 
- Static Public Member Functions inherited from surfaceFilmModel
static autoPtr< surfaceFilmModelNew (const fvMesh &mesh, const dimensionedVector &g, const word &regionType="surfaceFilm")
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 
- Static Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 
static bool bannerEnabled (bool on) noexcept
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 
template<class StringType >
static word groupName (StringType base, const word &group)
 
static word group (const word &name)
 
static word member (const word &name)
 
static word scopedName (const std::string &scope, const word &name)
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 
static OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 
static OstreamwriteDivider (Ostream &os)
 
static OstreamwriteEndDivider (Ostream &os)
 
- Static Public Member Functions inherited from dictionary
static int reportOptional () noexcept
 
static int reportOptional (const int level) noexcept
 
static autoPtr< dictionaryNew (Istream &is)
 
- Public Attributes inherited from dictionary
friend const_searcher
 
friend searcher
 
- Static Public Attributes inherited from surfaceFilmModel
static const dimensionedScalar Tref
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 
static char scopeSeparator
 
static fileCheckTypes fileModificationChecking
 
static float fileModificationSkew
 
static int maxFileModificationPolls
 
- Static Public Attributes inherited from dictionary
static int writeOptionalEntries
 
static const dictionary null
 
static refPtr< OSstreamreportingOutput
 
- Static Protected Member Functions inherited from IOobject
static void writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
 
static void writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 

Detailed Description

Thermodynamic form of single-cell layer surface film model.

Note: defining enthalpy as Cp(T - Tstd) - when using liquids from the thermophysical library, their enthalpies are calculated similarly, where Tstd = 298.15K. This is clearly non-conservative unless the heat-capacity is constant and should be rewritten to use the standard thermodynamics packages.

Source files

Definition at line 63 of file thermoSingleLayer.H.

Constructor & Destructor Documentation

◆ thermoSingleLayer()

thermoSingleLayer ( const word modelType,
const fvMesh mesh,
const dimensionedVector g,
const word regionType,
const bool  readFields = true 
)

◆ ~thermoSingleLayer()

~thermoSingleLayer ( )
virtual

Definition at line 557 of file thermoSingleLayer.C.

Member Function Documentation

◆ read()

bool read ( )
protectedvirtual

Reimplemented from kinematicSingleLayer.

Definition at line 81 of file thermoSingleLayer.C.

References kinematicSingleLayer::read().

Here is the call graph for this function:

◆ correctThermoFields()

void correctThermoFields ( )
protectedvirtual

◆ correctHsForMappedT()

void correctHsForMappedT ( )
protectedvirtual

◆ updateSurfaceTemperatures()

void updateSurfaceTemperatures ( )
protectedvirtual

◆ resetPrimaryRegionSourceTerms()

void resetPrimaryRegionSourceTerms ( )
protectedvirtual

◆ transferPrimaryRegionThermoFields()

void transferPrimaryRegionThermoFields ( )
protectedvirtual

◆ transferPrimaryRegionSourceFields()

void transferPrimaryRegionSourceFields ( )
protectedvirtual

◆ correctAlpha()

void correctAlpha ( )
protectedvirtual

◆ updateSubmodels()

void updateSubmodels ( )
protectedvirtual

◆ q()

tmp< fvScalarMatrix > q ( volScalarField hs) const
protectedvirtual

◆ solveEnergy()

void solveEnergy ( )
protectedvirtual

◆ TypeName()

TypeName ( "thermoSingleLayer"  )

◆ thermo()

const SLGThermo & thermo ( ) const
inline

Definition at line 37 of file thermoSingleLayerI.H.

References thermoSingleLayer::thermo_.

Referenced by standardPhaseChange::correctModel(), and waxSolventEvaporation::correctModel().

Here is the caller graph for this function:

◆ Cp()

const volScalarField & Cp ( ) const
virtual

Reimplemented from kinematicSingleLayer.

Definition at line 643 of file thermoSingleLayer.C.

References thermoSingleLayer::Cp_.

◆ kappa()

const volScalarField & kappa ( ) const
virtual

Reimplemented from kinematicSingleLayer.

Definition at line 649 of file thermoSingleLayer.C.

References thermoSingleLayer::kappa_.

◆ T() [1/2]

const volScalarField & T ( ) const
virtual

Reimplemented from kinematicSingleLayer.

Definition at line 655 of file thermoSingleLayer.C.

References thermoSingleLayer::T_.

Referenced by standardPhaseChange::correctModel(), waxSolventEvaporation::correctModel(), solidification::correctModel(), and thermoSingleLayer::evolveRegion().

Here is the caller graph for this function:

◆ Ts()

const volScalarField & Ts ( ) const
virtual

Reimplemented from kinematicSingleLayer.

Definition at line 661 of file thermoSingleLayer.C.

References thermoSingleLayer::Ts_.

Referenced by filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ Tw()

const volScalarField & Tw ( ) const
virtual

Reimplemented from kinematicSingleLayer.

Definition at line 667 of file thermoSingleLayer.C.

References thermoSingleLayer::Tw_.

◆ hs() [1/3]

const volScalarField & hs ( ) const
virtual

Reimplemented from kinematicSingleLayer.

Definition at line 673 of file thermoSingleLayer.C.

References thermoSingleLayer::hs_.

Referenced by thermoSingleLayer::correctHsForMappedT(), standardPhaseChange::correctModel(), waxSolventEvaporation::correctModel(), and thermoSingleLayer::q().

Here is the caller graph for this function:

◆ hs() [2/3]

tmp< scalarField > hs ( const scalarField T,
const label  patchi 
) const
inline

Definition at line 44 of file thermoSingleLayerI.H.

References Cp, and Foam::T().

Here is the call graph for this function:

◆ hs() [3/3]

tmp< volScalarField > hs ( const volScalarField T) const
inline

Definition at line 55 of file thermoSingleLayerI.H.

References IOobject::NO_READ, IOobject::NO_WRITE, Foam::T(), and timeName.

Here is the call graph for this function:

◆ T() [2/2]

tmp< volScalarField > T ( const volScalarField hs) const
inline

Definition at line 78 of file thermoSingleLayerI.H.

References IOobject::NO_READ, IOobject::NO_WRITE, tmp::ref(), and timeName.

Here is the call graph for this function:

◆ addSources()

void addSources ( const label  patchi,
const label  facei,
const scalar  massSource,
const vector momentumSource,
const scalar  pressureSource,
const scalar  energySource 
)
virtual

Reimplemented from kinematicSingleLayer.

Definition at line 564 of file thermoSingleLayer.C.

References kinematicSingleLayer::addSources(), DebugInfo, and Foam::nl.

Here is the call graph for this function:

◆ hsSp()

const volScalarField & hsSp ( ) const
inline

Definition at line 105 of file thermoSingleLayerI.H.

References thermoSingleLayer::hsSp_.

◆ hsSpPrimary()

const volScalarField & hsSpPrimary ( ) const
inline

Definition at line 111 of file thermoSingleLayerI.H.

References thermoSingleLayer::hsSpPrimary_.

◆ TPrimary()

const volScalarField & TPrimary ( ) const
inline

Definition at line 117 of file thermoSingleLayerI.H.

References thermoSingleLayer::TPrimary_.

◆ YPrimary()

const PtrList< volScalarField > & YPrimary ( ) const
inline

Definition at line 123 of file thermoSingleLayerI.H.

References thermoSingleLayer::YPrimary_.

Referenced by standardPhaseChange::correctModel(), and waxSolventEvaporation::correctModel().

Here is the caller graph for this function:

◆ htcs()

const heatTransferModel & htcs ( ) const
inline

Definition at line 129 of file thermoSingleLayerI.H.

References thermoSingleLayer::htcs_.

◆ htcw()

const heatTransferModel & htcw ( ) const
inline

Definition at line 135 of file thermoSingleLayerI.H.

References thermoSingleLayer::htcw_.

Referenced by filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ phaseChange()

const phaseChangeModel & phaseChange ( ) const
inline

Definition at line 141 of file thermoSingleLayerI.H.

References thermoSingleLayer::phaseChange_.

◆ radiation()

const filmRadiationModel & radiation ( ) const
inline

Definition at line 147 of file thermoSingleLayerI.H.

References thermoSingleLayer::radiation_.

◆ qconvw()

tmp< scalarField > qconvw ( const label  patchi) const
inline

Definition at line 153 of file thermoSingleLayerI.H.

References GeometricField::boundaryField(), thermoSingleLayer::htcw_, thermoSingleLayer::T_, and thermoSingleLayer::Tw_.

Here is the call graph for this function:

◆ qconvp()

tmp< scalarField > qconvp ( const label  patchi) const
inline

Definition at line 163 of file thermoSingleLayerI.H.

References GeometricField::boundaryField(), thermoSingleLayer::htcs_, thermoSingleLayer::T_, and thermoSingleLayer::TPrimary_.

Here is the call graph for this function:

◆ preEvolveRegion()

void preEvolveRegion ( )
virtual

Reimplemented from kinematicSingleLayer.

Definition at line 590 of file thermoSingleLayer.C.

References DebugInFunction, Foam::dimEnergy, Foam::endl(), kinematicSingleLayer::preEvolveRegion(), thermoSingleLayer::primaryEnergyTrans_, and Foam::Zero.

Here is the call graph for this function:

◆ evolveRegion()

void evolveRegion ( )
virtual

◆ Srho() [1/2]

tmp< volScalarField::Internal > Srho ( ) const
virtual

◆ Srho() [2/2]

tmp< volScalarField::Internal > Srho ( const label  i) const
virtual

Reimplemented from kinematicSingleLayer.

Definition at line 742 of file thermoSingleLayer.C.

References cells, Foam::dimMass, Foam::dimTime, Foam::dimVolume, forAll, Foam::name(), IOobject::NO_READ, IOobject::NO_WRITE, tmp::ref(), and Foam::Zero.

Here is the call graph for this function:

◆ Sh()

tmp< volScalarField::Internal > Sh ( ) const
virtual

◆ info()

void info ( )
virtual

Member Data Documentation

◆ thermo_

const SLGThermo& thermo_
protected

Definition at line 86 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::thermo().

◆ Cp_

volScalarField Cp_
protected

◆ kappa_

volScalarField kappa_
protected

◆ T_

volScalarField T_
protected

◆ Ts_

volScalarField Ts_
protected

◆ Tw_

volScalarField Tw_
protected

◆ hs_

volScalarField hs_
protected

◆ primaryEnergyTrans_

volScalarField primaryEnergyTrans_
protected

◆ deltaWet_

scalar deltaWet_
protected

Definition at line 117 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::correctAlpha().

◆ hydrophilic_

bool hydrophilic_
protected

Definition at line 123 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::correctAlpha().

◆ hydrophilicDryScale_

scalar hydrophilicDryScale_
protected

Definition at line 127 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::correctAlpha().

◆ hydrophilicWetScale_

scalar hydrophilicWetScale_
protected

Definition at line 131 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::correctAlpha().

◆ hsSp_

volScalarField hsSp_
protected

◆ hsSpPrimary_

volScalarField hsSpPrimary_
protected

◆ TPrimary_

volScalarField TPrimary_
protected

◆ YPrimary_

PtrList<volScalarField> YPrimary_
protected

◆ viscosity_

autoPtr<filmViscosityModel> viscosity_
protected

Definition at line 164 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::solveEnergy().

◆ htcs_

autoPtr<heatTransferModel> htcs_
protected

◆ htcw_

autoPtr<heatTransferModel> htcw_
protected

◆ phaseChange_

autoPtr<phaseChangeModel> phaseChange_
protected

◆ radiation_

autoPtr<filmRadiationModel> radiation_
protected

◆ Tmin_

scalar Tmin_
protected

Definition at line 183 of file thermoSingleLayer.H.

◆ Tmax_

scalar Tmax_
protected

Definition at line 186 of file thermoSingleLayer.H.


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