Public Types | Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
phaseSystem Class Referenceabstract

Class to represent a system of phases and model interfacial transfers between them. More...

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

Public Types

typedef HashTable< autoPtr< phasePair >, phasePairKey, phasePairKey::hashphasePairTable
 
typedef HashTable< autoPtr< phaseModel > > phaseModelTable
 
typedef HashTable< volScalarField::InternalSuSpTable
 
typedef HashPtrTable< fvVectorMatrixmomentumTransferTable
 
typedef HashPtrTable< fvScalarMatrixheatTransferTable
 
typedef HashPtrTable< fvScalarMatrixmassTransferTable
 
typedef PtrListDictionary< phaseModelphaseModelList
 
typedef UPtrList< phaseModelphaseModelPartialList
 
typedef HashTable< autoPtr< phasePair >, phasePairKey, phasePairKey::hashphasePairTable
 
- 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
 

Public Member Functions

 TypeName ("phaseSystem")
 
 phaseSystem (const fvMesh &mesh)
 
virtual ~phaseSystem ()
 
virtual volScalarFieldhe ()
 
virtual const volScalarFieldhe () const
 
virtual tmp< volScalarFieldhe (const volScalarField &p, const volScalarField &T) const
 
virtual tmp< scalarFieldhe (const scalarField &p, const scalarField &T, const labelList &cells) const
 
virtual tmp< scalarFieldhe (const scalarField &p, const scalarField &T, const label patchi) const
 
virtual tmp< volScalarFieldhc () const
 
virtual tmp< scalarFieldTHE (const scalarField &h, const scalarField &p, const scalarField &T0, const labelList &cells) const
 
virtual tmp< scalarFieldTHE (const scalarField &h, const scalarField &p, const scalarField &T0, const label patchi) const
 
virtual tmp< volScalarFieldrho () const
 
virtual tmp< scalarFieldrho (const label patchi) const
 
virtual tmp< volScalarFieldCp () const
 
virtual tmp< scalarFieldCp (const scalarField &p, const scalarField &T, const label patchi) const
 
virtual tmp< scalarFieldCp (const scalarField &p, const scalarField &T, const labelList &cells) const
 
virtual tmp< volScalarFieldCv () const
 
virtual tmp< scalarFieldCv (const scalarField &p, const scalarField &T, const label patchI) const
 
virtual tmp< scalarFieldrhoEoS (const scalarField &p, const scalarField &T, const labelList &cells) const
 
virtual tmp< volScalarFieldgamma () const
 
virtual tmp< scalarFieldgamma (const scalarField &p, const scalarField &T, const label patchi) const
 
virtual tmp< volScalarFieldCpv () const
 
virtual tmp< scalarFieldCpv (const scalarField &p, const scalarField &T, const label patchi) const
 
virtual tmp< volScalarFieldCpByCpv () const
 
virtual tmp< scalarFieldCpByCpv (const scalarField &p, const scalarField &T, const label patchi) const
 
virtual tmp< volScalarFieldW () const
 
virtual tmp< volScalarFieldkappa () const
 
virtual tmp< scalarFieldkappa (const label patchi) const
 
virtual tmp< volScalarFieldalphahe () const
 
virtual tmp< scalarFieldalphahe (const label patchi) const
 
virtual tmp< volScalarFieldkappaEff (const volScalarField &kappat) const
 
virtual tmp< scalarFieldkappaEff (const scalarField &alphat, const label patchi) const
 
virtual tmp< volScalarFieldalphaEff (const volScalarField &alphat) const
 
virtual tmp< scalarFieldalphaEff (const scalarField &alphat, const label patchi) const
 
const dimensionedScalarPrt () const
 
virtual tmp< volScalarFieldmu () const
 
virtual tmp< scalarFieldmu (const label patchi) const
 
virtual tmp< volScalarFieldnu () const
 
virtual tmp< scalarFieldnu (const label patchi) const
 
const surfaceScalarFieldphi () const
 
surfaceScalarFieldphi ()
 
const surfaceScalarFieldrhoPhi () const
 
surfaceScalarFieldrhoPhi ()
 
tmp< volVectorFieldU () const
 
tmp< surfaceScalarFieldsurfaceTensionForce () const
 
virtual tmp< volScalarFieldsurfaceTensionCoeff (const phasePairKey &key) const
 
virtual tmp< volScalarFieldcoeffs (const word &key) const
 
void addInterfacePorosity (fvVectorMatrix &UEqn)
 
virtual tmp< volScalarFielddmdt (const phasePairKey &key) const =0
 
virtual tmp< fvScalarMatrixheatTransfer (const volScalarField &T)=0
 
virtual tmp< fvScalarMatrixvolTransfer (const volScalarField &p)=0
 
virtual void alphaTransfer (SuSpTable &Su, SuSpTable &Sp)=0
 
virtual void massSpeciesTransfer (const phaseModel &phase, volScalarField::Internal &Su, volScalarField::Internal &Sp, const word speciesName)=0
 
virtual bool includeVolChange ()=0
 
virtual void solve ()=0
 
virtual void correct ()
 
virtual void correctMassSources (const volScalarField &T)=0
 
virtual word thermoName () const
 
virtual void correctTurbulence ()
 
virtual bool read ()
 
const phasePairTabletotalPhasePairs () const
 
phasePairTabletotalPhasePairs ()
 
const phaseModelTablephases () const
 
phaseModelTablephases ()
 
template<class modelType >
const modelType & lookupSubModel (const phasePair &key) const
 
template<class modelType >
const modelType & lookupSubModel (const phaseModel &from, const phaseModel &to) const
 
virtual bool incompressible () const
 
virtual bool incompressible (const word) const
 
virtual bool isochoric () const
 
const fvMeshmesh () const
 
tmp< surfaceVectorFieldnHatfv (const volScalarField &alpha1, const volScalarField &alpha2) const
 
tmp< surfaceScalarFieldnHatf (const volScalarField &alpha1, const volScalarField &alpha2) const
 
tmp< volScalarFieldK (const volScalarField &alpha1, const volScalarField &alpha2) const
 
tmp< volScalarFieldnearInterface (const volScalarField &alpha1, const volScalarField &alpha2) const
 
tmp< volScalarFieldnearInterface () const
 
 TypeName ("phaseSystem")
 
 phaseSystem (const fvMesh &mesh)
 
virtual ~phaseSystem ()
 
const fvMeshmesh () const
 
const phaseModelListphases () const
 
phaseModelListphases ()
 
const phaseModelPartialListmovingPhases () const
 
phaseModelPartialListmovingPhases ()
 
const phaseModelPartialListstationaryPhases () const
 
phaseModelPartialListstationaryPhases ()
 
const phaseModelPartialListanisothermalPhases () const
 
phaseModelPartialListanisothermalPhases ()
 
const phaseModelPartialListmultiComponentPhases () const
 
phaseModelPartialListmultiComponentPhases ()
 
const phasePairTablephasePairs () const
 
const surfaceScalarFieldphi () const
 
surfaceScalarFieldphi ()
 
const volScalarFielddpdt () const
 
volScalarFielddpdt ()
 
const IOMRFZoneListMRF () const
 
fv::optionsfvOptions () const
 
template<class modelType >
bool foundSubModel (const phasePair &key) const
 
template<class modelType >
const modelType & lookupSubModel (const phasePair &key) const
 
template<class modelType >
bool foundSubModel (const phaseModel &dispersed, const phaseModel &continuous) const
 
template<class modelType >
const modelType & lookupSubModel (const phaseModel &dispersed, const phaseModel &continuous) const
 
template<class modelType >
bool foundBlendedSubModel (const phasePair &key) const
 
template<class modelType >
const BlendedInterfacialModel< modelType > & lookupBlendedSubModel (const phasePair &key) const
 
template<class Type , template< class > class PatchField, class GeoMesh >
void fillFields (const word &name, const dimensionSet &dims, PtrList< GeometricField< Type, PatchField, GeoMesh >> &fieldList) const
 
template<class Type , template< class > class PatchField, class GeoMesh >
void fillFields (const word &name, const dimensionSet &dims, HashPtrTable< GeometricField< Type, PatchField, GeoMesh >> &fieldTable) const
 
tmp< volScalarFieldrho () const
 
tmp< volVectorFieldU () const
 
tmp< volScalarFieldE (const phasePairKey &key) const
 
tmp< volScalarFieldsigma (const phasePairKey &key) const
 
virtual tmp< volScalarFielddmdt (const phasePairKey &key) const
 
virtual PtrList< volScalarFielddmdts () const
 
virtual autoPtr< momentumTransferTablemomentumTransfer ()=0
 
virtual autoPtr< momentumTransferTablemomentumTransferf ()=0
 
virtual PtrList< surfaceScalarFieldAFfs () const =0
 
virtual PtrList< surfaceScalarFieldphiFs (const PtrList< volScalarField > &rAUs)=0
 
virtual PtrList< surfaceScalarFieldphiFfs (const PtrList< surfaceScalarField > &rAUfs)=0
 
virtual PtrList< surfaceScalarFieldphiKdPhis (const PtrList< volScalarField > &rAUs) const =0
 
virtual PtrList< surfaceScalarFieldphiKdPhifs (const PtrList< surfaceScalarField > &rAUfs) const =0
 
virtual PtrList< volVectorFieldKdUByAs (const PtrList< volScalarField > &rAUs) const =0
 
virtual void partialElimination (const PtrList< volScalarField > &rAUs)=0
 
virtual void partialEliminationf (const PtrList< surfaceScalarField > &rAUfs)=0
 
virtual PtrList< surfaceScalarFieldddtCorrByAs (const PtrList< volScalarField > &rAUs, const bool includeVirtualMass=false) const =0
 
virtual const HashPtrTable< surfaceScalarField > & DByAfs () const =0
 
virtual autoPtr< heatTransferTableheatTransfer () const =0
 
virtual autoPtr< massTransferTablemassTransfer () const =0
 
virtual void solve ()
 
virtual void correct ()
 
virtual void correctKinematics ()
 
virtual void correctThermo ()
 
virtual void correctTurbulence ()
 
virtual void correctEnergyTransport ()
 
virtual bool read ()
 
template<class modelType >
const Foam::BlendedInterfacialModel< modelType > & lookupBlendedSubModel (const phasePair &key) const
 
- Public Member Functions inherited from basicThermo
 TypeName ("basicThermo")
 
 declareRunTimeSelectionTable (autoPtr, basicThermo, fvMesh,(const fvMesh &mesh, const word &phaseName),(mesh, phaseName))
 
 declareRunTimeSelectionTable (autoPtr, basicThermo, fvMeshDictPhase,(const fvMesh &mesh, const word &phaseName, const word &dictName),(mesh, phaseName, dictName))
 
 basicThermo (const fvMesh &, const word &phaseName)
 
 basicThermo (const fvMesh &, const dictionary &, const word &phaseName)
 
 basicThermo (const fvMesh &, const word &phaseName, const word &dictionaryName)
 
virtual ~basicThermo ()
 
word phasePropertyName (const word &name) const
 
void validate (const string &app, const word &) const
 
void validate (const string &app, const word &, const word &) const
 
void validate (const string &app, const word &, const word &, const word &) const
 
void validate (const string &app, const word &, const word &, const word &, const word &) const
 
bool dpdt () const noexcept
 
bool updateT () const noexcept
 
virtual volScalarFieldp ()
 
virtual const volScalarFieldp () const
 
virtual const volScalarFieldT () const
 
virtual volScalarFieldT ()
 
virtual const volScalarFieldalpha () const
 
virtual const scalarFieldalpha (const label patchi) const
 
template<class Thermo >
Foam::autoPtr< Thermo > New (const fvMesh &mesh, const word &phaseName)
 
template<class Thermo >
Foam::autoPtr< Thermo > New (const fvMesh &mesh, const dictionary &dict, const word &phaseName)
 
template<class Thermo >
Foam::autoPtr< Thermo > New (const fvMesh &mesh, const word &phaseName, const word &dictName)
 
- 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)
 
- Public Member Functions inherited from compressibleTransportModel
 TypeName ("compressibleTransportModel")
 
 compressibleTransportModel ()
 
virtual ~compressibleTransportModel ()
 

Static Public Attributes

static const word phasePropertiesName
 
static const word propertiesName
 
- Static Public Attributes inherited from basicThermo
static const word dictName
 
- 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
 

Protected Types

typedef HashTable< dictionary, phasePairKey, phasePairKey::hashdictTable
 
typedef HashTable< autoPtr< multiphaseInter::surfaceTensionModel >, phasePairKey, phasePairKey::hashsurfaceTensionModelTable
 
typedef HashTable< autoPtr< porousModel >, phasePairKey, phasePairKey::hashinterfacePorousModelTable
 
typedef HashTable< dictionary, phasePairKey, phasePairKey::hashdictTable
 
typedef HashTable< autoPtr< blendingMethod > > blendingMethodTable
 
typedef HashTable< autoPtr< surfaceTensionModel >, phasePairKey, phasePairKey::hashsurfaceTensionModelTable
 
typedef HashTable< autoPtr< aspectRatioModel >, phasePairKey, phasePairKey::hashaspectRatioModelTable
 

Protected Member Functions

void calcMu ()
 
HashTable< autoPtr< phaseModel > > generatePhaseModels (const wordList &names) const
 
tmp< surfaceScalarFieldgeneratePhi (const HashTable< autoPtr< phaseModel >> &phaseModels) const
 
void generatePairs (const dictTable &modelDicts)
 
void generatePairsTable ()
 
template<class modelType >
void createSubModels (const dictTable &modelDicts, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models)
 
template<class modelType >
void createSubModels (const dictTable &modelDicts, const fvMesh &mesh, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models)
 
template<class modelType >
void generatePairsAndSubModels (const word &modelName, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models)
 
template<class modelType >
void generatePairsAndSubModels (const word &modelName, const fvMesh &mesh, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models)
 
template<class modelType >
void generatePairsAndSubModels (const word &modelName, HashTable< HashTable< autoPtr< modelType >>, phasePairKey, phasePairKey::hash > &models)
 
tmp< surfaceScalarFieldcalcPhi (const phaseModelList &phaseModels) const
 
void generatePairs (const dictTable &modelDicts)
 
template<class modelType >
void createSubModels (const dictTable &modelDicts, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models)
 
template<class modelType >
void generatePairsAndSubModels (const word &modelName, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models)
 
template<class modelType >
void generatePairsAndSubModels (const word &modelName, HashTable< autoPtr< BlendedInterfacialModel< modelType >>, phasePairKey, phasePairKey::hash > &models, const bool correctFixedFluxBCs=true)
 
template<class modelType >
void generatePairsAndSubModels (const word &modelName, HashTable< Pair< autoPtr< modelType >>, phasePairKey, phasePairKey::hash > &models, const bool correctFixedFluxBCs=true)
 
template<class GeoField >
void addField (const phaseModel &phase, const word &fieldName, tmp< GeoField > field, PtrList< GeoField > &fieldList) const
 
template<class GeoField >
void addField (const phaseModel &phase, const word &fieldName, const GeoField &field, PtrList< GeoField > &fieldList) const
 
template<class GeoField >
void addField (const phaseModel &phase, const word &fieldName, tmp< GeoField > field, HashPtrTable< GeoField > &fieldTable) const
 
template<class GeoField >
void addField (const phaseModel &phase, const word &fieldName, const GeoField &field, HashPtrTable< GeoField > &fieldTable) const
 
- Protected Member Functions inherited from basicThermo
wordList heBoundaryTypes ()
 
wordList heBoundaryBaseTypes ()
 
 basicThermo (const basicThermo &)=delete
 
- 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 fvMeshmesh_
 
volScalarField mu_
 
wordList phaseNames_
 
surfaceScalarField phi_
 
surfaceScalarField rhoPhi_
 
phaseModelTable phaseModels_
 
phasePairTable phasePairs_
 
phasePairTable totalPhasePairs_
 
dimensionedScalar Prt_
 
surfaceTensionModelTable surfaceTensionModels_
 
interfacePorousModelTable interfacePorousModelTable_
 
phaseModelList phaseModels_
 
phaseModelPartialList movingPhaseModels_
 
phaseModelPartialList stationaryPhaseModels_
 
phaseModelPartialList anisothermalPhaseModels_
 
phaseModelPartialList multiComponentPhaseModels_
 
volScalarField dpdt_
 
IOMRFZoneList MRF_
 
blendingMethodTable blendingMethods_
 
aspectRatioModelTable aspectRatioModels_
 
- Protected Attributes inherited from basicThermo
const wordphaseName_
 
bool pOwner_
 
bool TOwner_
 
bool dpdt_
 
volScalarFieldp_
 
volScalarFieldT_
 
volScalarField alpha_
 

Additional Inherited Members

- Static Public Member Functions inherited from basicThermo
template<class Thermo >
static autoPtr< Thermo > New (const fvMesh &, const word &phaseName=word::null)
 
template<class Thermo >
static autoPtr< Thermo > New (const fvMesh &, const dictionary &, const word &phaseName=word::null)
 
template<class Thermo >
static autoPtr< Thermo > New (const fvMesh &, const word &phaseName, const word &dictName)
 
static autoPtr< basicThermoNew (const fvMesh &, const word &phaseName=word::null)
 
static word phasePropertyName (const word &name, const word &phaseName)
 
static const basicThermolookupThermo (const fvPatchScalarField &pf)
 
static OstreamprintThermoNames (Ostream &os, const wordList &cmptNames, const wordList &thermoNames)
 
static wordList splitThermoName (const std::string &thermoName, const int nExpectedCmpts)
 
- 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 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

Class to represent a system of phases and model interfacial transfers between them.

Source files

Source files

Definition at line 62 of file phaseSystem.H.

Member Typedef Documentation

◆ phasePairTable [1/2]

Definition at line 76 of file phaseSystem.H.

◆ phaseModelTable

Definition at line 79 of file phaseSystem.H.

◆ SuSpTable

Definition at line 82 of file phaseSystem.H.

◆ dictTable [1/2]

Definition at line 90 of file phaseSystem.H.

◆ surfaceTensionModelTable [1/2]

Definition at line 100 of file phaseSystem.H.

◆ interfacePorousModelTable

Definition at line 110 of file phaseSystem.H.

◆ momentumTransferTable

Definition at line 73 of file phaseSystem.H.

◆ heatTransferTable

Definition at line 75 of file phaseSystem.H.

◆ massTransferTable

Definition at line 77 of file phaseSystem.H.

◆ phaseModelList

Definition at line 79 of file phaseSystem.H.

◆ phaseModelPartialList

Definition at line 81 of file phaseSystem.H.

◆ phasePairTable [2/2]

Definition at line 85 of file phaseSystem.H.

◆ dictTable [2/2]

Definition at line 94 of file phaseSystem.H.

◆ blendingMethodTable

Definition at line 97 of file phaseSystem.H.

◆ surfaceTensionModelTable [2/2]

Definition at line 106 of file phaseSystem.H.

◆ aspectRatioModelTable

Definition at line 115 of file phaseSystem.H.

Constructor & Destructor Documentation

◆ phaseSystem() [1/2]

phaseSystem ( const fvMesh mesh)

Definition at line 198 of file phaseSystem.C.

References found.

◆ ~phaseSystem() [1/2]

~phaseSystem ( )
virtual

Definition at line 284 of file phaseSystem.C.

◆ phaseSystem() [2/2]

phaseSystem ( const fvMesh mesh)

◆ ~phaseSystem() [2/2]

virtual ~phaseSystem ( )
virtual

Member Function Documentation

◆ calcMu()

void calcMu ( )
protected

Definition at line 51 of file phaseSystem.C.

References phaseSystem::mu(), and phaseSystem::mu_.

Here is the call graph for this function:

◆ generatePhaseModels()

Foam::phaseSystem::phaseModelTable generatePhaseModels ( const wordList names) const
protected

Definition at line 58 of file phaseSystem.C.

References HashTable::insert(), and phaseModel::New().

Here is the call graph for this function:

◆ generatePhi()

Foam::tmp< Foam::surfaceScalarField > generatePhi ( const HashTable< autoPtr< phaseModel >> &  phaseModels) const
protected

Definition at line 80 of file phaseSystem.C.

References HashTable::cbegin(), HashTable::cend(), Foam::fvc::interpolate(), tmp::New(), and phi.

Here is the call graph for this function:

◆ generatePairs() [1/2]

void generatePairs ( const dictTable modelDicts)
protected

Definition at line 101 of file phaseSystem.C.

References forAllConstIters(), and Foam::glTF::key().

Here is the call graph for this function:

◆ generatePairsTable()

void generatePairsTable ( )
protected

Definition at line 148 of file phaseSystem.C.

References forAllConstIters(), Foam::glTF::key(), and Foam::name().

Here is the call graph for this function:

◆ createSubModels() [1/3]

void createSubModels ( const dictTable modelDicts,
HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &  models 
)
protected

Definition at line 25 of file phaseSystemTemplates.H.

References forAllConstIters(), Foam::glTF::key(), and Foam::New().

Here is the call graph for this function:

◆ createSubModels() [2/3]

void createSubModels ( const dictTable modelDicts,
const fvMesh mesh,
HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &  models 
)
protected

Definition at line 54 of file phaseSystemTemplates.H.

References forAllConstIters(), Foam::glTF::key(), mesh, and Foam::New().

Here is the call graph for this function:

◆ generatePairsAndSubModels() [1/6]

void generatePairsAndSubModels ( const word modelName,
HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &  models 
)
protected

Definition at line 84 of file phaseSystemTemplates.H.

◆ generatePairsAndSubModels() [2/6]

void generatePairsAndSubModels ( const word modelName,
const fvMesh mesh,
HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &  models 
)
protected

Definition at line 104 of file phaseSystemTemplates.H.

References mesh.

◆ generatePairsAndSubModels() [3/6]

void generatePairsAndSubModels ( const word modelName,
HashTable< HashTable< autoPtr< modelType >>, phasePairKey, phasePairKey::hash > &  models 
)
protected

Definition at line 125 of file phaseSystemTemplates.H.

References forAllConstIters(), and Foam::glTF::key().

Here is the call graph for this function:

◆ TypeName() [1/2]

TypeName ( "phaseSystem"  )

◆ he() [1/5]

virtual volScalarField& he ( )
inlinevirtual

Implements basicThermo.

Definition at line 270 of file phaseSystem.H.

References NotImplemented, and GeometricField::null().

Here is the call graph for this function:

◆ he() [2/5]

virtual const volScalarField& he ( ) const
inlinevirtual

Implements basicThermo.

Definition at line 278 of file phaseSystem.H.

References NotImplemented, and GeometricField::null().

Here is the call graph for this function:

◆ he() [3/5]

Foam::tmp< Foam::volScalarField > he ( const volScalarField p,
const volScalarField T 
) const
virtual

Implements basicThermo.

Definition at line 291 of file phaseSystem.C.

References NotImplemented.

◆ he() [4/5]

Foam::tmp< Foam::scalarField > he ( const scalarField p,
const scalarField T,
const labelList cells 
) const
virtual

Implements basicThermo.

Definition at line 302 of file phaseSystem.C.

References NotImplemented.

◆ he() [5/5]

Foam::tmp< Foam::scalarField > he ( const scalarField p,
const scalarField T,
const label  patchi 
) const
virtual

Implements basicThermo.

Definition at line 314 of file phaseSystem.C.

References NotImplemented.

◆ hc()

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

Implements basicThermo.

Definition at line 325 of file phaseSystem.C.

References tmp::ref().

Here is the call graph for this function:

◆ THE() [1/2]

Foam::tmp< Foam::scalarField > THE ( const scalarField h,
const scalarField p,
const scalarField T0,
const labelList cells 
) const
virtual

Implements basicThermo.

Definition at line 344 of file phaseSystem.C.

References NotImplemented.

◆ THE() [2/2]

Foam::tmp< Foam::scalarField > THE ( const scalarField h,
const scalarField p,
const scalarField T0,
const label  patchi 
) const
virtual

Implements basicThermo.

Definition at line 357 of file phaseSystem.C.

References NotImplemented.

◆ rho() [1/3]

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

Implements basicThermo.

Reimplemented in twoPhaseSystem.

Definition at line 369 of file phaseSystem.C.

References tmp::ref(), and rho.

Here is the call graph for this function:

◆ rho() [2/3]

Foam::tmp< Foam::scalarField > rho ( const label  patchi) const
virtual

Implements basicThermo.

Definition at line 387 of file phaseSystem.C.

References tmp::ref(), and rho.

Here is the call graph for this function:

◆ Cp() [1/3]

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

Implements basicThermo.

Definition at line 410 of file phaseSystem.C.

References Cp, and tmp::ref().

Here is the call graph for this function:

◆ Cp() [2/3]

Foam::tmp< Foam::scalarField > Cp ( const scalarField p,
const scalarField T,
const label  patchi 
) const
virtual

Implements basicThermo.

Definition at line 429 of file phaseSystem.C.

References Cp, p, tmp::ref(), and Foam::T().

Here is the call graph for this function:

◆ Cp() [3/3]

virtual tmp<scalarField> Cp ( const scalarField p,
const scalarField T,
const labelList cells 
) const
inlinevirtual

Implements basicThermo.

Definition at line 351 of file phaseSystem.H.

References tmp::New(), NotImplemented, and basicThermo::p().

Here is the call graph for this function:

◆ Cv() [1/2]

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

Implements basicThermo.

Definition at line 451 of file phaseSystem.C.

References Cv, and tmp::ref().

Here is the call graph for this function:

◆ Cv() [2/2]

Foam::tmp< Foam::scalarField > Cv ( const scalarField p,
const scalarField T,
const label  patchI 
) const
virtual

Implements basicThermo.

Definition at line 470 of file phaseSystem.C.

References Cv, p, tmp::ref(), and Foam::T().

Here is the call graph for this function:

◆ rhoEoS()

Foam::tmp< Foam::scalarField > rhoEoS ( const scalarField p,
const scalarField T,
const labelList cells 
) const
virtual

Implements basicThermo.

Definition at line 493 of file phaseSystem.C.

References NotImplemented.

◆ gamma() [1/2]

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

Implements basicThermo.

Definition at line 504 of file phaseSystem.C.

References Cp, Cv, and tmp::ref().

Here is the call graph for this function:

◆ gamma() [2/2]

Foam::tmp< Foam::scalarField > gamma ( const scalarField p,
const scalarField T,
const label  patchi 
) const
virtual

Implements basicThermo.

Definition at line 529 of file phaseSystem.C.

References gamma.

◆ Cpv() [1/2]

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

Implements basicThermo.

Definition at line 542 of file phaseSystem.C.

References tmp::ref().

Here is the call graph for this function:

◆ Cpv() [2/2]

Foam::tmp< Foam::scalarField > Cpv ( const scalarField p,
const scalarField T,
const label  patchi 
) const
virtual

Implements basicThermo.

Definition at line 561 of file phaseSystem.C.

References p, tmp::ref(), and Foam::T().

Here is the call graph for this function:

◆ CpByCpv() [1/2]

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

Implements basicThermo.

Definition at line 583 of file phaseSystem.C.

References tmp::ref().

Here is the call graph for this function:

◆ CpByCpv() [2/2]

Foam::tmp< Foam::scalarField > CpByCpv ( const scalarField p,
const scalarField T,
const label  patchi 
) const
virtual

Implements basicThermo.

Definition at line 602 of file phaseSystem.C.

References p, tmp::ref(), and Foam::T().

Here is the call graph for this function:

◆ W()

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

Implements basicThermo.

Definition at line 629 of file phaseSystem.C.

References NotImplemented.

◆ kappa() [1/2]

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

Implements basicThermo.

Definition at line 636 of file phaseSystem.C.

References Foam::constant::electromagnetic::kappa, and tmp::ref().

Here is the call graph for this function:

◆ kappa() [2/2]

Foam::tmp< Foam::scalarField > kappa ( const label  patchi) const
virtual

Implements basicThermo.

Definition at line 654 of file phaseSystem.C.

References Foam::constant::electromagnetic::kappa, and tmp::ref().

Here is the call graph for this function:

◆ alphahe() [1/2]

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

Implements basicThermo.

Definition at line 677 of file phaseSystem.C.

References tmp::ref().

Here is the call graph for this function:

◆ alphahe() [2/2]

Foam::tmp< Foam::scalarField > alphahe ( const label  patchi) const
virtual

Implements basicThermo.

Definition at line 696 of file phaseSystem.C.

References tmp::ref().

Here is the call graph for this function:

◆ kappaEff() [1/2]

Foam::tmp< Foam::volScalarField > kappaEff ( const volScalarField kappat) const
virtual

Implements basicThermo.

Definition at line 720 of file phaseSystem.C.

References Foam::constant::electromagnetic::kappa, and kappaEff.

◆ kappaEff() [2/2]

Foam::tmp< Foam::scalarField > kappaEff ( const scalarField alphat,
const label  patchi 
) const
virtual

Implements basicThermo.

Definition at line 731 of file phaseSystem.C.

References Foam::constant::electromagnetic::kappa.

◆ alphaEff() [1/2]

Foam::tmp< Foam::volScalarField > alphaEff ( const volScalarField alphat) const
virtual

Implements basicThermo.

Definition at line 741 of file phaseSystem.C.

References Foam::constant::atomic::alpha, and tmp::ref().

Here is the call graph for this function:

◆ alphaEff() [2/2]

Foam::tmp< Foam::scalarField > alphaEff ( const scalarField alphat,
const label  patchi 
) const
virtual

Implements basicThermo.

Definition at line 764 of file phaseSystem.C.

References Foam::constant::atomic::alpha, and tmp::ref().

Here is the call graph for this function:

◆ Prt()

const Foam::dimensionedScalar & Prt ( ) const

Definition at line 792 of file phaseSystem.C.

◆ mu() [1/2]

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

Implements compressibleTransportModel.

Definition at line 798 of file phaseSystem.C.

References Foam::constant::physicoChemical::mu, and tmp::ref().

Referenced by phaseSystem::calcMu().

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

◆ mu() [2/2]

Foam::tmp< Foam::scalarField > mu ( const label  patchi) const
virtual

Implements compressibleTransportModel.

Definition at line 816 of file phaseSystem.C.

References Foam::constant::physicoChemical::mu, and tmp::ref().

Here is the call graph for this function:

◆ nu() [1/2]

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

Implements compressibleTransportModel.

Definition at line 839 of file phaseSystem.C.

References nu, and tmp::ref().

Here is the call graph for this function:

◆ nu() [2/2]

Foam::tmp< Foam::scalarField > nu ( const label  patchi) const
virtual

Implements compressibleTransportModel.

Definition at line 857 of file phaseSystem.C.

References nu, and tmp::ref().

Here is the call graph for this function:

◆ phi() [1/4]

Foam::surfaceScalarField & phi ( ) const
inline

Definition at line 880 of file phaseSystem.C.

◆ phi() [2/4]

◆ rhoPhi() [1/2]

Foam::surfaceScalarField & rhoPhi ( ) const

Definition at line 892 of file phaseSystem.C.

◆ rhoPhi() [2/2]

surfaceScalarField& rhoPhi ( )

◆ U() [1/2]

Definition at line 1040 of file phaseSystem.C.

References Foam::dimVelocity, forAllConstIters(), tmp::New(), and Foam::Zero.

Here is the call graph for this function:

◆ surfaceTensionForce()

Foam::tmp< Foam::surfaceScalarField > surfaceTensionForce ( ) const

Definition at line 990 of file phaseSystem.C.

References alpha1, alpha2, forAllConstIters(), Foam::fvc::interpolate(), Foam::name(), tmp::New(), Foam::fvc::snGrad(), and Foam::Zero.

Here is the call graph for this function:

◆ surfaceTensionCoeff()

Foam::tmp< Foam::volScalarField > surfaceTensionCoeff ( const phasePairKey key) const
virtual

Definition at line 1066 of file phaseSystem.C.

References Foam::glTF::key().

Here is the call graph for this function:

◆ coeffs()

Foam::tmp< Foam::volScalarField > coeffs ( const word key) const
virtual

Definition at line 1073 of file phaseSystem.C.

References Foam::glTF::key().

Here is the call graph for this function:

◆ addInterfacePorosity()

void addInterfacePorosity ( fvVectorMatrix UEqn)

Definition at line 1081 of file phaseSystem.C.

References forAllConstIters(), phaseModel::name(), Foam::name(), phasei, and UEqn.

Here is the call graph for this function:

◆ dmdt() [1/2]

Foam::tmp< Foam::volScalarField > dmdt ( const phasePairKey key) const
pure virtual

Definition at line 331 of file phaseSystem.C.

References Foam::dimDensity, Foam::dimTime, IOobject::groupName(), Foam::glTF::key(), Foam::name(), and GeometricField::New().

Here is the call graph for this function:

◆ heatTransfer() [1/2]

virtual tmp<fvScalarMatrix> heatTransfer ( const volScalarField T)
pure virtual

◆ volTransfer()

virtual tmp<fvScalarMatrix> volTransfer ( const volScalarField p)
pure virtual

◆ alphaTransfer()

virtual void alphaTransfer ( SuSpTable Su,
SuSpTable Sp 
)
pure virtual

◆ massSpeciesTransfer()

virtual void massSpeciesTransfer ( const phaseModel phase,
volScalarField::Internal Su,
volScalarField::Internal Sp,
const word  speciesName 
)
pure virtual

◆ includeVolChange()

virtual bool includeVolChange ( )
pure virtual

◆ solve() [1/2]

void solve ( )
pure virtual

Implemented in twoPhaseSystem, and twoPhaseSystem.

Definition at line 352 of file phaseSystem.C.

◆ correct() [1/2]

void correct ( )
virtual

Implements basicThermo.

Reimplemented in twoPhaseSystem.

Definition at line 904 of file phaseSystem.C.

References forAllIters.

◆ correctMassSources()

virtual void correctMassSources ( const volScalarField T)
pure virtual

◆ thermoName()

virtual word thermoName ( ) const
inlinevirtual

Implements basicThermo.

Definition at line 567 of file phaseSystem.H.

References NotImplemented.

◆ correctTurbulence() [1/2]

void correctTurbulence ( )
virtual

Reimplemented in twoPhaseSystem.

Definition at line 915 of file phaseSystem.C.

References forAllIters.

◆ read() [1/2]

bool read ( )
virtual

Reimplemented from basicThermo.

Reimplemented in twoPhaseSystem.

Definition at line 1219 of file phaseSystem.C.

References regIOobject::read().

Here is the call graph for this function:

◆ totalPhasePairs() [1/2]

Foam::phaseSystem::phasePairTable & totalPhasePairs ( ) const

Definition at line 937 of file phaseSystem.C.

◆ totalPhasePairs() [2/2]

phasePairTable& totalPhasePairs ( )

◆ phases() [1/4]

Foam::phaseSystem::phaseModelList & phases ( ) const
inline

Definition at line 924 of file phaseSystem.C.

Referenced by deposition::dmdt().

Here is the caller graph for this function:

◆ phases() [2/4]

phaseModelTable& phases ( )

◆ lookupSubModel() [1/4]

const modelType & lookupSubModel ( const phasePair key) const

Definition at line 172 of file phaseSystemTemplates.H.

References IOobject::groupName(), Foam::glTF::key(), objectRegistry::lookupObject(), and phaseSystem::mesh().

Referenced by phasePair::sigma().

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

◆ lookupSubModel() [2/4]

const modelType & lookupSubModel ( const phaseModel from,
const phaseModel to 
) const

Definition at line 184 of file phaseSystemTemplates.H.

◆ incompressible() [1/2]

bool incompressible ( ) const
virtual

Implements basicThermo.

Definition at line 949 of file phaseSystem.C.

References forAllConstIters(), and thermo.

Here is the call graph for this function:

◆ incompressible() [2/2]

bool incompressible ( const word  phaseName) const
virtual

Definition at line 963 of file phaseSystem.C.

◆ isochoric()

bool isochoric ( ) const
virtual

Implements basicThermo.

Definition at line 969 of file phaseSystem.C.

References forAllConstIters(), and thermo.

Here is the call graph for this function:

◆ mesh() [1/2]

const Foam::fvMesh & mesh ( ) const
inline

Definition at line 983 of file phaseSystem.C.

Referenced by phaseSystem::lookupSubModel().

Here is the caller graph for this function:

◆ nHatfv()

Foam::tmp< Foam::surfaceVectorField > nHatfv ( const volScalarField alpha1,
const volScalarField alpha2 
) const

Definition at line 1185 of file phaseSystem.C.

References alpha1, alpha2, Foam::average(), Foam::cbrt(), Foam::constant::electromagnetic::e, Foam::fvc::grad(), Foam::fvc::interpolate(), and Foam::mag().

Here is the call graph for this function:

◆ nHatf()

Foam::tmp< Foam::surfaceScalarField > nHatf ( const volScalarField alpha1,
const volScalarField alpha2 
) const

Definition at line 1209 of file phaseSystem.C.

References alpha1, and alpha2.

◆ K()

Foam::tmp< Foam::volScalarField > K ( const volScalarField alpha1,
const volScalarField alpha2 
) const

Definition at line 1120 of file phaseSystem.C.

References alpha1, alpha2, Foam::fvc::div(), and tmp::ref().

Here is the call graph for this function:

◆ nearInterface() [1/2]

Foam::tmp< Foam::volScalarField > nearInterface ( const volScalarField alpha1,
const volScalarField alpha2 
) const

Definition at line 1133 of file phaseSystem.C.

References alpha1, alpha2, and Foam::pos().

Here is the call graph for this function:

◆ nearInterface() [2/2]

Foam::tmp< Foam::volScalarField > nearInterface ( ) const

Definition at line 1146 of file phaseSystem.C.

References alpha1, alpha2, Foam::dimless, forAllConstIters(), tmp::New(), Foam::pos(), and Foam::Zero.

Here is the call graph for this function:

◆ calcPhi()

Foam::tmp< Foam::surfaceScalarField > calcPhi ( const phaseModelList phaseModels) const
protected

Definition at line 45 of file phaseSystem.C.

References Foam::fac::interpolate(), Foam::New(), phasei, phi, and tmp::ref().

Here is the call graph for this function:

◆ generatePairs() [2/2]

void generatePairs ( const dictTable modelDicts)
protected

◆ createSubModels() [3/3]

void createSubModels ( const dictTable modelDicts,
HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &  models 
)
protected

◆ generatePairsAndSubModels() [4/6]

void generatePairsAndSubModels ( const word modelName,
HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &  models 
)
protected

◆ generatePairsAndSubModels() [5/6]

void generatePairsAndSubModels ( const word modelName,
HashTable< autoPtr< BlendedInterfacialModel< modelType >>, phasePairKey, phasePairKey::hash > &  models,
const bool  correctFixedFluxBCs = true 
)
protected

Definition at line 76 of file phaseSystemTemplates.C.

References forAllConstIter, and Foam::glTF::key().

Here is the call graph for this function:

◆ generatePairsAndSubModels() [6/6]

void generatePairsAndSubModels ( const word modelName,
HashTable< Pair< autoPtr< modelType >>, phasePairKey, phasePairKey::hash > &  models,
const bool  correctFixedFluxBCs = true 
)
protected

◆ addField() [1/4]

void addField ( const phaseModel phase,
const word fieldName,
tmp< GeoField >  field,
PtrList< GeoField > &  fieldList 
) const
protected

Definition at line 216 of file phaseSystemTemplates.C.

References field(), IOobject::groupName(), phase::name(), and PtrList::set().

Here is the call graph for this function:

◆ addField() [2/4]

void addField ( const phaseModel phase,
const word fieldName,
const GeoField &  field,
PtrList< GeoField > &  fieldList 
) const
protected

Definition at line 244 of file phaseSystemTemplates.C.

References field().

Here is the call graph for this function:

◆ addField() [3/4]

void addField ( const phaseModel phase,
const word fieldName,
tmp< GeoField >  field,
HashPtrTable< GeoField > &  fieldTable 
) const
protected

Definition at line 257 of file phaseSystemTemplates.C.

References field(), IOobject::groupName(), phase::name(), and HashPtrTable::set().

Here is the call graph for this function:

◆ addField() [4/4]

void addField ( const phaseModel phase,
const word fieldName,
const GeoField &  field,
HashPtrTable< GeoField > &  fieldTable 
) const
protected

Definition at line 285 of file phaseSystemTemplates.C.

References field().

Here is the call graph for this function:

◆ TypeName() [2/2]

TypeName ( "phaseSystem"  )

◆ mesh() [2/2]

const fvMesh& mesh ( ) const
inline

◆ phases() [3/4]

const phaseModelList& phases ( ) const
inline

◆ phases() [4/4]

phaseModelList& phases ( )
inline

◆ movingPhases() [1/2]

Foam::phaseSystem::phaseModelPartialList & movingPhases ( ) const
inline

Definition at line 44 of file phaseSystemI.H.

◆ movingPhases() [2/2]

phaseModelPartialList& movingPhases ( )
inline

◆ stationaryPhases() [1/2]

Foam::phaseSystem::phaseModelPartialList & stationaryPhases ( ) const
inline

Definition at line 58 of file phaseSystemI.H.

◆ stationaryPhases() [2/2]

phaseModelPartialList& stationaryPhases ( )
inline

◆ anisothermalPhases() [1/2]

Foam::phaseSystem::phaseModelPartialList & anisothermalPhases ( ) const
inline

Definition at line 72 of file phaseSystemI.H.

◆ anisothermalPhases() [2/2]

phaseModelPartialList& anisothermalPhases ( )
inline

◆ multiComponentPhases() [1/2]

Foam::phaseSystem::phaseModelPartialList & multiComponentPhases ( ) const
inline

Definition at line 86 of file phaseSystemI.H.

◆ multiComponentPhases() [2/2]

phaseModelPartialList& multiComponentPhases ( )
inline

◆ phasePairs()

const Foam::phaseSystem::phasePairTable & phasePairs ( ) const
inline

Definition at line 100 of file phaseSystemI.H.

◆ phi() [3/4]

const surfaceScalarField& phi ( ) const
inline

◆ phi() [4/4]

surfaceScalarField& phi ( )
inline

◆ dpdt() [1/2]

Foam::volScalarField & dpdt ( ) const
inline

Definition at line 118 of file phaseSystemI.H.

◆ dpdt() [2/2]

volScalarField& dpdt ( )
inline

◆ MRF()

const Foam::IOMRFZoneList & MRF ( ) const
inline

Definition at line 130 of file phaseSystemI.H.

◆ fvOptions()

Foam::fv::options & fvOptions ( ) const
inline

Definition at line 136 of file phaseSystemI.H.

References options::New().

Here is the call graph for this function:

◆ foundSubModel() [1/2]

bool foundSubModel ( const phasePair key) const

Definition at line 371 of file phaseSystemTemplates.C.

References IOobject::groupName(), Foam::glTF::key(), mesh, and Foam::name().

Here is the call graph for this function:

◆ lookupSubModel() [3/4]

const modelType& lookupSubModel ( const phasePair key) const

◆ foundSubModel() [2/2]

bool foundSubModel ( const phaseModel dispersed,
const phaseModel continuous 
) const

Definition at line 430 of file phaseSystemTemplates.C.

◆ lookupSubModel() [4/4]

const modelType& lookupSubModel ( const phaseModel dispersed,
const phaseModel continuous 
) const

◆ foundBlendedSubModel()

bool foundBlendedSubModel ( const phasePair key) const

Definition at line 451 of file phaseSystemTemplates.C.

References IOobject::groupName(), Foam::glTF::key(), and mesh.

Here is the call graph for this function:

◆ lookupBlendedSubModel() [1/2]

const BlendedInterfacialModel<modelType>& lookupBlendedSubModel ( const phasePair key) const

Referenced by phaseForces::nonDragForce().

Here is the caller graph for this function:

◆ fillFields() [1/2]

void fillFields ( const word name,
const dimensionSet dims,
PtrList< GeometricField< Type, PatchField, GeoMesh >> &  fieldList 
) const

Definition at line 300 of file phaseSystemTemplates.C.

References forAll, IOobject::groupName(), phase::name(), Foam::name(), phasei, PtrList::set(), and Foam::Zero.

Here is the call graph for this function:

◆ fillFields() [2/2]

void fillFields ( const word name,
const dimensionSet dims,
HashPtrTable< GeometricField< Type, PatchField, GeoMesh >> &  fieldTable 
) const

Definition at line 336 of file phaseSystemTemplates.C.

References forAll, IOobject::groupName(), phase::name(), Foam::name(), phasei, HashPtrTable::set(), and Foam::Zero.

Here is the call graph for this function:

◆ rho() [3/3]

tmp<volScalarField> rho ( ) const
virtual

Implements basicThermo.

Reimplemented in twoPhaseSystem.

◆ U() [2/2]

tmp<volVectorField> U ( ) const

◆ E()

Foam::tmp< Foam::volScalarField > E ( const phasePairKey key) const

Definition at line 293 of file phaseSystem.C.

References Foam::dimless, Foam::glTF::key(), and GeometricField::New().

Referenced by orderedPhasePair::E().

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

◆ sigma()

Foam::tmp< Foam::volScalarField > sigma ( const phasePairKey key) const

Definition at line 312 of file phaseSystem.C.

References surfaceTensionModel::dimSigma, Foam::glTF::key(), and GeometricField::New().

Here is the call graph for this function:

◆ dmdt() [2/2]

virtual tmp<volScalarField> dmdt ( const phasePairKey key) const
virtual

◆ dmdts()

Foam::PtrList< Foam::volScalarField > dmdts ( ) const
virtual

Definition at line 344 of file phaseSystem.C.

◆ momentumTransfer()

virtual autoPtr<momentumTransferTable> momentumTransfer ( )
pure virtual

◆ momentumTransferf()

virtual autoPtr<momentumTransferTable> momentumTransferf ( )
pure virtual

◆ AFfs()

virtual PtrList<surfaceScalarField> AFfs ( ) const
pure virtual

◆ phiFs()

virtual PtrList<surfaceScalarField> phiFs ( const PtrList< volScalarField > &  rAUs)
pure virtual

◆ phiFfs()

virtual PtrList<surfaceScalarField> phiFfs ( const PtrList< surfaceScalarField > &  rAUfs)
pure virtual

◆ phiKdPhis()

virtual PtrList<surfaceScalarField> phiKdPhis ( const PtrList< volScalarField > &  rAUs) const
pure virtual

◆ phiKdPhifs()

virtual PtrList<surfaceScalarField> phiKdPhifs ( const PtrList< surfaceScalarField > &  rAUfs) const
pure virtual

◆ KdUByAs()

virtual PtrList<volVectorField> KdUByAs ( const PtrList< volScalarField > &  rAUs) const
pure virtual

◆ partialElimination()

virtual void partialElimination ( const PtrList< volScalarField > &  rAUs)
pure virtual

◆ partialEliminationf()

virtual void partialEliminationf ( const PtrList< surfaceScalarField > &  rAUfs)
pure virtual

◆ ddtCorrByAs()

virtual PtrList<surfaceScalarField> ddtCorrByAs ( const PtrList< volScalarField > &  rAUs,
const bool  includeVirtualMass = false 
) const
pure virtual

◆ DByAfs()

virtual const HashPtrTable<surfaceScalarField>& DByAfs ( ) const
pure virtual

◆ heatTransfer() [2/2]

virtual autoPtr<heatTransferTable> heatTransfer ( ) const
pure virtual

◆ massTransfer()

virtual autoPtr<massTransferTable> massTransfer ( ) const
pure virtual

◆ solve() [2/2]

virtual void solve ( )
virtual

Reimplemented in twoPhaseSystem, and twoPhaseSystem.

◆ correct() [2/2]

virtual void correct ( )
virtual

Implements basicThermo.

Reimplemented in twoPhaseSystem.

◆ correctKinematics()

void correctKinematics ( )
virtual

Definition at line 365 of file phaseSystem.C.

References Foam::fvc::ddt().

Here is the call graph for this function:

◆ correctThermo()

void correctThermo ( )
virtual

Definition at line 384 of file phaseSystem.C.

◆ correctTurbulence() [2/2]

virtual void correctTurbulence ( )
virtual

Reimplemented in twoPhaseSystem.

◆ correctEnergyTransport()

void correctEnergyTransport ( )
virtual

Definition at line 402 of file phaseSystem.C.

◆ read() [2/2]

virtual bool read ( )
virtual

Reimplemented from basicThermo.

Reimplemented in twoPhaseSystem.

◆ lookupBlendedSubModel() [2/2]

const Foam::BlendedInterfacialModel<modelType>& lookupBlendedSubModel ( const phasePair key) const

Definition at line 484 of file phaseSystemTemplates.C.

References IOobject::groupName(), Foam::glTF::key(), objectRegistry::lookupObject(), mesh, and Foam::name().

Here is the call graph for this function:

Member Data Documentation

◆ mesh_

const fvMesh & mesh_
protected

Definition at line 117 of file phaseSystem.H.

◆ mu_

volScalarField mu_
protected

Definition at line 120 of file phaseSystem.H.

Referenced by phaseSystem::calcMu().

◆ phaseNames_

wordList phaseNames_
protected

Definition at line 123 of file phaseSystem.H.

◆ phi_

surfaceScalarField phi_
protected

Definition at line 126 of file phaseSystem.H.

◆ rhoPhi_

surfaceScalarField rhoPhi_
protected

Definition at line 129 of file phaseSystem.H.

◆ phaseModels_ [1/2]

phaseModelTable phaseModels_
protected

Definition at line 132 of file phaseSystem.H.

◆ phasePairs_

phasePairTable phasePairs_
protected

Definition at line 135 of file phaseSystem.H.

◆ totalPhasePairs_

phasePairTable totalPhasePairs_
protected

Definition at line 138 of file phaseSystem.H.

◆ Prt_

dimensionedScalar Prt_
protected

Definition at line 141 of file phaseSystem.H.

◆ surfaceTensionModels_

surfaceTensionModelTable surfaceTensionModels_
protected

Definition at line 147 of file phaseSystem.H.

◆ interfacePorousModelTable_

interfacePorousModelTable interfacePorousModelTable_
protected

Definition at line 150 of file phaseSystem.H.

◆ phasePropertiesName

const Foam::word phasePropertiesName
static

Definition at line 253 of file phaseSystem.H.

◆ phaseModels_ [2/2]

phaseModelList phaseModels_
protected

Definition at line 124 of file phaseSystem.H.

◆ movingPhaseModels_

phaseModelPartialList movingPhaseModels_
protected

Definition at line 127 of file phaseSystem.H.

◆ stationaryPhaseModels_

phaseModelPartialList stationaryPhaseModels_
protected

Definition at line 130 of file phaseSystem.H.

◆ anisothermalPhaseModels_

phaseModelPartialList anisothermalPhaseModels_
protected

Definition at line 133 of file phaseSystem.H.

◆ multiComponentPhaseModels_

phaseModelPartialList multiComponentPhaseModels_
protected

Definition at line 136 of file phaseSystem.H.

◆ dpdt_

volScalarField dpdt_
protected

Definition at line 145 of file phaseSystem.H.

◆ MRF_

IOMRFZoneList MRF_
protected

Definition at line 148 of file phaseSystem.H.

◆ blendingMethods_

blendingMethodTable blendingMethods_
protected

Definition at line 151 of file phaseSystem.H.

◆ aspectRatioModels_

aspectRatioModelTable aspectRatioModels_
protected

Definition at line 160 of file phaseSystem.H.

◆ propertiesName

const Foam::word propertiesName
static

Definition at line 282 of file phaseSystem.H.


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