kinematicSingleLayer Class Reference

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

Inheritance diagram for kinematicSingleLayer:
Collaboration diagram for kinematicSingleLayer:

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...
 
Switch momentumPredictor () 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 ()
 Momentum [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...
 
tmp< vectorFieldgTan (const label patchI) const
 Return the gravity tangential component contributions for patchI. More...
 
virtual void preEvolveRegion ()
 Pre-evolve film hook. More...
 
virtual void evolveRegion ()
 Evolve the film equations. More...
 
virtual void postEvolveRegion ()
 Post-evolve film hook. 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 acceleration 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 ()=default
 Destructor. More...
 
const fvMeshprimaryMesh () const noexcept
 Return the reference to the primary mesh database. More...
 
const Timetime () const noexcept
 Return the reference to the time database. More...
 
Switch active () const noexcept
 Return the active flag. More...
 
Switch infoOutput () const noexcept
 Return the information flag. More...
 
const wordmodelName () const noexcept
 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 noexcept
 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...
 
const labelListprimaryPatchIDs () const noexcept
 List of patch IDs on the primary region coupled to this region. More...
 
const labelListintCoupledPatchIDs () const noexcept
 List of patch IDs internally coupled with the primary region. More...
 
bool isCoupledPatch (const label regionPatchi) const
 True if patchi on the local region is a coupled patch to the primary region. More...
 
bool isRegionPatch (const label primaryPatchi) const
 True if patchi on the primary region is a coupled patch to the local region. More...
 
label regionPatchID (const label primaryPatchi) const
 Return region ID corresponding to primaryPatch ID. 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...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > mapRegionPatchField (const regionModel &nbrRegion, const label regionPatchi, const label nbrPatchi, const Field< Type > &nbrField, const bool flip) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > mapRegionPatchField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchi, const bool flip) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > mapRegionPatchInternalField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchi, const bool flip) const
 
- Public Member Functions inherited from IOdictionary
 IOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 Construct given an IOobject and optional fallback dictionary content. More...
 
 IOdictionary (const IOobject &io, const dictionary &dict)
 Construct given an IOobject and fallback dictionary content. More...
 
 IOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr)
 Construct given an IOobject, wanted typeName and optional fallback dictionary content. More...
 
 IOdictionary (const IOobject &io, Istream &is)
 Construct given an IOobject and Istream. More...
 
virtual ~IOdictionary ()=default
 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")
 Declare type-name, virtual type (with debug switch) More...
 
 baseIOdictionary (const baseIOdictionary &)=default
 Copy construct. More...
 
 baseIOdictionary (baseIOdictionary &&)=default
 Move construct. More...
 
virtual ~baseIOdictionary ()=default
 Destructor. More...
 
 baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 Construct given an IOobject and optional fallback dictionary content (ununsed) More...
 
 baseIOdictionary (const IOobject &io, const dictionary &dict)
 Construct given an IOobject and fallback dictionary content (ununsed) More...
 
 baseIOdictionary (const IOobject &io, Istream &is)
 Construct given an IOobject and Istream (ununsed) More...
 
const wordname () const
 Name function is needed to disambiguate those inherited from regIOobject and dictionary. More...
 
virtual bool readData (Istream &)
 The readData function required by regIOobject read operation. More...
 
virtual bool writeData (Ostream &) const
 The writeData function required by regIOobject write operation. More...
 
void operator= (const baseIOdictionary &rhs)
 Copy assignment of dictionary entries (leave regIOobject untouched) More...
 
void operator= (const dictionary &rhs)
 Copy assignment of dictionary entries. More...
 
- Public Member Functions inherited from regIOobject
void operator= (const regIOobject &)=delete
 No copy assignment. More...
 
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). More...
 
 regIOobject (const regIOobject &rio)
 Copy construct. More...
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 Copy construct, transferring registry registration to the copy if registerCopy is true. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy construct with new name, transferring registry registration to the copy if registerCopy is true. More...
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 Copy construct with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry, if not already registered. More...
 
bool checkOut ()
 Remove all file watches and remove object from registry. More...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool registered () const noexcept
 Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. More...
 
bool ownedByRegistry () const noexcept
 Is this object owned by the registry? More...
 
bool store ()
 Register object with its registry and transfer ownership to the registry. More...
 
void release (const bool unregister=false) noexcept
 Set object as not ownedByRegistry. More...
 
label eventNo () const noexcept
 Event number at last update. More...
 
label & eventNo () noexcept
 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 as up-to-date. More...
 
virtual void rename (const word &newName)
 Rename. More...
 
const dictionaryfindMetaData () const noexcept
 Return pointer to meta-data or nullptr. More...
 
dictionarygetMetaData () noexcept
 Get or create meta-data. More...
 
void removeMetaData ()
 Remove meta-data. More...
 
virtual void updateMetaData ()
 Update internal meta-data (eg, prior to writing) More...
 
bool headerOk ()
 Read and check header info. Does not check the headerClassName. More...
 
IstreamreadStream (const word &, const bool readOnProc=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. More...
 
const labelListwatchIndices () const noexcept
 Read access to file-monitoring handles. More...
 
labelListwatchIndices () noexcept
 Write access to file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool writeOnProc) const
 Write using stream options. More...
 
virtual bool write (const bool writeOnProc=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &io)
 Copy assignment. More...
 
virtual bool writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const
 Write using given format, version and compression. More...
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Declare type-name, virtual type (with debug switch) More...
 
 IOobject (const IOobject &)=default
 Copy construct. More...
 
virtual ~IOobject ()=default
 Destructor. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
 Construct from path, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Copy construct, resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Copy construct, resetting name. More...
 
 IOobject (const IOobject &io, const word &name, const fileName &local)
 Copy construct, resetting name and local component. More...
 
 IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt)
 Copy construct, resetting read/write options. More...
 
 IOobject (const IOobject &io, IOobjectOption::registerOption regOpt)
 Copy construct, resetting register option. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
const objectRegistrydb () const noexcept
 Return the local objectRegistry. More...
 
const Timetime () const noexcept
 Return Time associated with the objectRegistry. More...
 
const wordname () const noexcept
 Return the object name. More...
 
const wordheaderClassName () const noexcept
 Return name of the class name read from header. More...
 
wordheaderClassName () noexcept
 Return non-constant access to the class name read from header. More...
 
const stringnote () const noexcept
 Return the optional note. More...
 
stringnote () noexcept
 Modifiable access to the optional note. More...
 
unsigned labelByteSize () const noexcept
 The sizeof (label) in bytes, possibly read from the header. More...
 
unsigned scalarByteSize () const noexcept
 The sizeof (scalar) in bytes, possibly read from the header. More...
 
void resetHeader (const word &newName=word::null)
 Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. More...
 
bool hasHeaderClass () const noexcept
 True if headerClassName() is non-empty (after reading) More...
 
template<class Type >
bool isHeaderClass () const
 Check if headerClassName() equals Type::typeName. More...
 
template<class Type >
bool isHeaderClassName () const
 Same as isHeaderClass() More...
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const noexcept
 Return the Time::rootPath() More...
 
const fileNamecaseName () const noexcept
 Return the Time::caseName() More...
 
const fileNameglobalCaseName () const noexcept
 Return the Time::globalCaseName() More...
 
const fileNameinstance () const noexcept
 Read access to instance path component. More...
 
fileNameinstance () noexcept
 Write access to instance path component. More...
 
const fileNamelocal () const noexcept
 Read access to local path component. More...
 
fileName path () const
 The complete path for the object (with instance, local,...). More...
 
fileName globalPath () const
 The complete global path for the object (with instance, local,...) More...
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 The complete path with alternative instance and local. More...
 
fileName globalPath (const word &instance, const fileName &local=fileName::null) const
 The complete global path with alternative instance and local. More...
 
fileName objectPath () const
 The complete path + object name. More...
 
fileName globalObjectPath () const
 The complete global path + object name. More...
 
fileName objectRelPath () const
 The object path relative to the root. More...
 
fileName localFilePath (const word &typeName, const bool search=true) const
 Redirect to fileHandler filePath, searching locally. More...
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 Redirect to fileHandler filePath, searching up if in parallel. More...
 
IOstreamOption parseHeader (const dictionary &headerDict)
 Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More...
 
bool readHeader (Istream &is)
 Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More...
 
bool readHeader (dictionary &headerDict, Istream &is)
 Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 Read header (respects is_globalIOobject trait) and check its info. More...
 
template<class Type >
fileName typeFilePath (const bool search=true) const
 Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &os) const
 Write header with current type() More...
 
bool writeHeader (Ostream &os, const word &objectType) const
 Write header with override of type. More...
 
void writeHeader (dictionary &dict, IOstreamOption streamOpt) const
 Write header into a dictionary with current type() and given output format. More...
 
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 Write header into a dictionary with override of type and given output format. More...
 
bool good () const noexcept
 Did last readHeader() succeed? More...
 
bool bad () const noexcept
 Did last readHeader() fail? More...
 
InfoProxy< IOobjectinfo () const noexcept
 Return info proxy, for printing information to a stream. More...
 
void operator= (const IOobject &io)
 Copy assignment, copies all values (except the registry) More...
 
template<>
bool isHeaderClass () const
 Specialization for void always returns true (no headerClassName check). More...
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 
template<class Type >
Foam::fileName typeFilePath (const bool search) const
 
- Public Member Functions inherited from IOobjectOption
constexpr IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
 Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options. More...
 
constexpr IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
 Construct NO_WRITE with specified read/register options. More...
 
constexpr IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
 Construct NO_READ with specified write/register options. More...
 
constexpr IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept
 Construct (NO_READ, NO_WRITE) with specified register option. More...
 
constexpr IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept
 Construct from components with specified register option as bool. More...
 
constexpr IOobjectOption (bool registerObject, bool globalObject=false) noexcept
 Construct (NO_READ, NO_WRITE) with specified register option as bool. More...
 
readOption readOpt () const noexcept
 Get the read option. More...
 
readOption readOpt (readOption opt) noexcept
 Set the read option. More...
 
writeOption writeOpt () const noexcept
 Get the write option. More...
 
writeOption writeOpt (writeOption opt) noexcept
 Set the write option. More...
 
bool registerObject () const noexcept
 Should objects created with this IOobject be registered? More...
 
bool registerObject (bool on) noexcept
 Change registration preference. More...
 
bool globalObject () const noexcept
 True if object is treated the same for all processors. More...
 
bool globalObject (bool on) noexcept
 Change global-object status. More...
 
bool isAnyRead () const noexcept
 True if any reading may be required (ie, != NO_READ) More...
 
bool isReadRequired () const noexcept
 True if (MUST_READ | READ_MODIFIED) bits are set. More...
 
bool isReadOptional () const noexcept
 True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More...
 
readOptionreadOpt () noexcept
 Access to the read option. More...
 
writeOptionwriteOpt () noexcept
 Access to the write option. More...
 
bool & registerObject () noexcept
 Access to the register object option. More...
 
bool & globalObject () noexcept
 Access to the global object option. More...
 
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 
 dictionary ()
 Default construct, a top-level empty dictionary. More...
 
 dictionary (const fileName &name)
 Construct top-level empty dictionary with given name. More...
 
 dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false)
 Construct given the entry name, parent dictionary and Istream, reading entries until EOF, optionally keeping the header. More...
 
 dictionary (Istream &is)
 Construct top-level dictionary from Istream (discards the header). Reads entries until EOF or when the first token is a '{' character, it will stop reading at the matching '}' character. More...
 
 dictionary (Istream &is, bool keepHeader)
 Construct top-level dictionary from Istream, reading entries until EOF, optionally keeping the header. More...
 
 dictionary (const dictionary &parentDict, const dictionary &dict)
 Copy construct given the parent dictionary. More...
 
 dictionary (const dictionary &dict)
 Copy construct top-level dictionary. More...
 
 dictionary (const dictionary *dict)
 Construct top-level dictionary as copy from pointer to dictionary. More...
 
 dictionary (const dictionary &parentDict, dictionary &&dict)
 Move construct for given parent dictionary. More...
 
 dictionary (dictionary &&dict)
 Move construct top-level dictionary. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const fileNamename () const noexcept
 The dictionary name. More...
 
fileNamename () noexcept
 The dictionary name for modification (use with caution). More...
 
word dictName () const
 The local dictionary name (final part of scoped name) More...
 
fileName relativeName (const bool caseTag=false) const
 The dictionary name relative to the case. More...
 
bool isNullDict () const noexcept
 The dictionary is actually dictionary::null (root dictionary) More...
 
const dictionaryparent () const noexcept
 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...
 
const entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find an entry (const access) with the given keyword. More...
 
entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find an entry (non-const access) with the given keyword. More...
 
bool found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find an entry (const access) with the given keyword. More...
 
const entryfindScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Search for a scoped entry (const access) with the given keyword. More...
 
const dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a sub-dictionary pointer if present (and a sub-dictionary) otherwise return nullptr. More...
 
dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a sub-dictionary pointer if present (and a sub-dictionary) otherwise return nullptr. More...
 
bool isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find a sub-dictionary. More...
 
const entrylookupEntry (const word &keyword, enum keyType::option matchOpt) const
 Search for an entry (const access) with the given keyword. More...
 
ITstreamlookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return an entry data stream. FatalIOError if not found, or not a stream. More...
 
template<class T >
T get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a T. FatalIOError if not found, or if the number of tokens is incorrect. More...
 
template<class T >
T getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a T, or return the given default value. FatalIOError if it is found and the number of tokens is incorrect. More...
 
template<class T >
T getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a T, or return the given default value and add it to dictionary. FatalIOError if it is found and the number of tokens is incorrect. More...
 
template<class T >
bool readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const
 Find entry and assign to T val. FatalIOError if it is found and the number of tokens is incorrect, or it is mandatory and not found. More...
 
template<class T >
bool readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const
 Find an entry if present, and assign to T val. FatalIOError if it is found and the number of tokens is incorrect. More...
 
template<class T , class Predicate >
T getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a T with additional checking FatalIOError if not found, or if the number of tokens is incorrect. More...
 
template<class T , class Predicate >
T getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a T, or return the given default value. FatalIOError if it is found and the number of tokens is incorrect. More...
 
template<class T , class Predicate >
T getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a T, or return the given default value and add it to dictionary. FatalIOError if it is found and the number of tokens is incorrect. More...
 
template<class T , class Predicate >
bool readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const
 Find entry and assign to T val. FatalIOError if it is found and the number of tokens is incorrect, or it is mandatory and not found. More...
 
template<class T , class Predicate >
bool readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 Find an entry if present, and assign to T val. FatalIOError if it is found and the number of tokens is incorrect. More...
 
const dictionarysubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a sub-dictionary for manipulation. More...
 
dictionarysubDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a sub-dictionary for manipulation. More...
 
dictionary subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const
 Find and return a sub-dictionary as a copy, otherwise return an empty dictionary. More...
 
const dictionaryoptionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a sub-dictionary, otherwise return this dictionary. More...
 
wordList toc () const
 Return the table of contents. More...
 
wordList sortedToc () const
 Return the sorted table of contents. More...
 
template<class Compare >
wordList sortedToc (const Compare &comp) const
 Return table of contents sorted using the specified comparator. More...
 
List< keyTypekeys (bool patterns=false) const
 Return the list of available keys or patterns. More...
 
bool substituteKeyword (const word &keyword, bool mergeEntry=false)
 Substitute the given keyword (which is prefixed by '$') More...
 
bool substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
 Substitute the given scoped keyword (which is prefixed by '$') More...
 
entryadd (entry *entryPtr, bool mergeEntry=false)
 Add a new entry. More...
 
entryadd (const entry &e, bool mergeEntry=false)
 Add an entry. More...
 
entryadd (const keyType &k, const word &v, bool overwrite=false)
 Add a word entry. More...
 
entryadd (const keyType &k, const string &v, bool overwrite=false)
 Add a string entry. More...
 
entryadd (const keyType &k, const label v, bool overwrite=false)
 Add a label entry. More...
 
entryadd (const keyType &k, const scalar v, bool overwrite=false)
 Add a scalar entry. More...
 
entryadd (const keyType &k, const dictionary &d, bool mergeEntry=false)
 Add a dictionary entry. More...
 
template<class T >
entryadd (const keyType &k, const T &v, bool overwrite=false)
 Add a T entry. More...
 
entryset (entry *entryPtr)
 Assign a new entry, overwriting any existing entry. More...
 
entryset (const entry &e)
 Assign a new entry, overwriting any existing entry. More...
 
entryset (const keyType &k, const dictionary &v)
 Assign a dictionary entry, overwriting any existing entry. More...
 
template<class T >
entryset (const keyType &k, const T &v)
 Assign a T entry, overwriting any existing entry. More...
 
bool remove (const word &keyword)
 Remove an entry specified by keyword. More...
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
 Change the keyword for an entry,. More...
 
bool merge (const dictionary &dict)
 Merge entries from the given dictionary. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (dictionary &dict)
 Transfer the contents of the argument and annul the argument. More...
 
void checkITstream (const ITstream &is, const word &keyword) const
 Check after reading if the input token stream has unconsumed tokens remaining or if there were no tokens in the first place. More...
 
bool read (Istream &is)
 Read dictionary from Istream (discards the header). Reads entries until EOF or when the first token is a '{' character, it will stop reading at the matching '}' character. More...
 
bool read (Istream &is, bool keepHeader)
 Read dictionary from Istream (optionally keeping the header) Reads entries until EOF or when the first token is a '{' character, it will stop reading at the matching '}' character. More...
 
void writeEntry (Ostream &os) const
 Write sub-dictionary with its dictName as its header. More...
 
void writeEntry (const keyType &keyword, Ostream &os) const
 Write sub-dictionary with the keyword as its header. More...
 
void writeEntries (Ostream &os, const bool extraNewLine=false) const
 Write dictionary entries. More...
 
void write (Ostream &os, const bool subDict=true) const
 Write dictionary, normally with sub-dictionary formatting. More...
 
const_searcher csearch (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Search dictionary for given keyword. More...
 
const_searcher search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Search dictionary for given keyword. More...
 
searcher search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Search dictionary for given keyword. More...
 
const_searcher csearchScoped (const word &keyword, enum keyType::option matchOpt) const
 Search using scoping. More...
 
const_searcher searchScoped (const word &keyword, enum keyType::option matchOpt) const
 Search using dot or slash scoping. More...
 
searcher searchScoped (const word &keyword, enum keyType::option matchOpt)
 Search using dot or slash scoping. More...
 
const dictionarycfindScopedDict (const fileName &dictPath) const
 Locate a sub-dictionary using slash-scoping. More...
 
const dictionaryfindScopedDict (const fileName &dictPath) const
 Locate a sub-dictionary using slash-scoping. More...
 
dictionaryfindScopedDict (const fileName &dictPath)
 Locate a sub-dictionary using slash-scoping. More...
 
dictionarymakeScopedDict (const fileName &dictPath)
 Locate existing or create sub-dictionary using slash-scoping. More...
 
const_searcher csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt=keyType::REGEX) const
 Search dictionary for given keyword and any compatibility names. More...
 
const entryfindCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt) const
 Find and return an entry pointer if present, or return a nullptr, using any compatibility names if needed. More...
 
bool foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt=keyType::REGEX) const
 Search dictionary for given keyword and any compatibility names. More...
 
const entrylookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt) const
 Find and return an entry if present, otherwise FatalIOError, using any compatibility names if needed. More...
 
ITstreamlookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return an entry data stream, using any compatibility names if needed. More...
 
template<class T >
T getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a T using any compatibility names if needed. FatalIOError if not found, or if there are excess tokens. More...
 
template<class T >
T getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a T, or return the given default value using any compatibility names if needed. More...
 
template<class T >
bool readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option matchOpt=keyType::REGEX, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) const
 Find entry and assign to T val using any compatibility names if needed. FatalIOError if there are excess tokens. More...
 
template<class T >
bool readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option matchOpt=keyType::REGEX) const
 Find an entry if present, and assign to T val using any compatibility names if needed. FatalIOError if it is found and there are excess tokens. More...
 
void operator= (const dictionary &rhs)
 Copy assignment. More...
 
void operator+= (const dictionary &rhs)
 Include entries from the given dictionary. More...
 
void operator|= (const dictionary &rhs)
 Conditionally include entries from the given dictionary. More...
 
void operator<<= (const dictionary &rhs)
 Unconditionally include entries from the given dictionary. More...
 
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 T >
T lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 Same as getOrDefault() More...
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 Same as getOrAdd() More...
 
ITstreamoperator[] (const word &keyword) const
 Deprecated(2018-07) - use lookup() method. More...
 
bool found (const word &keyword, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
entrylookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
 Deprecated(2018-10) More...
 
const entrylookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 Deprecated(2018-10) More...
 
const entrylookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 Deprecated(2018-10) More...
 
const dictionarysubDictPtr (const word &keyword) const
 Deprecated(2018-10) More...
 
dictionarysubDictPtr (const word &keyword)
 Deprecated(2018-10) Find and return a sub-dictionary pointer if present. More...
 
const entrylookupEntry (const word &keyword, bool recursive, bool patternMatch) const
 Deprecated(2018-10) More...
 
ITstreamlookup (const word &keyword, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
 Deprecated(2018-10) More...
 
template<class T >
bool readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
template<class T >
T lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
 Deprecated(2018-10) find and return a T. More...
 
template<class Compare >
Foam::wordList sortedToc (const Compare &comp) const
 
template<class T >
Foam::entryadd (const keyType &k, const T &v, bool overwrite)
 
template<class T >
Foam::entryset (const keyType &k, const T &v)
 
- Public Member Functions inherited from ILList< LListBase, T >
 ILList ()=default
 Default construct. More...
 
 ILList (T *item)
 Construct and add initial item pointer. More...
 
 ILList (Istream &is)
 Construct from Istream. More...
 
 ILList (const ILList< LListBase, T > &lst)
 Copy construct using the 'clone()' method for each element. More...
 
 ILList (ILList< LListBase, T > &&lst)
 Move construct. More...
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone 'clone()'. More...
 
template<class INew >
 ILList (Istream &is, const INew &inew)
 Construct from Istream using given Istream constructor class. More...
 
 ~ILList ()
 Destructor. Calls clear() More...
 
void clear ()
 Clear the contents of the list. More...
 
void pop_front (label n=1)
 Remove first element(s) from the list (deletes pointers) More...
 
bool erase (T *item)
 Remove the specified element from the list and delete it. More...
 
void transfer (ILList< LListBase, T > &lst)
 Transfer the contents of the argument into this List and annul the argument list. More...
 
void operator= (const ILList< LListBase, T > &lst)
 Copy assignment using the 'clone()' method for each element. More...
 
void operator= (ILList< LListBase, T > &&lst)
 Move assignment. More...
 
- Public Member Functions inherited from UILList< LListBase, T >
 UILList ()=default
 Default construct. More...
 
 UILList (T *item)
 Construct and add initial item pointer. More...
 
 UILList (const UILList< LListBase, T > &list)
 Construct as copy. More...
 
Tfront ()
 The first entry in the list. More...
 
const Tfront () const
 The first entry in the list (const access) More...
 
Tback ()
 The last entry in the list. More...
 
const Tback () const
 The last entry in the list (const access) More...
 
TremoveHead ()
 Remove and return head. More...
 
Tremove (T *item)
 Remove and return element. More...
 
Tremove (iterator &iter)
 Remove and return item specified by iterator. More...
 
void operator= (const UILList< LListBase, T > &lst)
 Copy assignment. More...
 
bool operator== (const UILList< LListBase, T > &lst) const
 Equality. True both lists are element-wise equal. More...
 
bool operator!= (const UILList< LListBase, T > &lst) const
 The opposite of the equality operation. Takes linear time. More...
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write UILList with line-breaks when length exceeds shortLen. More...
 
iterator begin ()
 Iterator to first item in list with non-const access. More...
 
const_iterator cbegin () const
 Iterator to first item in list with const access. More...
 
reverse_iterator rbegin ()
 Iterator to last item in list with non-const access. More...
 
const_reverse_iterator crbegin () const
 Iterator to last item in list with const access. More...
 
const_iterator begin () const
 Iterator to first item in list with const access. More...
 
const_reverse_iterator rbegin () const
 Iterator to last item in list with const access. More...
 
const iteratorend ()
 End of list for forward iterators. More...
 
const const_iteratorcend () const
 End of list for forward iterators. More...
 
const reverse_iteratorrend ()
 End of list for reverse iterators. More...
 
const const_reverse_iteratorcrend () const
 End of list for reverse iterators. More...
 
const const_iteratorend () const
 End of list for forward iterators. More...
 
const const_reverse_iteratorrend () const
 End of list for reverse iterators. More...
 
Tfirst ()
 The first entry in the list. More...
 
const Tfirst () const
 The first entry in the list (const access) More...
 
Tlast ()
 The last entry in the list. More...
 
const Tlast () const
 The last entry in the list (const access) 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, 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 IOstreamOption::streamFormat fmt, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 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_
 Momentum [kg/m/s2]. More...
 
volScalarField pSp_
 Pressure [Pa]. More...
 
volScalarField rhoSp_
 Mass [kg/m2/s]. More...
 
volVectorField USpPrimary_
 Momentum [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...
 
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 : char { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Public Types inherited from IOobjectOption
enum  readOption : unsigned char {
  NO_READ = 0, MUST_READ = 0x1, READ_MODIFIED = 0x3, MUST_READ_IF_MODIFIED = 0x3,
  LAZY_READ = 0x4, READ_IF_PRESENT = 0x4
}
 Enumeration defining read preferences. More...
 
enum  writeOption : unsigned char { NO_WRITE = 0, AUTO_WRITE = 0x10 }
 Enumeration defining write preferences. More...
 
enum  registerOption : unsigned char { NO_REGISTER = 0, REGISTER = 1, LEGACY_REGISTER = 2 }
 Enumeration for use with registerObject(). Values map to bool (false/true) More...
 
- Public Types inherited from dictionary
typedef Searcher< true > const_searcher
 Searcher with const access. More...
 
typedef Searcher< false > searcher
 Searcher with non-const access. More...
 
- Public Types inherited from UILList< LListBase, T >
typedef T value_type
 Type of values stored. More...
 
typedef Tpointer
 Pointer for value_type. More...
 
typedef const Tconst_pointer
 Const pointer for value_type. More...
 
typedef Treference
 Reference for value_type. More...
 
typedef const Tconst_reference
 Const reference for value_type. More...
 
typedef label size_type
 The type that can represent the container size. More...
 
typedef label difference_type
 The difference between iterator objects. More...
 
using base_iterator = typename LListBase::iterator
 
using const_base_iterator = typename 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 IOdictionary
static dictionary readContents (const IOobject &io)
 Read and return contents. The IOobject will not be registered. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 Status of output file banner. More...
 
static bool bannerEnabled (bool on) noexcept
 Enable/disable output file banner. More...
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class StringType >
static word groupName (StringType base, const word &group)
 Create dot-delimited name.group string. More...
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
static word scopedName (const std::string &scope, const word &name)
 Create scope:name or scope_name string. More...
 
static word scopedName (const std::string &scope, const word &name1, const word &name2)
 Create scope:name1:name2 or scope_name1_name2 string. More...
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 Return the IOobject, but also consider an alternative file name. More...
 
static OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
static OstreamwriteDivider (Ostream &os)
 Write the standard file section divider. More...
 
static OstreamwriteEndDivider (Ostream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from IOobjectOption
static bool isAnyRead (readOption opt) noexcept
 True if any reading may be required (ie, != NO_READ) More...
 
static bool isReadRequired (readOption opt) noexcept
 True if (MUST_READ | READ_MODIFIED) bits are set. More...
 
static bool isReadOptional (readOption opt) noexcept
 True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More...
 
static readOption lazierRead (readOption opt) noexcept
 Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. More...
 
- Static Public Member Functions inherited from dictionary
static int reportOptional () noexcept
 Return the state of reporting optional (default) entries. More...
 
static int reportOptional (const int level) noexcept
 Change the state of reporting optional (default) entries. More...
 
static autoPtr< dictionaryNew (Istream &is)
 Construct top-level dictionary on freestore from Istream. More...
 
- Public Attributes inherited from dictionary
friend const_searcher
 Declare friendship with the searcher classes. More...
 
friend searcher
 
- Static Public Attributes inherited from surfaceFilmModel
static const dimensionedScalar Tref
 Reference temperature for enthalpy. More...
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 Names for the fileCheckTypes. More...
 
static char scopeSeparator
 Character for scoping object names (':' or '_') More...
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
static float fileModificationSkew
 Time skew (seconds) for file modification checks. More...
 
static int maxFileModificationPolls
 Max number of times to poll for file modification changes. More...
 
- Static Public Attributes inherited from dictionary
static int writeOptionalEntries
 Report optional keywords and values if not present in dictionary. More...
 
static const dictionary null
 An empty dictionary, which is also the parent for all dictionaries. More...
 
static refPtr< OSstreamreportingOutput
 Output location when reporting default values. More...
 
- Static Protected Member Functions inherited from IOobject
static void writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
 Helper: write content for FoamFile IOobject header with optional meta information. More...
 
static void writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
 Helper: write dictionary content for FoamFile header with optional meta information. 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 63 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 
)

Construct from components.

Definition at line 429 of file kinematicSingleLayer.C.

References Foam::fvc::flux(), IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, Foam::constant::electromagnetic::phi0, IOobjectOption::READ_IF_PRESENT, Foam::readFields(), and timeName.

Here is the call graph for this function:

◆ ~kinematicSingleLayer()

~kinematicSingleLayer ( )
virtual

Destructor.

Definition at line 816 of file kinematicSingleLayer.C.

Member Function Documentation

◆ read()

bool read ( )
protectedvirtual

Read control parameters from dictionary.

Reimplemented from surfaceFilmRegionModel.

Reimplemented in thermoSingleLayer.

Definition at line 52 of file kinematicSingleLayer.C.

References kinematicSingleLayer::momentumPredictor_, kinematicSingleLayer::nCorr_, kinematicSingleLayer::nNonOrthCorr_, kinematicSingleLayer::nOuterCorr_, surfaceFilmRegionModel::read(), dictionary::readEntry(), 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 69 of file kinematicSingleLayer.C.

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

Referenced by kinematicSingleLayer::preEvolveRegion().

Here is the caller graph for this function:

◆ resetPrimaryRegionSourceTerms()

void resetPrimaryRegionSourceTerms ( )
protectedvirtual

◆ transferPrimaryRegionThermoFields()

void transferPrimaryRegionThermoFields ( )
protectedvirtual

Transfer thermo fields from the primary region to the film region.

Reimplemented in thermoSingleLayer.

Definition at line 87 of file kinematicSingleLayer.C.

References GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), DebugInFunction, Foam::endl(), kinematicSingleLayer::muPrimary_, kinematicSingleLayer::pPrimary_, kinematicSingleLayer::rhoPrimary_, and kinematicSingleLayer::UPrimary_.

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

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

◆ transferPrimaryRegionSourceFields()

◆ pu()

tmp< volScalarField > pu ( )
protectedvirtual

◆ pp()

◆ correctAlpha()

void correctAlpha ( )
protectedvirtual

Correct film coverage field.

Reimplemented in thermoSingleLayer.

Definition at line 197 of file kinematicSingleLayer.C.

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

Referenced by kinematicSingleLayer::preEvolveRegion().

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

◆ updateSubmodels()

◆ continuityCheck()

◆ updateSurfaceVelocities()

◆ 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 36 of file kinematicSingleLayerTemplates.C.

References Foam::ensightOutput::debug, Foam::endl(), field(), forAll, and Foam::Info.

Here is the call graph for this function:

◆ solveContinuity()

void solveContinuity ( )
protectedvirtual

Solve continuity equation.

Definition at line 254 of file kinematicSingleLayer.C.

References Foam::fvm::ddt(), DebugInFunction, kinematicSingleLayer::deltaRho_, Foam::fvc::div(), Foam::endl(), 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

Solve for film velocity.

Definition at line 286 of file kinematicSingleLayer.C.

References Foam::fvm::ddt(), DebugInFunction, Foam::fvm::div(), Foam::endl(), Foam::fvc::flux(), Foam::fvc::interpolate(), pp(), Foam::fvc::reconstruct(), Foam::fvc::snGrad(), Foam::solve(), tUEqn(), and UEqn.

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

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

◆ solveThickness()

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

Solve coupled velocity-thickness equations.

Definition at line 341 of file kinematicSingleLayer.C.

References Foam::fvm::ddt(), DebugInFunction, Foam::fvm::div(), Foam::endl(), Foam::fvc::flux(), fvMatrix< Type >::flux(), Foam::fvc::interpolate(), Foam::fvm::laplacian(), phid(), pp(), Foam::fvc::reconstruct(), rhof(), Foam::fvc::snGrad(), fvMatrix< Type >::solve(), and UEqn.

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

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

◆ TypeName()

TypeName ( "kinematicSingleLayer"  )

Runtime type information.

◆ CourantNumber()

◆ momentumPredictor()

Switch momentumPredictor ( ) const
inline

Return the momentum predictor.

Definition at line 37 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::momentumPredictor_.

◆ nOuterCorr()

label nOuterCorr ( ) const
inline

Return the number of outer correctors.

Definition at line 43 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::nOuterCorr_.

◆ nCorr()

label nCorr ( ) const
inline

Return the number of PISO correctors.

Definition at line 49 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::nCorr_.

◆ nNonOrthCorr()

label nNonOrthCorr ( ) const
inline

Return the number of non-orthogonal correctors.

Definition at line 55 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::nNonOrthCorr_.

◆ deltaSmall()

const dimensionedScalar & deltaSmall ( ) const
inline

Return small delta.

Definition at line 61 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::deltaSmall_.

Referenced by thixotropicViscosity::correct().

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 67 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::mu_.

◆ sigma()

const volScalarField & sigma ( ) const
inlinevirtual

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

Implements surfaceFilmRegionModel.

Definition at line 73 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::sigma_.

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

Here is the caller graph for this function:

◆ delta()

◆ alpha()

const volScalarField & alpha ( ) const
inlinevirtual

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

Implements surfaceFilmRegionModel.

Definition at line 85 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::alpha_.

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

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 945 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 951 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 957 of file kinematicSingleLayer.C.

References kinematicSingleLayer::Uw_.

Referenced by thixotropicViscosity::correct().

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 963 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 969 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 981 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 990 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 999 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 1008 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 1017 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 1026 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 1035 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 1041 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 1047 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

External hook to add sources to the film.

Implements surfaceFilmRegionModel.

Reimplemented in thermoSingleLayer.

Definition at line 823 of file kinematicSingleLayer.C.

References DebugInFunction, Foam::endl(), Foam::nl, and Foam::type().

Referenced by thermoSingleLayer::addSources().

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

◆ USpPrimary()

volVectorField & USpPrimary ( )
inline

Momentum [kg/m/s2].

Definition at line 91 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::USpPrimary_.

◆ pSpPrimary()

volScalarField & pSpPrimary ( )
inline

Pressure [Pa].

Definition at line 97 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::pSpPrimary_.

◆ rhoSpPrimary()

volScalarField & rhoSpPrimary ( )
inline

Mass [kg/m2/s].

Definition at line 103 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::rhoSpPrimary_.

◆ USp() [1/2]

volVectorField & USp ( )
inline

Momentum [kg/m/s2].

Definition at line 109 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::USp_.

◆ pSp() [1/2]

volScalarField & pSp ( )
inline

Pressure [Pa].

Definition at line 115 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::pSp_.

◆ rhoSp() [1/2]

volScalarField & rhoSp ( )
inline

Mass [kg/m2/s].

Definition at line 121 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 127 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::USp_.

◆ pSp() [2/2]

const volScalarField & pSp ( ) const
inline

Pressure [Pa].

Definition at line 133 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::pSp_.

◆ rhoSp() [2/2]

const volScalarField & rhoSp ( ) const
inline

Mass [kg/m2/s].

Definition at line 139 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::rhoSp_.

◆ UPrimary()

const volVectorField & UPrimary ( ) const
inline

Velocity [m/s].

Definition at line 145 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::UPrimary_.

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

Here is the caller graph for this function:

◆ pPrimary()

const volScalarField & pPrimary ( ) const
inline

Pressure [Pa].

Definition at line 151 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::pPrimary_.

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

Here is the caller graph for this function:

◆ rhoPrimary()

const volScalarField & rhoPrimary ( ) const
inline

Density [kg/m3].

Definition at line 157 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::rhoPrimary_.

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

Here is the caller graph for this function:

◆ muPrimary()

const volScalarField & muPrimary ( ) const
inline

Viscosity [Pa.s].

Definition at line 163 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 169 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 175 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::injection_.

◆ transfer()

transferModelList & transfer ( )
inline

Transfer.

Definition at line 181 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::transfer_.

◆ turbulence()

const filmTurbulenceModel & turbulence ( ) const
inline

Turbulence.

Definition at line 187 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::turbulence_.

◆ mass()

tmp< volScalarField > mass ( ) const
inline

Return the current film mass.

Definition at line 193 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::deltaRho_, and singleLayerRegion::magSf().

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 199 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 205 of file kinematicSingleLayerI.H.

References surfaceFilmRegionModel::g_, singleLayerRegion::nHat(), IOobjectOption::NO_READ, IOobjectOption::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 227 of file kinematicSingleLayerI.H.

References surfaceFilmRegionModel::g_, singleLayerRegion::nHat(), IOobjectOption::NO_READ, IOobjectOption::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() [1/2]

tmp< volVectorField > gTan ( ) const
inline

Return the gravity tangential component contributions.

Definition at line 252 of file kinematicSingleLayerI.H.

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

Here is the call graph for this function:

◆ gTan() [2/2]

tmp< vectorField > gTan ( const label  patchI) const
inline

Return the gravity tangential component contributions for patchI.

Definition at line 274 of file kinematicSingleLayerI.H.

References g.

◆ preEvolveRegion()

◆ evolveRegion()

◆ postEvolveRegion()

void postEvolveRegion ( )
virtual

Post-evolve film hook.

Reimplemented from regionModel.

Definition at line 905 of file kinematicSingleLayer.C.

References DebugInFunction, Foam::endl(), and kinematicSingleLayer::resetPrimaryRegionSourceTerms().

Here is the call graph for this function:

◆ Srho() [1/2]

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

Return total mass source - Eulerian phase only.

Implements surfaceFilmModel.

Reimplemented in thermoSingleLayer.

Definition at line 1078 of file kinematicSingleLayer.C.

References Foam::dimMass, Foam::dimTime, Foam::dimVolume, tmp< T >::New(), IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, regionModel::primaryMesh(), regionModel::time(), timeName, and Foam::Zero.

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 1098 of file kinematicSingleLayer.C.

References Foam::dimMass, Foam::dimTime, Foam::dimVolume, Foam::name(), tmp< T >::New(), IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, timeName, and Foam::Zero.

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 1119 of file kinematicSingleLayer.C.

References Foam::dimEnergy, Foam::dimTime, Foam::dimVolume, tmp< T >::New(), IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, regionModel::primaryMesh(), regionModel::time(), timeName, and Foam::Zero.

Here is the call graph for this function:

◆ info()

Member Data Documentation

◆ momentumPredictor_

Switch momentumPredictor_
protected

Momentum predictor.

Definition at line 91 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::momentumPredictor(), and kinematicSingleLayer::read().

◆ nOuterCorr_

label nOuterCorr_
protected

◆ nCorr_

label nCorr_
protected

◆ nNonOrthCorr_

label nNonOrthCorr_
protected

Number of non-orthogonal correctors.

Definition at line 106 of file kinematicSingleLayer.H.

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

◆ cumulativeContErr_

scalar cumulativeContErr_
protected

Cumulative continuity error.

Definition at line 111 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::continuityCheck().

◆ deltaSmall_

const dimensionedScalar deltaSmall_
protected

Small delta.

Definition at line 116 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::correctAlpha(), and kinematicSingleLayer::deltaSmall().

◆ deltaCoLimit_

scalar deltaCoLimit_
protected

Film thickness above which Courant number calculation in valid.

Definition at line 121 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::CourantNumber().

◆ rho_

◆ mu_

volScalarField mu_
protected

Dynamic viscosity [Pa.s].

Definition at line 136 of file kinematicSingleLayer.H.

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

◆ sigma_

◆ delta_

◆ alpha_

◆ U_

◆ Us_

volVectorField Us_
protected

Velocity - surface [m/s].

Definition at line 164 of file kinematicSingleLayer.H.

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

◆ Uw_

volVectorField Uw_
protected

Velocity - wall [m/s].

Definition at line 169 of file kinematicSingleLayer.H.

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

◆ deltaRho_

◆ phi_

surfaceScalarField phi_
protected

◆ primaryMassTrans_

volScalarField primaryMassTrans_
protected

Film mass available for transfer to the primary region.

Definition at line 187 of file kinematicSingleLayer.H.

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

◆ cloudMassTrans_

◆ cloudDiameterTrans_

volScalarField cloudDiameterTrans_
protected

◆ USp_

◆ pSp_

◆ rhoSp_

◆ USpPrimary_

◆ pSpPrimary_

◆ rhoSpPrimary_

◆ UPrimary_

volVectorField UPrimary_
protected

◆ pPrimary_

◆ rhoPrimary_

◆ muPrimary_

volScalarField muPrimary_
protected

◆ filmThermo_

◆ availableMass_

scalarField availableMass_
protected

Available mass for transfer via sub-models.

Definition at line 275 of file kinematicSingleLayer.H.

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

◆ injection_

◆ transfer_

◆ turbulence_

◆ forces_

forceList forces_
protected

List of film forces.

Definition at line 295 of file kinematicSingleLayer.H.

◆ addedMassTotal_

scalar addedMassTotal_
protected

Cumulative mass added via sources [kg].

Definition at line 303 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::info(), and kinematicSingleLayer::transferPrimaryRegionSourceFields().


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