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

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

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

Public Member Functions

 TypeName ("kinematicSingleLayer")
 Runtime type information. More...
 
 kinematicSingleLayer (const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType, const bool readFields=true)
 Construct from components. More...
 
virtual ~kinematicSingleLayer ()
 Destructor. More...
 
virtual scalar CourantNumber () const
 Courant number evaluation. More...
 
const SwitchmomentumPredictor () const
 Return the momentum predictor. More...
 
label nOuterCorr () const
 Return the number of outer correctors. More...
 
label nCorr () const
 Return the number of PISO correctors. More...
 
label nNonOrthCorr () const
 Return the number of non-orthogonal correctors. More...
 
const dimensionedScalardeltaSmall () const
 Return small delta. More...
 
const volScalarFieldmu () const
 Return const access to the dynamic viscosity [Pa.s]. More...
 
const volScalarFieldsigma () const
 Return const access to the surface tension [kg/s2]. More...
 
const volScalarFielddelta () const
 Return const access to the film thickness [m]. More...
 
const volScalarFieldalpha () const
 Return the film coverage, 1 = covered, 0 = uncovered []. More...
 
virtual const volVectorFieldU () const
 Return the film velocity [m/s]. More...
 
virtual const volVectorFieldUs () const
 Return the film surface velocity [m/s]. More...
 
virtual const volVectorFieldUw () const
 Return the film wall velocity [m/s]. More...
 
virtual const volScalarFielddeltaRho () const
 Return the film thickness*density (helper field) [kg/m3]. More...
 
virtual const surfaceScalarFieldphi () const
 Return the film flux [kg.m/s]. More...
 
virtual const volScalarFieldrho () const
 Return the film density [kg/m3]. More...
 
virtual const volScalarFieldT () const
 Return the film mean temperature [K]. More...
 
virtual const volScalarFieldTs () const
 Return the film surface temperature [K]. More...
 
virtual const volScalarFieldTw () const
 Return the film wall temperature [K]. More...
 
virtual const volScalarFieldhs () const
 Return the film surface enthalpy [J/kg]. More...
 
virtual const volScalarFieldCp () const
 Return the film specific heat capacity [J/kg/K]. More...
 
virtual const volScalarFieldkappa () const
 Return the film thermal conductivity [W/m/K]. More...
 
virtual tmp< volScalarFieldprimaryMassTrans () const
 Return mass transfer source - Eulerian phase only. More...
 
virtual const volScalarFieldcloudMassTrans () const
 Return the film mass available for transfer to cloud. More...
 
virtual const volScalarFieldcloudDiameterTrans () const
 Return the parcel diameters originating from film to cloud. More...
 
virtual void addSources (const label patchi, const label facei, const scalar massSource, const vector &momentumSource, const scalar pressureSource, const scalar energySource=0)
 External hook to add sources to the film. More...
 
volVectorFieldUSpPrimary ()
 Momementum [kg/m/s2]. More...
 
volScalarFieldpSpPrimary ()
 Pressure [Pa]. More...
 
volScalarFieldrhoSpPrimary ()
 Mass [kg/m2/s]. More...
 
volVectorFieldUSp ()
 Momentum [kg/m/s2]. More...
 
volScalarFieldpSp ()
 Pressure [Pa]. More...
 
volScalarFieldrhoSp ()
 Mass [kg/m2/s]. More...
 
const volVectorFieldUSp () const
 Momentum [kg/m/s2]. More...
 
const volScalarFieldpSp () const
 Pressure [Pa]. More...
 
const volScalarFieldrhoSp () const
 Mass [kg/m2/s]. More...
 
const volVectorFieldUPrimary () const
 Velocity [m/s]. More...
 
const volScalarFieldpPrimary () const
 Pressure [Pa]. More...
 
const volScalarFieldrhoPrimary () const
 Density [kg/m3]. More...
 
const volScalarFieldmuPrimary () const
 Viscosity [Pa.s]. More...
 
const filmThermoModelfilmThermo () const
 Film thermo. More...
 
injectionModelListinjection ()
 Injection. More...
 
transferModelListtransfer ()
 Transfer. More...
 
const filmTurbulenceModelturbulence () const
 Turbulence. More...
 
tmp< volScalarFieldmass () const
 Return the current film mass. More...
 
tmp< volScalarFielddeltaMass () const
 Return the change in film mass due to sources/sinks. More...
 
tmp< volScalarFieldgNorm () const
 Return the gravity normal-to-patch component contribution. More...
 
tmp< volScalarFieldgNormClipped () const
 Return the gravity normal-to-patch component contribution. More...
 
tmp< volVectorFieldgTan () const
 Return the gravity tangential component contributions. More...
 
virtual void preEvolveRegion ()
 Pre-evolve film hook. More...
 
virtual void evolveRegion ()
 Evolve the film equations. More...
 
virtual tmp< volScalarField::InternalSrho () const
 Return total mass source - Eulerian phase only. More...
 
virtual tmp< volScalarField::InternalSrho (const label i) const
 Return mass source for specie i - Eulerian phase only. More...
 
virtual tmp< volScalarField::InternalSh () const
 Return enthalpy source - Eulerian phase only. More...
 
virtual void info ()
 Provide some feedback. More...
 
- Public Member Functions inherited from surfaceFilmRegionModel
 TypeName ("surfaceFilmRegionModel")
 Runtime type information. More...
 
 surfaceFilmRegionModel (const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType)
 Construct from type name, mesh and gravity vector. More...
 
virtual ~surfaceFilmRegionModel ()
 Destructor. More...
 
const dimensionedVectorg () const
 Return the accleration due to gravity. More...
 
virtual void evolve ()
 Main driver routing to evolve the region - calls other evolves. More...
 
- Public Member Functions inherited from surfaceFilmModel
 TypeName ("surfaceFilmModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, surfaceFilmModel, mesh,(const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType),(modelType, mesh, g, regionType))
 
 surfaceFilmModel ()
 Constructor. More...
 
virtual ~surfaceFilmModel ()
 Destructor. More...
 
- Public Member Functions inherited from singleLayerRegion
 TypeName ("regionModel")
 Runtime type information. More...
 
 singleLayerRegion (const fvMesh &mesh, const word &regionType)
 Construct null. More...
 
 singleLayerRegion (const fvMesh &mesh, const word &regionType, const word &modelName, bool readFields=true)
 Construct from mesh, region type and name. More...
 
virtual ~singleLayerRegion ()
 Destructor. More...
 
virtual const volVectorFieldnHat () const
 Return the patch normal vectors. More...
 
virtual const volScalarFieldmagSf () const
 Return the face area magnitudes / [m2]. More...
 
virtual const labelListpassivePatchIDs () const
 Return the list of patch IDs opposite to internally. More...
 
template<class Type >
wordList mappedFieldAndInternalPatchTypes () const
 Return boundary types for mapped field patches. More...
 
template<class Type >
wordList mappedPushedFieldPatchTypes () const
 Return boundary types for pushed mapped field patches. More...
 
template<class Type >
Foam::wordList mappedFieldAndInternalPatchTypes () const
 
template<class Type >
Foam::wordList mappedPushedFieldPatchTypes () const
 
- Public Member Functions inherited from regionModel
 TypeName ("regionModel")
 Runtime type information. More...
 
 regionModel (const fvMesh &mesh, const word &regionType)
 Construct null. More...
 
 regionModel (const fvMesh &mesh, const word &regionType, const word &modelName, bool readFields=true)
 Construct from mesh, region type and name. More...
 
 regionModel (const fvMesh &mesh, const word &regionType, const word &modelName, const dictionary &dict, bool readFields=true)
 Construct from mesh and name and dict. More...
 
virtual ~regionModel ()
 Destructor. More...
 
const fvMeshprimaryMesh () const
 Return the reference to the primary mesh database. More...
 
const Timetime () const
 Return the reference to the time database. More...
 
const Switchactive () const
 Return the active flag. More...
 
const SwitchinfoOutput () const
 Return the information flag. More...
 
const wordmodelName () const
 Return the model name. More...
 
const fvMeshregionMesh () const
 Return the region mesh database. More...
 
fvMeshregionMesh ()
 Return the region mesh database for manipulation. More...
 
const dictionarycoeffs () const
 Return the model coefficients dictionary. More...
 
const dictionarysolution () const
 Return the solution dictionary. More...
 
const IOdictionaryoutputProperties () const
 Return const access to the output properties dictionary. More...
 
IOdictionaryoutputProperties ()
 Return output properties dictionary. More...
 
bool isCoupledPatch (const label regionPatchi) const
 Return true if patchi on the local region is a coupled. More...
 
bool isRegionPatch (const label primaryPatchi) const
 Return true if patchi on the primary region is a coupled. More...
 
const labelListprimaryPatchIDs () const
 Return the list of patch IDs on the primary region coupled. More...
 
const labelListintCoupledPatchIDs () const
 Return the list of patch IDs internally coupled with the. More...
 
label regionPatchID (const label primaryPatchID) const
 Return region ID corresponding to primaryPatchID. More...
 
label nbrCoupledPatchID (const regionModel &nbrRegion, const label regionPatchi) const
 Return the coupled patch ID paired with coupled patch. More...
 
template<class Type >
tmp< Foam::Field< Type > > mapRegionPatchField (const regionModel &nbrRegion, const label regionPatchi, const label nbrPatchi, const Field< Type > &nbrField, const bool flip=false) const
 Map patch field from another region model to local patch. More...
 
template<class Type >
tmp< Field< Type > > mapRegionPatchField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchi, const bool flip=false) const
 Map patch field from another region model to local patch. More...
 
template<class Type >
tmp< Field< Type > > mapRegionPatchInternalField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchi, const bool flip=false) const
 Map patch internal field from another region model to local. More...
 
template<class Type >
void toPrimary (const label regionPatchi, List< Type > &regionField) const
 Convert a local region field to the primary region. More...
 
template<class Type >
void toRegion (const label regionPatchi, List< Type > &primaryFieldField) const
 Convert a primary region field to the local region. More...
 
template<class Type , class CombineOp >
void toPrimary (const label regionPatchi, List< Type > &regionField, const CombineOp &cop) const
 Convert a local region field to the primary region with op. More...
 
template<class Type , class CombineOp >
void toRegion (const label regionPatchi, List< Type > &primaryFieldField, const CombineOp &cop) const
 Convert a primary region field to the local region with op. More...
 
virtual void postEvolveRegion ()
 Post-evolve region. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > mapRegionPatchField (const regionModel &nbrRegion, const label regionPatchi, const label nbrPatchi, const Field< Type > &nbrField, const bool flip) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > mapRegionPatchField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchi, const bool flip) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > mapRegionPatchInternalField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchi, const bool flip) const
 
- Public Member Functions inherited from IOdictionary
 IOdictionary (const IOobject &)
 Construct given an IOobject. More...
 
 IOdictionary (const IOobject &, const dictionary &)
 Construct given an IOobject and dictionary. More...
 
 IOdictionary (const IOobject &, Istream &)
 Construct given an IOobject and Istream. More...
 
virtual ~IOdictionary ()
 Destructor. More...
 
virtual bool global () const
 Is object global. More...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. More...
 
- Public Member Functions inherited from baseIOdictionary
 TypeName ("dictionary")
 
 baseIOdictionary (const IOobject &)
 Construct given an IOobject. More...
 
 baseIOdictionary (const IOobject &, const dictionary &)
 Construct given an IOobject and dictionary. More...
 
 baseIOdictionary (const IOobject &, Istream &)
 Construct given an IOobject and Istream. More...
 
virtual ~baseIOdictionary ()
 Destructor. More...
 
const wordname () const
 Name function is needed to disambiguate those inherited. More...
 
virtual bool readData (Istream &)
 ReadData function required for regIOobject read operation. More...
 
virtual bool writeData (Ostream &) const
 WriteData function required for regIOobject write operation. More...
 
void operator= (const baseIOdictionary &)
 Assignment of other baseIOdictionary's entries to this. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Construct as copy. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Construct as copy with new name, transferring registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Construct as copy with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set up to date (obviously) More...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool valid=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual label addWatch (const fileName &)
 Add file watch for fileName on object if not yet watched. Return. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool valid) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool valid=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
bool & registerObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
bool & globalObject ()
 Is object same for all processors. More...
 
bool globalObject () const
 Is object same for all processors. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () const
 
fileName path () const
 Return complete path. More...
 
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName localFilePath (const word &typeName) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName) const
 Helper for filePath that searches up if in parallel. More...
 
bool readHeader (Istream &)
 Read header. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType=true)
 Read header (uses typeFilePath to find file) and check header. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 
 dictionary ()
 Construct top-level dictionary null. More...
 
 dictionary (const fileName &name)
 Construct top-level empty dictionary with given name. More...
 
 dictionary (const fileName &name, const dictionary &parentDict, Istream &)
 Construct given the entry name, parent dictionary and Istream,. More...
 
 dictionary (Istream &)
 Construct top-level dictionary from Istream,. More...
 
 dictionary (Istream &, const bool keepHeader)
 Construct top-level dictionary from Istream,. More...
 
 dictionary (const dictionary &parentDict, const dictionary &)
 Construct as copy given the parent dictionary. More...
 
 dictionary (const dictionary &)
 Construct top-level dictionary as copy. More...
 
 dictionary (const dictionary *)
 Construct top-level dictionary as copy from pointer to dictionary. More...
 
 dictionary (const dictionary &parentDict, const Xfer< dictionary > &)
 Construct by transferring parameter contents given parent dictionary. More...
 
 dictionary (const Xfer< dictionary > &)
 Construct top-level dictionary by transferring parameter contents. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const dictionaryparent () const
 Return the parent dictionary. More...
 
const dictionarytopDict () const
 Return the top of the tree. More...
 
label startLineNumber () const
 Return line number of first token in dictionary. More...
 
label endLineNumber () const
 Return line number of last token in dictionary. More...
 
SHA1Digest digest () const
 Return the SHA1 digest of the dictionary contents. More...
 
tokenList tokens () const
 Return the dictionary as a list of tokens. More...
 
bool found (const word &, bool recursive=false, bool patternMatch=true) const
 Search dictionary for given keyword. More...
 
const entrylookupEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
entrylookupEntryPtr (const word &, bool recursive, bool patternMatch)
 Find and return an entry data stream pointer for manipulation. More...
 
const entrylookupEntry (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present otherwise error. More...
 
ITstreamlookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return an entry data stream. More...
 
template<class T >
T lookupType (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. More...
 
template<class T >
T lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. More...
 
template<class T >
T lookupOrAddDefault (const word &, const T &, bool recursive=false, bool patternMatch=true)
 Find and return a T, if not found return the given. More...
 
template<class T >
bool readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const
 Find an entry if present, and assign to T. More...
 
const entrylookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
bool isDict (const word &) const
 Check if entry is a sub-dictionary. More...
 
const dictionarysubDictPtr (const word &) const
 Find and return a sub-dictionary pointer if present. More...
 
dictionarysubDictPtr (const word &)
 Find and return a sub-dictionary pointer if present. More...
 
const dictionarysubDict (const word &) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (const word &)
 Find and return a sub-dictionary for manipulation. More...
 
dictionary subOrEmptyDict (const word &, const bool mustRead=false) const
 Find and return a sub-dictionary as a copy, or. More...
 
const dictionaryoptionalSubDict (const word &) const
 Find and return a sub-dictionary if found. More...
 
wordList toc () const
 Return the table of contents. More...
 
wordList sortedToc () const
 Return the sorted table of contents. More...
 
List< keyTypekeys (bool patterns=false) const
 Return the list of available keys or patterns. More...
 
bool substituteKeyword (const word &keyword)
 Substitute the given keyword prepended by '$' with the. More...
 
bool substituteScopedKeyword (const word &keyword)
 Substitute the given scoped keyword prepended by '$' with the. More...
 
bool add (entry *, bool mergeEntry=false)
 Add a new entry. More...
 
void add (const entry &, bool mergeEntry=false)
 Add an entry. More...
 
void add (const keyType &, const word &, bool overwrite=false)
 Add a word entry. More...
 
void add (const keyType &, const string &, bool overwrite=false)
 Add a string entry. More...
 
void add (const keyType &, const label, bool overwrite=false)
 Add a label entry. More...
 
void add (const keyType &, const scalar, bool overwrite=false)
 Add a scalar entry. More...
 
void add (const keyType &, const dictionary &, bool mergeEntry=false)
 Add a dictionary entry. More...
 
template<class T >
void add (const keyType &, const T &, bool overwrite=false)
 Add a T entry. More...
 
void set (entry *)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const entry &)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const keyType &, const dictionary &)
 Assign a dictionary entry, overwrite any existing entry. More...
 
template<class T >
void set (const keyType &, const T &)
 Assign a T entry, overwrite any existing entry. More...
 
bool remove (const word &)
 Remove an entry specified by keyword. More...
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false)
 Change the keyword for an entry,. More...
 
bool merge (const dictionary &)
 Merge entries from the given dictionary. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (dictionary &)
 Transfer the contents of the argument and annul the argument. More...
 
Xfer< dictionaryxfer ()
 Transfer contents to the Xfer container. More...
 
bool read (Istream &)
 Read dictionary from Istream. More...
 
bool read (Istream &, const bool keepHeader)
 Read dictionary from Istream, optionally keeping the header. More...
 
void write (Ostream &, const bool subDict=true) const
 Write dictionary, normally with sub-dictionary formatting. More...
 
ITstreamoperator[] (const word &) const
 Find and return entry. More...
 
void operator= (const dictionary &)
 
void operator+= (const dictionary &)
 Include entries from the given dictionary. More...
 
void operator|= (const dictionary &)
 Conditionally include entries from the given dictionary. More...
 
void operator<<= (const dictionary &)
 Unconditionally include entries from the given dictionary. More...
 
- Public Member Functions inherited from dictionaryName
 dictionaryName ()
 Construct dictionaryName null. More...
 
 dictionaryName (const fileName &name)
 Construct dictionaryName as copy of the given fileName. More...
 
const fileNamename () const
 Return the dictionary name. More...
 
fileNamename ()
 Return the dictionary name. More...
 
const word dictName () const
 Return the local dictionary name (final part of scoped name) More...
 
- Public Member Functions inherited from ILList< LListBase, T >
 ILList ()
 Null construct. More...
 
 ILList (T *a)
 Construct given initial T. More...
 
 ILList (Istream &)
 Construct from Istream. More...
 
 ILList (const ILList< LListBase, T > &)
 Construct as copy. More...
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
template<class INew >
 ILList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 ~ILList ()
 Destructor. More...
 
bool eraseHead ()
 Remove the head element specified from the list and delete it. More...
 
bool erase (T *p)
 Remove the specified element from the list and delete it. More...
 
void clear ()
 Clear the contents of the list. More...
 
void transfer (ILList< LListBase, T > &)
 Transfer the contents of the argument into this List. More...
 
void operator= (const ILList< LListBase, T > &)
 Assignment operator. More...
 
- Public Member Functions inherited from UILList< LListBase, T >
 UILList ()
 Null construct. More...
 
 UILList (T *a)
 Construct given initial T. More...
 
 UILList (const UILList< LListBase, T > &)
 Construct as copy. More...
 
Tfirst ()
 Return the first entry. More...
 
const Tfirst () const
 Return the first entry. More...
 
Tlast ()
 Return the last entry. More...
 
const Tlast () const
 Return the last entry. More...
 
TremoveHead ()
 Remove and return head. More...
 
Tremove (T *p)
 Remove and return element. More...
 
Tremove (iterator &it)
 Remove and return specified by iterator. More...
 
void operator= (const UILList< LListBase, T > &)
 
iterator begin ()
 
const iteratorend ()
 
const_iterator cbegin () const
 
const const_iteratorcend () const
 
const_iterator begin () const
 
const const_iteratorend () const
 
const_reverse_iterator crbegin () const
 
const const_reverse_iteratorcrend () const
 
const_reverse_iterator rbegin () const
 
const const_reverse_iteratorrend () const
 
bool operator== (const UILList< LListBase, T > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UILList< LListBase, T > &) const
 The opposite of the equality operation. Takes linear time. More...
 

Protected Member Functions

virtual bool read ()
 Read control parameters from dictionary. More...
 
virtual void correctThermoFields ()
 Correct the thermo fields. More...
 
virtual void resetPrimaryRegionSourceTerms ()
 Reset source term fields. More...
 
virtual void transferPrimaryRegionThermoFields ()
 Transfer thermo fields from the primary region to the film region. More...
 
virtual void transferPrimaryRegionSourceFields ()
 Transfer source fields from the primary region to the film region. More...
 
virtual tmp< volScalarFieldpu ()
 Explicit pressure source contribution. More...
 
virtual tmp< volScalarFieldpp ()
 Implicit pressure source coefficient. More...
 
virtual void correctAlpha ()
 Correct film coverage field. More...
 
virtual void updateSubmodels ()
 Update the film sub-models. More...
 
virtual void continuityCheck ()
 Continuity check. More...
 
virtual void updateSurfaceVelocities ()
 Update film surface velocities. More...
 
template<class Type >
void constrainFilmField (Type &field, const typename Type::cmptType &value)
 Constrain a film region master/slave boundaries of a field to a. More...
 
virtual void solveContinuity ()
 Solve continuity equation. More...
 
virtual tmp< fvVectorMatrixsolveMomentum (const volScalarField &pu, const volScalarField &pp)
 Solve for film velocity. More...
 
virtual void solveThickness (const volScalarField &pu, const volScalarField &pp, const fvVectorMatrix &UEqn)
 Solve coupled velocity-thickness equations. More...
 
- Protected Member Functions inherited from regionModel
virtual bool read (const dictionary &dict)
 Read control parameters from dictionary. More...
 
virtual const AMIPatchToPatchInterpolationinterRegionAMI (const regionModel &nbrRegion, const label regionPatchi, const label nbrPatchi, const bool flip) const
 Create or return a new inter-region AMI object. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &)
 Set the object state to bad. More...
 

Protected Attributes

Switch momentumPredictor_
 Momentum predictor. More...
 
label nOuterCorr_
 Number of outer correctors. More...
 
label nCorr_
 Number of PISO-like correctors. More...
 
label nNonOrthCorr_
 Number of non-orthogonal correctors. More...
 
scalar cumulativeContErr_
 Cumulative continuity error. More...
 
const dimensionedScalar deltaSmall_
 Small delta. More...
 
scalar deltaCoLimit_
 Film thickness above which Courant number calculation in valid. More...
 
volScalarField rho_
 Density [kg/m3]. More...
 
volScalarField mu_
 Dynamic viscosity [Pa.s]. More...
 
volScalarField sigma_
 Surface tension [m/s2]. More...
 
volScalarField delta_
 Film thickness [m]. More...
 
volScalarField alpha_
 Film coverage indicator, 1 = covered, 0 = uncovered []. More...
 
volVectorField U_
 Velocity - mean [m/s]. More...
 
volVectorField Us_
 Velocity - surface [m/s]. More...
 
volVectorField Uw_
 Velocity - wall [m/s]. More...
 
volScalarField deltaRho_
 Film thickness*density (helper field) [kg/m2]. More...
 
surfaceScalarField phi_
 Mass flux (includes film thickness) [kg.m/s]. More...
 
volScalarField primaryMassTrans_
 Film mass available for transfer to the primary region. More...
 
volScalarField cloudMassTrans_
 Film mass available for transfer to cloud. More...
 
volScalarField cloudDiameterTrans_
 Parcel diameters originating from film to cloud. More...
 
volVectorField USp_
 Momementum [kg/m/s2]. More...
 
volScalarField pSp_
 Pressure [Pa]. More...
 
volScalarField rhoSp_
 Mass [kg/m2/s]. More...
 
volVectorField USpPrimary_
 Momementum [kg/m/s2]. More...
 
volScalarField pSpPrimary_
 Pressure [Pa]. More...
 
volScalarField rhoSpPrimary_
 Mass [kg/m2/s]. More...
 
volVectorField UPrimary_
 Velocity [m/s]. More...
 
volScalarField pPrimary_
 Pressure [Pa]. More...
 
volScalarField rhoPrimary_
 Density [kg/m3]. More...
 
volScalarField muPrimary_
 Viscosity [Pa.s]. More...
 
autoPtr< filmThermoModelfilmThermo_
 Film thermo model. More...
 
scalarField availableMass_
 Available mass for transfer via sub-models. More...
 
injectionModelList injection_
 Cloud injection. More...
 
transferModelList transfer_
 Transfer with the continuous phase. More...
 
autoPtr< filmTurbulenceModelturbulence_
 Turbulence model. More...
 
forceList forces_
 List of film forces. More...
 
scalar addedMassTotal_
 Cumulative mass added via sources [kg]. More...
 
- Protected Attributes inherited from surfaceFilmRegionModel
const dimensionedVectorg_
 Acceleration due to gravity [m/s2]. More...
 
- Protected Attributes inherited from singleLayerRegion
autoPtr< volVectorFieldnHatPtr_
 Patch normal vectors. More...
 
autoPtr< volScalarFieldmagSfPtr_
 Face area magnitudes / [m2]. More...
 
labelList passivePatchIDs_
 List of patch IDs opposite to internally coupled patches. More...
 
- Protected Attributes inherited from regionModel
const fvMeshprimaryMesh_
 Reference to the primary mesh database. More...
 
const Timetime_
 Reference to the time database. More...
 
Switch active_
 Active flag. More...
 
Switch infoOutput_
 Active information output. More...
 
const word modelName_
 Model name. More...
 
autoPtr< fvMeshregionMeshPtr_
 Pointer to the region mesh database. More...
 
dictionary coeffs_
 Model coefficients dictionary. More...
 
autoPtr< IOdictionaryoutputPropertiesPtr_
 Dictionary of output properties. More...
 
labelList primaryPatchIDs_
 List of patch IDs on the primary region coupled to this region. More...
 
labelList intCoupledPatchIDs_
 List of patch IDs internally coupled with the primary region. More...
 
word regionName_
 Region name. More...
 
regionModelFunctionObjectList functions_
 Region model function objects. More...
 
wordList interRegionAMINames_
 List of region names this region is coupled to. More...
 
PtrList< PtrList< AMIPatchToPatchInterpolation > > interRegionAMI_
 List of AMI objects per coupled region. More...
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Public Types inherited from UILList< LListBase, T >
typedef T value_type
 Type of values the DLList contains. More...
 
typedef Treference
 Type that can be used for storing into DLList::value_type. More...
 
typedef const Tconst_reference
 Type that can be used for storing into constant. More...
 
typedef label size_type
 The type that can represent the size of a DLList. More...
 
typedef LListBase::iterator LListBase_iterator
 
typedef LListBase::const_iterator LListBase_const_iterator
 
- Static Public Member Functions inherited from surfaceFilmModel
static autoPtr< surfaceFilmModelNew (const fvMesh &mesh, const dimensionedVector &g, const word &regionType="surfaceFilm")
 Return a reference to the selected surface film model. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from dictionary
static autoPtr< dictionaryNew (Istream &)
 Construct top-level dictionary on freestore from Istream. More...
 
- Static Public Attributes inherited from surfaceFilmModel
static const dimensionedScalar Tref
 Reference temperature for enthalpy. More...
 
- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
- Static Public Attributes inherited from dictionary
static const dictionary null
 Null dictionary. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Kinematic form of single-cell layer surface film model.

Source files

Definition at line 64 of file kinematicSingleLayer.H.

Constructor & Destructor Documentation

◆ kinematicSingleLayer()

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

◆ ~kinematicSingleLayer()

~kinematicSingleLayer ( )
virtual

Destructor.

Definition at line 836 of file kinematicSingleLayer.C.

References kinematicSingleLayer::addSources().

Here is the call graph for this function:

Member Function Documentation

◆ read()

bool read ( )
protectedvirtual

Read control parameters from dictionary.

Reimplemented from surfaceFilmRegionModel.

Reimplemented in thermoSingleLayer.

Definition at line 56 of file kinematicSingleLayer.C.

References dictionary::lookup(), kinematicSingleLayer::momentumPredictor_, kinematicSingleLayer::nCorr_, kinematicSingleLayer::nNonOrthCorr_, kinematicSingleLayer::nOuterCorr_, surfaceFilmRegionModel::read(), dictionary::readIfPresent(), regionModel::solution(), and dictionary::subDict().

Referenced by thermoSingleLayer::read().

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

◆ correctThermoFields()

void correctThermoFields ( )
protectedvirtual

Correct the thermo fields.

Reimplemented in thermoSingleLayer.

Definition at line 75 of file kinematicSingleLayer.C.

References kinematicSingleLayer::filmThermo_, kinematicSingleLayer::mu_, kinematicSingleLayer::rho_, and kinematicSingleLayer::sigma_.

Referenced by kinematicSingleLayer::kinematicSingleLayer(), and kinematicSingleLayer::preEvolveRegion().

Here is the caller graph for this function:

◆ resetPrimaryRegionSourceTerms()

void resetPrimaryRegionSourceTerms ( )
protectedvirtual

◆ transferPrimaryRegionThermoFields()

void transferPrimaryRegionThermoFields ( )
protectedvirtual

◆ transferPrimaryRegionSourceFields()

void transferPrimaryRegionSourceFields ( )
protectedvirtual

◆ pu()

tmp< volScalarField > pu ( )
protectedvirtual

◆ pp()

tmp< volScalarField > pp ( )
protectedvirtual

◆ correctAlpha()

void correctAlpha ( )
protectedvirtual

Correct film coverage field.

Reimplemented in thermoSingleLayer.

Definition at line 205 of file kinematicSingleLayer.C.

References kinematicSingleLayer::alpha_, kinematicSingleLayer::delta_, kinematicSingleLayer::deltaSmall_, and Foam::pos().

Referenced by kinematicSingleLayer::evolveRegion(), and kinematicSingleLayer::kinematicSingleLayer().

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

◆ updateSubmodels()

void updateSubmodels ( )
protectedvirtual

◆ continuityCheck()

void continuityCheck ( )
protectedvirtual

◆ updateSurfaceVelocities()

void updateSurfaceVelocities ( )
protectedvirtual

◆ constrainFilmField()

void constrainFilmField ( Type &  field,
const typename Type::cmptType &  value 
)
protected

Constrain a film region master/slave boundaries of a field to a.

given value

Definition at line 41 of file kinematicSingleLayerTemplates.C.

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

Referenced by kinematicSingleLayer::solveThickness().

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

◆ solveContinuity()

void solveContinuity ( )
protectedvirtual

Solve continuity equation.

Definition at line 265 of file kinematicSingleLayer.C.

References Foam::fvm::ddt(), kinematicSingleLayer::deltaRho_, Foam::fvc::div(), Foam::endl(), InfoInFunction, kinematicSingleLayer::phi_, kinematicSingleLayer::rhoSp_, and Foam::solve().

Referenced by kinematicSingleLayer::continuityCheck(), thermoSingleLayer::evolveRegion(), and kinematicSingleLayer::evolveRegion().

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

◆ solveMomentum()

tmp< Foam::fvVectorMatrix > solveMomentum ( const volScalarField pu,
const volScalarField pp 
)
protectedvirtual

◆ solveThickness()

void solveThickness ( const volScalarField pu,
const volScalarField pp,
const fvVectorMatrix UEqn 
)
protectedvirtual

◆ TypeName()

TypeName ( "kinematicSingleLayer"  )

Runtime type information.

◆ CourantNumber()

scalar CourantNumber ( ) const
virtual

◆ momentumPredictor()

const Switch & momentumPredictor ( ) const
inline

Return the momentum predictor.

Definition at line 41 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::momentumPredictor_.

◆ nOuterCorr()

label nOuterCorr ( ) const
inline

Return the number of outer correctors.

Definition at line 47 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::nOuterCorr_.

◆ nCorr()

label nCorr ( ) const
inline

Return the number of PISO correctors.

Definition at line 53 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::nCorr_.

◆ nNonOrthCorr()

label nNonOrthCorr ( ) const
inline

Return the number of non-orthogonal correctors.

Definition at line 59 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::nNonOrthCorr_.

◆ deltaSmall()

const dimensionedScalar & deltaSmall ( ) const
inline

Return small delta.

Definition at line 65 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::deltaSmall_.

Referenced by thixotropicViscosity::correct(), and laminar::Su().

Here is the caller graph for this function:

◆ mu()

const volScalarField & mu ( ) const
inline

Return const access to the dynamic viscosity [Pa.s].

Definition at line 71 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::mu_.

Referenced by laminar::Su().

Here is the caller graph for this function:

◆ sigma()

const volScalarField & sigma ( ) const
inlinevirtual

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

Implements surfaceFilmRegionModel.

Definition at line 77 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::sigma_.

Referenced by BrunDrippingInjection::correct(), and curvatureSeparation::correct().

Here is the caller graph for this function:

◆ delta()

const volScalarField & delta ( ) const
inlinevirtual

◆ alpha()

const volScalarField & alpha ( ) const
inlinevirtual

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

Implements surfaceFilmRegionModel.

Definition at line 89 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::alpha_.

Referenced by thixotropicViscosity::correct(), solidification::correctModel(), and thermoSingleLayer::q().

Here is the caller graph for this function:

◆ U()

const volVectorField & U ( ) const
virtual

Return the film velocity [m/s].

Implements surfaceFilmRegionModel.

Definition at line 969 of file kinematicSingleLayer.C.

References kinematicSingleLayer::U_.

Referenced by curvatureSeparation::correct(), and thixotropicViscosity::correct().

Here is the caller graph for this function:

◆ Us()

const volVectorField & Us ( ) const
virtual

Return the film surface velocity [m/s].

Implements surfaceFilmRegionModel.

Definition at line 975 of file kinematicSingleLayer.C.

References kinematicSingleLayer::Us_.

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

Here is the caller graph for this function:

◆ Uw()

const volVectorField & Uw ( ) const
virtual

Return the film wall velocity [m/s].

Implements surfaceFilmRegionModel.

Definition at line 981 of file kinematicSingleLayer.C.

References kinematicSingleLayer::Uw_.

Referenced by thixotropicViscosity::correct(), and laminar::Su().

Here is the caller graph for this function:

◆ deltaRho()

const volScalarField & deltaRho ( ) const
virtual

Return the film thickness*density (helper field) [kg/m3].

Definition at line 987 of file kinematicSingleLayer.C.

References kinematicSingleLayer::deltaRho_.

Referenced by thixotropicViscosity::correct(), and waxSolventEvaporation::correctModel().

Here is the caller graph for this function:

◆ phi()

const surfaceScalarField & phi ( ) const
virtual

Return the film flux [kg.m/s].

Definition at line 993 of file kinematicSingleLayer.C.

References kinematicSingleLayer::phi_.

Referenced by curvatureSeparation::correct(), thixotropicViscosity::correct(), and waxSolventEvaporation::correctModel().

Here is the caller graph for this function:

◆ rho()

const volScalarField & rho ( ) const
virtual

◆ T()

const volScalarField & T ( ) const
virtual

Return the film mean temperature [K].

Implements surfaceFilmRegionModel.

Reimplemented in thermoSingleLayer.

Definition at line 1005 of file kinematicSingleLayer.C.

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

Here is the call graph for this function:

◆ Ts()

const volScalarField & Ts ( ) const
virtual

Return the film surface temperature [K].

Implements surfaceFilmRegionModel.

Reimplemented in thermoSingleLayer.

Definition at line 1014 of file kinematicSingleLayer.C.

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

Here is the call graph for this function:

◆ Tw()

const volScalarField & Tw ( ) const
virtual

Return the film wall temperature [K].

Implements surfaceFilmRegionModel.

Reimplemented in thermoSingleLayer.

Definition at line 1023 of file kinematicSingleLayer.C.

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

Here is the call graph for this function:

◆ hs()

const volScalarField & hs ( ) const
virtual

Return the film surface enthalpy [J/kg].

Implements surfaceFilmRegionModel.

Reimplemented in thermoSingleLayer.

Definition at line 1032 of file kinematicSingleLayer.C.

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

Here is the call graph for this function:

◆ Cp()

const volScalarField & Cp ( ) const
virtual

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

Implements surfaceFilmRegionModel.

Reimplemented in thermoSingleLayer.

Definition at line 1041 of file kinematicSingleLayer.C.

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

Here is the call graph for this function:

◆ kappa()

const volScalarField & kappa ( ) const
virtual

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

Implements surfaceFilmRegionModel.

Reimplemented in thermoSingleLayer.

Definition at line 1050 of file kinematicSingleLayer.C.

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

Here is the call graph for this function:

◆ primaryMassTrans()

tmp< volScalarField > primaryMassTrans ( ) const
virtual

Return mass transfer source - Eulerian phase only.

Implements surfaceFilmRegionModel.

Definition at line 1059 of file kinematicSingleLayer.C.

References kinematicSingleLayer::primaryMassTrans_.

◆ cloudMassTrans()

const volScalarField & cloudMassTrans ( ) const
virtual

Return the film mass available for transfer to cloud.

Implements surfaceFilmRegionModel.

Definition at line 1065 of file kinematicSingleLayer.C.

References kinematicSingleLayer::cloudMassTrans_.

◆ cloudDiameterTrans()

const volScalarField & cloudDiameterTrans ( ) const
virtual

Return the parcel diameters originating from film to cloud.

Implements surfaceFilmRegionModel.

Definition at line 1071 of file kinematicSingleLayer.C.

References kinematicSingleLayer::cloudDiameterTrans_.

◆ addSources()

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

◆ USpPrimary()

volVectorField & USpPrimary ( )
inline

Momementum [kg/m/s2].

Definition at line 95 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::USpPrimary_.

◆ pSpPrimary()

volScalarField & pSpPrimary ( )
inline

Pressure [Pa].

Definition at line 101 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::pSpPrimary_.

◆ rhoSpPrimary()

volScalarField & rhoSpPrimary ( )
inline

Mass [kg/m2/s].

Definition at line 107 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::rhoSpPrimary_.

◆ USp() [1/2]

volVectorField & USp ( )
inline

Momentum [kg/m/s2].

Definition at line 113 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::USp_.

◆ pSp() [1/2]

volScalarField & pSp ( )
inline

Pressure [Pa].

Definition at line 119 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::pSp_.

◆ rhoSp() [1/2]

volScalarField & rhoSp ( )
inline

Mass [kg/m2/s].

Definition at line 125 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::rhoSp_.

Referenced by thixotropicViscosity::correct(), and waxSolventEvaporation::correctModel().

Here is the caller graph for this function:

◆ USp() [2/2]

const volVectorField & USp ( ) const
inline

Momentum [kg/m/s2].

Definition at line 131 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::USp_.

◆ pSp() [2/2]

const volScalarField & pSp ( ) const
inline

Pressure [Pa].

Definition at line 137 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::pSp_.

◆ rhoSp() [2/2]

const volScalarField & rhoSp ( ) const
inline

Mass [kg/m2/s].

Definition at line 143 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::rhoSp_.

◆ UPrimary()

const volVectorField & UPrimary ( ) const
inline

Velocity [m/s].

Definition at line 149 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::UPrimary_.

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

Here is the caller graph for this function:

◆ pPrimary()

const volScalarField & pPrimary ( ) const
inline

◆ rhoPrimary()

const volScalarField & rhoPrimary ( ) const
inline

Density [kg/m3].

Definition at line 161 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::rhoPrimary_.

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

Here is the caller graph for this function:

◆ muPrimary()

const volScalarField & muPrimary ( ) const
inline

Viscosity [Pa.s].

Definition at line 167 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::muPrimary_.

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

Here is the caller graph for this function:

◆ filmThermo()

const filmThermoModel & filmThermo ( ) const
inline

Film thermo.

Definition at line 173 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::filmThermo_.

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

Here is the caller graph for this function:

◆ injection()

injectionModelList & injection ( )
inline

Injection.

Definition at line 179 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::injection_.

◆ transfer()

transferModelList & transfer ( )
inline

Transfer.

Definition at line 185 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::transfer_.

◆ turbulence()

const filmTurbulenceModel & turbulence ( ) const
inline

Turbulence.

Definition at line 191 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::turbulence_.

◆ mass()

tmp< volScalarField > mass ( ) const
inline

Return the current film mass.

Definition at line 197 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::delta_, singleLayerRegion::magSf(), and kinematicSingleLayer::rho_.

Referenced by kinematicSingleLayer::continuityCheck(), and kinematicSingleLayer::preEvolveRegion().

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

◆ deltaMass()

tmp< volScalarField > deltaMass ( ) const
inline

Return the change in film mass due to sources/sinks.

Definition at line 203 of file kinematicSingleLayerI.H.

References TimeState::deltaT(), singleLayerRegion::magSf(), kinematicSingleLayer::rhoSp_, and regionModel::time().

Here is the call graph for this function:

◆ gNorm()

tmp< volScalarField > gNorm ( ) const
inline

Return the gravity normal-to-patch component contribution.

Definition at line 209 of file kinematicSingleLayerI.H.

References surfaceFilmRegionModel::g_, singleLayerRegion::nHat(), IOobject::NO_READ, IOobject::NO_WRITE, regionModel::regionMesh(), regionModel::time(), and timeName.

Referenced by drippingInjection::correct(), BrunDrippingInjection::correct(), and kinematicSingleLayer::gTan().

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

◆ gNormClipped()

tmp< volScalarField > gNormClipped ( ) const
inline

Return the gravity normal-to-patch component contribution.

Clipped so that only non-zero if g & nHat_ < 0

Definition at line 231 of file kinematicSingleLayerI.H.

References surfaceFilmRegionModel::g_, GeometricField< Type, PatchField, GeoMesh >::min(), singleLayerRegion::nHat(), IOobject::NO_READ, IOobject::NO_WRITE, tmp< T >::ref(), regionModel::regionMesh(), regionModel::time(), and timeName.

Referenced by kinematicSingleLayer::pp().

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

◆ gTan()

tmp< volVectorField > gTan ( ) const
inline

Return the gravity tangential component contributions.

Definition at line 256 of file kinematicSingleLayerI.H.

References surfaceFilmRegionModel::g_, kinematicSingleLayer::gNorm(), singleLayerRegion::nHat(), IOobject::NO_READ, IOobject::NO_WRITE, regionModel::regionMesh(), regionModel::time(), and timeName.

Referenced by kinematicSingleLayer::solveMomentum(), and kinematicSingleLayer::solveThickness().

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

◆ preEvolveRegion()

void preEvolveRegion ( )
virtual

◆ evolveRegion()

void evolveRegion ( )
virtual

◆ Srho() [1/2]

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

Return total mass source - Eulerian phase only.

Implements surfaceFilmModel.

Reimplemented in thermoSingleLayer.

Definition at line 1102 of file kinematicSingleLayer.C.

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

Here is the call graph for this function:

◆ Srho() [2/2]

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

Return mass source for specie i - Eulerian phase only.

Implements surfaceFilmModel.

Reimplemented in thermoSingleLayer.

Definition at line 1125 of file kinematicSingleLayer.C.

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

Here is the call graph for this function:

◆ Sh()

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

Return enthalpy source - Eulerian phase only.

Implements surfaceFilmModel.

Reimplemented in thermoSingleLayer.

Definition at line 1149 of file kinematicSingleLayer.C.

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

Here is the call graph for this function:

◆ info()

void info ( )
virtual

Member Data Documentation

◆ momentumPredictor_

Switch momentumPredictor_
protected

◆ nOuterCorr_

label nOuterCorr_
protected

◆ nCorr_

label nCorr_
protected

◆ nNonOrthCorr_

label nNonOrthCorr_
protected

Number of non-orthogonal correctors.

Definition at line 95 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::nNonOrthCorr(), kinematicSingleLayer::read(), and kinematicSingleLayer::solveThickness().

◆ cumulativeContErr_

scalar cumulativeContErr_
protected

Cumulative continuity error.

Definition at line 98 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::continuityCheck().

◆ deltaSmall_

const dimensionedScalar deltaSmall_
protected

◆ deltaCoLimit_

scalar deltaCoLimit_
protected

Film thickness above which Courant number calculation in valid.

Definition at line 104 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::CourantNumber().

◆ rho_

volScalarField rho_
protected

◆ mu_

volScalarField mu_
protected

Dynamic viscosity [Pa.s].

Definition at line 115 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::correctThermoFields(), and kinematicSingleLayer::mu().

◆ sigma_

volScalarField sigma_
protected

◆ delta_

volScalarField delta_
protected

◆ alpha_

volScalarField alpha_
protected

Film coverage indicator, 1 = covered, 0 = uncovered [].

Definition at line 127 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::alpha(), thermoSingleLayer::correctAlpha(), kinematicSingleLayer::correctAlpha(), and kinematicSingleLayer::info().

◆ U_

volVectorField U_
protected

◆ Us_

volVectorField Us_
protected

Velocity - surface [m/s].

Definition at line 133 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::updateSurfaceVelocities(), and kinematicSingleLayer::Us().

◆ Uw_

volVectorField Uw_
protected

Velocity - wall [m/s].

Definition at line 136 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::updateSurfaceVelocities(), and kinematicSingleLayer::Uw().

◆ deltaRho_

volScalarField deltaRho_
protected

◆ phi_

surfaceScalarField phi_
protected

◆ primaryMassTrans_

volScalarField primaryMassTrans_
protected

Film mass available for transfer to the primary region.

Definition at line 148 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::preEvolveRegion(), kinematicSingleLayer::primaryMassTrans(), thermoSingleLayer::Srho(), and thermoSingleLayer::updateSubmodels().

◆ cloudMassTrans_

volScalarField cloudMassTrans_
protected

◆ cloudDiameterTrans_

volScalarField cloudDiameterTrans_
protected

◆ USp_

volVectorField USp_
protected

◆ pSp_

volScalarField pSp_
protected

◆ rhoSp_

volScalarField rhoSp_
protected

◆ USpPrimary_

volVectorField USpPrimary_
protected

◆ pSpPrimary_

volScalarField pSpPrimary_
protected

◆ rhoSpPrimary_

volScalarField rhoSpPrimary_
protected

◆ UPrimary_

volVectorField UPrimary_
protected

◆ pPrimary_

volScalarField pPrimary_
protected

◆ rhoPrimary_

volScalarField rhoPrimary_
protected

◆ muPrimary_

volScalarField muPrimary_
protected

◆ filmThermo_

autoPtr<filmThermoModel> filmThermo_
protected

◆ availableMass_

scalarField availableMass_
protected

Available mass for transfer via sub-models.

Definition at line 208 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::preEvolveRegion(), thermoSingleLayer::updateSubmodels(), and kinematicSingleLayer::updateSubmodels().

◆ injection_

injectionModelList injection_
protected

◆ transfer_

transferModelList transfer_
protected

◆ turbulence_

autoPtr<filmTurbulenceModel> turbulence_
protected

◆ forces_

forceList forces_
protected

List of film forces.

Definition at line 220 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::solveMomentum().

◆ addedMassTotal_

scalar addedMassTotal_
protected

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