Thermodynamic form of single-cell layer surface film model. More...
Public Member Functions | |
| TypeName ("thermoSingleLayer") | |
| Runtime type information. More... | |
| thermoSingleLayer (const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word ®ionType, const bool readFields=true) | |
| Construct from components. More... | |
| virtual | ~thermoSingleLayer () |
| Destructor. More... | |
| const SLGThermo & | thermo () const |
| Return const reference to the SLGThermo object. More... | |
| virtual const volScalarField & | Cp () const |
| Return the film specific heat capacity [J/kg/K]. More... | |
| virtual const volScalarField & | kappa () const |
| Return the film thermal conductivity [W/m/K]. More... | |
| virtual const volScalarField & | T () const |
| Return the film mean temperature [K]. More... | |
| virtual const volScalarField & | Ts () const |
| Return the film surface temperature [K]. More... | |
| virtual const volScalarField & | Tw () const |
| Return the film wall temperature [K]. More... | |
| virtual const volScalarField & | hs () const |
| Return the film sensible enthalpy [J/kg]. More... | |
| tmp< scalarField > | hs (const scalarField &T, const label patchi) const |
| Return sensible enthalpy as a function of temperature. More... | |
| tmp< volScalarField > | hs (const volScalarField &T) const |
| Return sensible enthalpy as a function of temperature. More... | |
| tmp< volScalarField > | T (const volScalarField &hs) const |
| Return temperature as a function of sensible enthalpy. More... | |
| virtual void | addSources (const label patchi, const label facei, const scalar massSource, const vector &momentumSource, const scalar pressureSource, const scalar energySource) |
| External hook to add sources to the film. More... | |
| const volScalarField & | hsSp () const |
| Energy [J/m2/s]. More... | |
| const volScalarField & | hsSpPrimary () const |
| Energy [J/m2/s]. More... | |
| const volScalarField & | TPrimary () const |
| Temperature [K]. More... | |
| const PtrList< volScalarField > & | YPrimary () const |
| Specie mass fractions [0-1]. More... | |
| const heatTransferModel & | htcs () const |
| Return const access to the (surface) heat transfer model. More... | |
| const heatTransferModel & | htcw () const |
| Return const access to the (wall) heat transfer model. More... | |
| const phaseChangeModel & | phaseChange () const |
| Return const access to the phase change model. More... | |
| const filmRadiationModel & | radiation () const |
| Return const access to the radiation model. More... | |
| tmp< scalarField > | qconvw (const label patchi) const |
| Return the convective heat energy from film to wall. More... | |
| tmp< scalarField > | qconvp (const label patchi) const |
| Return the convective heat energy from primary region to film. More... | |
| virtual void | preEvolveRegion () |
| Pre-evolve film hook. More... | |
| virtual void | evolveRegion () |
| Evolve the film equations. More... | |
| virtual tmp< volScalarField::Internal > | Srho () const |
| Return total mass source - Eulerian phase only. More... | |
| virtual tmp< volScalarField::Internal > | Srho (const label i) const |
| Return mass source for specie i - Eulerian phase only. More... | |
| virtual tmp< volScalarField::Internal > | Sh () const |
| Return enthalpy source - Eulerian phase only. More... | |
| virtual void | info () |
| Provide some feedback. More... | |
 Public Member Functions inherited from kinematicSingleLayer | |
| TypeName ("kinematicSingleLayer") | |
| Runtime type information. More... | |
| kinematicSingleLayer (const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word ®ionType, 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 dimensionedScalar & | deltaSmall () const |
| Return small delta. More... | |
| const volScalarField & | mu () const |
| Return const access to the dynamic viscosity [Pa.s]. More... | |
| const volScalarField & | sigma () const |
| Return const access to the surface tension [kg/s2]. More... | |
| const volScalarField & | delta () const |
| Return const access to the film thickness [m]. More... | |
| const volScalarField & | alpha () const |
| Return the film coverage, 1 = covered, 0 = uncovered []. More... | |
| virtual const volVectorField & | U () const |
| Return the film velocity [m/s]. More... | |
| virtual const volVectorField & | Us () const |
| Return the film surface velocity [m/s]. More... | |
| virtual const volVectorField & | Uw () const |
| Return the film wall velocity [m/s]. More... | |
| virtual const volScalarField & | deltaRho () const |
| Return the film thickness*density (helper field) [kg/m3]. More... | |
| virtual const surfaceScalarField & | phi () const |
| Return the film flux [kg.m/s]. More... | |
| virtual const volScalarField & | rho () const |
| Return the film density [kg/m3]. More... | |
| virtual tmp< volScalarField > | primaryMassTrans () const |
| Return mass transfer source - Eulerian phase only. More... | |
| virtual const volScalarField & | cloudMassTrans () const |
| Return the film mass available for transfer to cloud. More... | |
| virtual const volScalarField & | cloudDiameterTrans () const |
| Return the parcel diameters originating from film to cloud. More... | |
| volVectorField & | USpPrimary () |
| Momentum [kg/m/s2]. More... | |
| volScalarField & | pSpPrimary () |
| Pressure [Pa]. More... | |
| volScalarField & | rhoSpPrimary () |
| Mass [kg/m2/s]. More... | |
| volVectorField & | USp () |
| Momentum [kg/m/s2]. More... | |
| volScalarField & | pSp () |
| Pressure [Pa]. More... | |
| volScalarField & | rhoSp () |
| Mass [kg/m2/s]. More... | |
| const volVectorField & | USp () const |
| Momentum [kg/m/s2]. More... | |
| const volScalarField & | pSp () const |
| Pressure [Pa]. More... | |
| const volScalarField & | rhoSp () const |
| Mass [kg/m2/s]. More... | |
| const volVectorField & | UPrimary () const |
| Velocity [m/s]. More... | |
| const volScalarField & | pPrimary () const |
| Pressure [Pa]. More... | |
| const volScalarField & | rhoPrimary () const |
| Density [kg/m3]. More... | |
| const volScalarField & | muPrimary () const |
| Viscosity [Pa.s]. More... | |
| const filmThermoModel & | filmThermo () const |
| Film thermo. More... | |
| injectionModelList & | injection () |
| Injection. More... | |
| transferModelList & | transfer () |
| Transfer. More... | |
| const filmTurbulenceModel & | turbulence () const |
| Turbulence. More... | |
| tmp< volScalarField > | mass () const |
| Return the current film mass. More... | |
| tmp< volScalarField > | deltaMass () const |
| Return the change in film mass due to sources/sinks. More... | |
| tmp< volScalarField > | gNorm () const |
| Return the gravity normal-to-patch component contribution. More... | |
| tmp< volScalarField > | gNormClipped () const |
| Return the gravity normal-to-patch component contribution. More... | |
| tmp< volVectorField > | gTan () const |
| Return the gravity tangential component contributions. More... | |
| tmp< vectorField > | gTan (const label patchI) const |
| Return the gravity tangential component contributions for patchI. More... | |
| virtual void | postEvolveRegion () |
| Post-evolve film hook. 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 ®ionType) | |
| Construct from type name, mesh and gravity vector. More... | |
| virtual | ~surfaceFilmRegionModel () |
| Destructor. More... | |
| const dimensionedVector & | g () 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 ®ionType),(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 ®ionType) | |
| Construct null. More... | |
| singleLayerRegion (const fvMesh &mesh, const word ®ionType, const word &modelName, bool readFields=true) | |
| Construct from mesh, region type and name. More... | |
| virtual | ~singleLayerRegion () |
| Destructor. More... | |
| virtual const volVectorField & | nHat () const |
| Return the patch normal vectors. More... | |
| virtual const volScalarField & | magSf () const |
| Return the face area magnitudes / [m2]. More... | |
| virtual const labelList & | passivePatchIDs () 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 ®ionType) | |
| Construct null. More... | |
| regionModel (const fvMesh &mesh, const word ®ionType, const word &modelName, bool readFields=true) | |
| Construct from mesh, region type and name. More... | |
| regionModel (const fvMesh &mesh, const word ®ionType, const word &modelName, const dictionary &dict, bool readFields=true) | |
| Construct from mesh and name and dict. More... | |
| virtual | ~regionModel ()=default |
| Destructor. More... | |
| const fvMesh & | primaryMesh () const noexcept |
| Return the reference to the primary mesh database. More... | |
| const Time & | time () 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 word & | modelName () const noexcept |
| Return the model name. More... | |
| const fvMesh & | regionMesh () const |
| Return the region mesh database. More... | |
| fvMesh & | regionMesh () |
| Return the region mesh database for manipulation. More... | |
| const dictionary & | coeffs () const noexcept |
| Return the model coefficients dictionary. More... | |
| const dictionary & | solution () const |
| Return the solution dictionary. More... | |
| const IOdictionary & | outputProperties () const |
| Return const access to the output properties dictionary. More... | |
| IOdictionary & | outputProperties () |
| Return output properties dictionary. More... | |
| const labelList & | primaryPatchIDs () const noexcept |
| List of patch IDs on the primary region coupled to this region. More... | |
| const labelList & | intCoupledPatchIDs () 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 > ®ionField) 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 > ®ionField, 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 word & | name () 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 | |
| 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 f 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 dictionary * | findMetaData () const noexcept |
| Return pointer to meta-data or nullptr. More... | |
| dictionary & | getMetaData () 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... | |
| Istream & | readStream (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. More... | |
| const labelList & | watchIndices () const noexcept |
| Read access to file-monitoring handles. More... | |
| labelList & | watchIndices () 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 valid) const |
| Write using stream options. More... | |
| virtual bool | write (const bool valid=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 valid) 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 ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from name, instance, registry, io options. More... | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from name, instance, local, registry, io options. More... | |
| IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from path, registry, io options. More... | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, 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 ®istry, 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 ®istry, 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 ®istry) | |
| 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... | |
| autoPtr< IOobject > | clone () const |
| Clone. More... | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. More... | |
| const objectRegistry & | db () const noexcept |
| Return the local objectRegistry. More... | |
| const Time & | time () const |
| Return Time associated with the objectRegistry. More... | |
| const word & | name () const noexcept |
| Return the object name. More... | |
| const word & | headerClassName () const noexcept |
| Return name of the class name read from header. More... | |
| word & | headerClassName () noexcept |
| Return non-constant access to the class name read from header. More... | |
| const string & | note () const noexcept |
| Return the optional note. More... | |
| string & | note () 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... | |
| 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 fileName & | rootPath () const |
| Return the Time::rootPath() More... | |
| const fileName & | caseName () const |
| Return the Time::caseName() More... | |
| const fileName & | instance () const noexcept |
| Read access to instance path component. More... | |
| fileName & | instance () noexcept |
| Write access to instance path component. More... | |
| const fileName & | local () const noexcept |
| Read access to local path component. More... | |
| fileName | path () const |
| The complete path. More... | |
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. More... | |
| fileName | objectPath () const |
| The complete 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 (uses typeFilePath to find file) and check its info. 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< IOobject > | info () const |
| 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) |
| 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 | isReadRequired () const noexcept |
| True if (MUST_READ | MUST_READ_IF_MODIFIED) bits are set. More... | |
| bool | isReadOptional () const noexcept |
| True if (READ_IF_PRESENT) bits are set. More... | |
| readOption & | readOpt () noexcept |
| Access to the read option. More... | |
| writeOption & | writeOpt () 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, reading entries until EOF. Discards the header. 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< dictionary > | clone () const |
| Construct and return clone. More... | |
| virtual | ~dictionary () |
| Destructor. More... | |
| const fileName & | name () const noexcept |
| The dictionary name. More... | |
| fileName & | name () 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 dictionary & | parent () const noexcept |
| Return the parent dictionary. More... | |
| const dictionary & | topDict () 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 entry * | findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Find an entry (const access) with the given keyword. More... | |
| entry * | findEntry (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 entry * | findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Search for a scoped entry (const access) with the given keyword. More... | |
| const dictionary * | findDict (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... | |
| dictionary * | findDict (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 entry & | lookupEntry (const word &keyword, enum keyType::option matchOpt) const |
| Search for an entry (const access) with the given keyword. More... | |
| ITstream & | lookup (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 dictionary & | subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Find and return a sub-dictionary. More... | |
| dictionary & | subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| Find and return a sub-dictionary for manipulation. More... | |
| dictionary & | subDictOrAdd (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 dictionary & | optionalSubDict (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< keyType > | keys (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... | |
| entry * | add (entry *entryPtr, bool mergeEntry=false) |
| Add a new entry. More... | |
| entry * | add (const entry &e, bool mergeEntry=false) |
| Add an entry. More... | |
| entry * | add (const keyType &k, const word &v, bool overwrite=false) |
| Add a word entry. More... | |
| entry * | add (const keyType &k, const string &v, bool overwrite=false) |
| Add a string entry. More... | |
| entry * | add (const keyType &k, const label v, bool overwrite=false) |
| Add a label entry. More... | |
| entry * | add (const keyType &k, const scalar v, bool overwrite=false) |
| Add a scalar entry. More... | |
| entry * | add (const keyType &k, const dictionary &d, bool mergeEntry=false) |
| Add a dictionary entry. More... | |
| template<class T > | |
| entry * | add (const keyType &k, const T &v, bool overwrite=false) |
| Add a T entry. More... | |
| entry * | set (entry *entryPtr) |
| Assign a new entry, overwriting any existing entry. More... | |
| entry * | set (const entry &e) |
| Assign a new entry, overwriting any existing entry. More... | |
| entry * | set (const keyType &k, const dictionary &v) |
| Assign a dictionary entry, overwriting any existing entry. More... | |
| template<class T > | |
| entry * | set (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. More... | |
| bool | read (Istream &is, bool keepHeader) |
| Read dictionary from Istream, optionally keeping the header. 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 dictionary * | cfindScopedDict (const fileName &dictPath) const |
| Locate a sub-dictionary using slash-scoping. More... | |
| const dictionary * | findScopedDict (const fileName &dictPath) const |
| Locate a sub-dictionary using slash-scoping. More... | |
| dictionary * | findScopedDict (const fileName &dictPath) |
| Locate a sub-dictionary using slash-scoping. More... | |
| dictionary * | makeScopedDict (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 entry * | findCompat (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 entry & | lookupEntryCompat (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... | |
| ITstream & | lookupCompat (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 |
| 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 | lookupOrAddDefault (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... | |
| ITstream & | operator[] (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... | |
| entry * | lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) |
| Deprecated(2018-10) More... | |
| const entry * | lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const |
| Deprecated(2018-10) More... | |
| const entry * | lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const |
| Deprecated(2018-10) More... | |
| const dictionary * | subDictPtr (const word &keyword) const |
| Deprecated(2018-10) More... | |
| dictionary * | subDictPtr (const word &keyword) |
| Deprecated(2018-10) Find and return a sub-dictionary pointer if present. More... | |
| const entry & | lookupEntry (const word &keyword, bool recursive, bool patternMatch) const |
| Deprecated(2018-10) More... | |
| ITstream & | lookup (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::entry * | add (const keyType &k, const T &v, bool overwrite) |
| template<class T > | |
| Foam::entry * | set (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... | |
| T * | front () |
| The first entry in the list. More... | |
| const T * | front () const |
| The first entry in the list (const access) More... | |
| T * | back () |
| The last entry in the list. More... | |
| const T * | back () const |
| The last entry in the list (const access) More... | |
| T * | removeHead () |
| Remove and return head. More... | |
| T * | remove (T *item) |
| Remove and return element. More... | |
| T * | remove (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... | |
| Ostream & | writeList (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 iterator & | end () |
| End of list for forward iterators. More... | |
| const const_iterator & | cend () const |
| End of list for forward iterators. More... | |
| const reverse_iterator & | rend () |
| End of list for reverse iterators. More... | |
| const const_reverse_iterator & | crend () const |
| End of list for reverse iterators. More... | |
| const const_iterator & | end () const |
| End of list for forward iterators. More... | |
| const const_reverse_iterator & | rend () const |
| End of list for reverse iterators. More... | |
| T * | first () |
| The first entry in the list. More... | |
| const T * | first () const |
| The first entry in the list (const access) More... | |
| T * | last () |
| The last entry in the list. More... | |
| const T * | last () 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 | correctHsForMappedT () |
| Correct sensible enthalpy for mapped temperature fields. More... | |
| virtual void | updateSurfaceTemperatures () |
| Correct the film surface and wall temperatures. 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 void | correctAlpha () |
| Correct film coverage field. More... | |
| virtual void | updateSubmodels () |
| Update the film sub-models. More... | |
| virtual tmp< fvScalarMatrix > | q (volScalarField &hs) const |
| Return the wall/surface heat transfer term for the enthalpy equation. More... | |
| virtual void | solveEnergy () |
| Solve energy equation. More... | |
| Protected Member Functions inherited from kinematicSingleLayer | |
| virtual tmp< volScalarField > | pu () |
| Explicit pressure source contribution. More... | |
| virtual tmp< volScalarField > | pp () |
| Implicit pressure source coefficient. 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< fvVectorMatrix > | solveMomentum (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 AMIPatchToPatchInterpolation & | interRegionAMI (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 | |
| const SLGThermo & | thermo_ |
| Reference to the SLGThermo. More... | |
| volScalarField | Cp_ |
| Specific heat capacity [J/kg/K]. More... | |
| volScalarField | kappa_ |
| Thermal conductivity [W/m/K]. More... | |
| volScalarField | T_ |
| Temperature - mean [K]. More... | |
| volScalarField | Ts_ |
| Temperature - surface [K]. More... | |
| volScalarField | Tw_ |
| Temperature - wall [K]. More... | |
| volScalarField | hs_ |
| Sensible enthalpy [J/kg]. More... | |
| volScalarField | primaryEnergyTrans_ |
| Film energy transfer. More... | |
| scalar | deltaWet_ |
| Threshold film thickness beyond which the film is considered 'wet'. More... | |
| bool | hydrophilic_ |
| Activation flag. More... | |
| scalar | hydrophilicDryScale_ |
| Length scale applied to deltaWet_ to determine when a wet. More... | |
| scalar | hydrophilicWetScale_ |
| Length scale applied to deltaWet_ to determine when a dry. More... | |
| volScalarField | hsSp_ |
| Energy [J/m2/s]. More... | |
| volScalarField | hsSpPrimary_ |
| Energy [J/m2/s]. More... | |
| volScalarField | TPrimary_ |
| Temperature [K]. More... | |
| PtrList< volScalarField > | YPrimary_ |
| List of specie mass fractions [0-1]. More... | |
| autoPtr< filmViscosityModel > | viscosity_ |
| Viscosity model. More... | |
| autoPtr< heatTransferModel > | htcs_ |
| Heat transfer coefficient between film surface and primary. More... | |
| autoPtr< heatTransferModel > | htcw_ |
| Heat transfer coefficient between wall and film [W/m2/K]. More... | |
| autoPtr< phaseChangeModel > | phaseChange_ |
| Phase change. More... | |
| autoPtr< filmRadiationModel > | radiation_ |
| Radiation. More... | |
| scalar | Tmin_ |
| Minimum temperature limit (optional) More... | |
| scalar | Tmax_ |
| Maximum temperature limit (optional) More... | |
| Protected Attributes inherited from kinematicSingleLayer | |
| 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< filmThermoModel > | filmThermo_ |
| 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< filmTurbulenceModel > | turbulence_ |
| 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 dimensionedVector & | g_ |
| Acceleration due to gravity [m/s2]. More... | |
| Protected Attributes inherited from singleLayerRegion | |
| autoPtr< volVectorField > | nHatPtr_ |
| Patch normal vectors. More... | |
| autoPtr< volScalarField > | magSfPtr_ |
| Face area magnitudes / [m2]. More... | |
| labelList | passivePatchIDs_ |
| List of patch IDs opposite to internally coupled patches. More... | |
| Protected Attributes inherited from regionModel | |
| const fvMesh & | primaryMesh_ |
| Reference to the primary mesh database. More... | |
| const Time & | time_ |
| 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< IOdictionary > | outputPropertiesPtr_ |
| 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, MUST_READ_IF_MODIFIED = 0x3, 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 } |
| 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 T * | pointer |
| Pointer for value_type. More... | |
| typedef const T * | const_pointer |
| Const pointer for value_type. More... | |
| typedef T & | reference |
| Reference for value_type. More... | |
| typedef const T & | const_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< surfaceFilmModel > | New (const fvMesh &mesh, const dimensionedVector &g, const word ®ionType="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 *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 IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. More... | |
| static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
| Write the standard OpenFOAM file/dictionary banner. More... | |
| static Ostream & | writeDivider (Ostream &os) |
| Write the standard file section divider. More... | |
| static Ostream & | writeEndDivider (Ostream &os) |
| Write the standard end file divider. More... | |
| Static Public Member Functions inherited from IOobjectOption | |
| static bool | isReadRequired (readOption opt) noexcept |
| True if (MUST_READ | MUST_READ_IF_MODIFIED) bits are set. More... | |
| static bool | isReadOptional (readOption opt) noexcept |
| True if (READ_IF_PRESENT) bits are set. 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< dictionary > | New (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< fileCheckTypes > | fileCheckTypesNames |
| 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< OSstream > | reportingOutput |
| 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... | |
Thermodynamic form of single-cell layer surface film model.
Note: defining enthalpy as Cp(T - Tstd) - when using liquids from the thermophysical library, their enthalpies are calculated similarly, where Tstd = 298.15K. This is clearly non-conservative unless the heat-capacity is constant and should be rewritten to use the standard thermodynamics packages.
Definition at line 63 of file thermoSingleLayer.H.
| thermoSingleLayer | ( | const word & | modelType, |
| const fvMesh & | mesh, | ||
| const dimensionedVector & | g, | ||
| const word & | regionType, | ||
| const bool | readFields = true |
||
| ) |
Construct from components.
Definition at line 305 of file thermoSingleLayer.C.
References IOobjectOption::AUTO_WRITE, Foam::dimless, Foam::endl(), Foam::fvc::flux(), forAll, Foam::Info, IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, Foam::constant::electromagnetic::phi0, IOobjectOption::READ_IF_PRESENT, Foam::readFields(), readIfPresent(), timeName, and Foam::Zero.
|
virtual |
Destructor.
Definition at line 557 of file thermoSingleLayer.C.
|
protectedvirtual |
Read control parameters from dictionary.
Reimplemented from kinematicSingleLayer.
Definition at line 81 of file thermoSingleLayer.C.
References kinematicSingleLayer::read().
|
protectedvirtual |
Correct the thermo fields.
Reimplemented from kinematicSingleLayer.
Definition at line 98 of file thermoSingleLayer.C.
References thermoSingleLayer::Cp_, kinematicSingleLayer::filmThermo_, thermoSingleLayer::kappa_, kinematicSingleLayer::rho_, and kinematicSingleLayer::sigma_.
Referenced by thermoSingleLayer::solveEnergy().
|
protectedvirtual |
Correct sensible enthalpy for mapped temperature fields.
Definition at line 107 of file thermoSingleLayer.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), forAll, thermoSingleLayer::hs(), thermoSingleLayer::hs_, Foam::isA(), and thermoSingleLayer::T_.
Referenced by thermoSingleLayer::updateSurfaceTemperatures().
|
protectedvirtual |
Correct the film surface and wall temperatures.
Definition at line 124 of file thermoSingleLayer.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), polyMesh::boundaryMesh(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), thermoSingleLayer::correctHsForMappedT(), regionModel::intCoupledPatchIDs_, kinematicSingleLayer::pp(), regionModel::regionMesh(), UList< T >::size(), thermoSingleLayer::T_, thermoSingleLayer::Ts_, and thermoSingleLayer::Tw_.
Referenced by thermoSingleLayer::solveEnergy().
|
protectedvirtual |
Reset source term fields.
Reimplemented from kinematicSingleLayer.
Definition at line 88 of file thermoSingleLayer.C.
References DebugInFunction, DimensionedField< Type, GeoMesh >::dimensions(), Foam::endl(), thermoSingleLayer::hsSp_, thermoSingleLayer::hsSpPrimary_, kinematicSingleLayer::resetPrimaryRegionSourceTerms(), and Foam::Zero.
|
protectedvirtual |
Transfer thermo fields from the primary region to the film region.
Reimplemented from kinematicSingleLayer.
Definition at line 144 of file thermoSingleLayer.C.
References GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), DebugInFunction, Foam::endl(), forAll, thermoSingleLayer::TPrimary_, kinematicSingleLayer::transferPrimaryRegionThermoFields(), and thermoSingleLayer::YPrimary_.
|
protectedvirtual |
Transfer source fields from the primary region to the film region.
Reimplemented from kinematicSingleLayer.
Definition at line 160 of file thermoSingleLayer.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), DebugInFunction, TimeState::deltaTValue(), Foam::endl(), forAll, thermoSingleLayer::hsSp_, thermoSingleLayer::hsSpPrimary_, singleLayerRegion::magSf(), regionModel::primaryMesh(), regionModel::time_, and kinematicSingleLayer::transferPrimaryRegionSourceFields().
|
protectedvirtual |
Correct film coverage field.
Reimplemented from kinematicSingleLayer.
Definition at line 189 of file thermoSingleLayer.C.
References kinematicSingleLayer::alpha_, GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), kinematicSingleLayer::delta_, thermoSingleLayer::deltaWet_, Foam::dimLength, forAll, thermoSingleLayer::hydrophilic_, thermoSingleLayer::hydrophilicDryScale_, thermoSingleLayer::hydrophilicWetScale_, and Foam::pos0().
|
protectedvirtual |
Update the film sub-models.
Reimplemented from kinematicSingleLayer.
Definition at line 218 of file thermoSingleLayer.C.
References kinematicSingleLayer::availableMass_, kinematicSingleLayer::cloudDiameterTrans_, kinematicSingleLayer::cloudMassTrans_, transferModelList::correct(), injectionModelList::correct(), DebugInFunction, TimeState::deltaTValue(), Foam::endl(), thermoSingleLayer::hs_, thermoSingleLayer::hsSp_, thermoSingleLayer::htcs_, thermoSingleLayer::htcw_, kinematicSingleLayer::injection_, singleLayerRegion::magSf(), thermoSingleLayer::phaseChange_, thermoSingleLayer::primaryEnergyTrans_, kinematicSingleLayer::primaryMassTrans_, kinematicSingleLayer::pSp_, thermoSingleLayer::radiation_, kinematicSingleLayer::rhoPrimary_, kinematicSingleLayer::rhoSp_, Foam::sqr(), regionModel::time(), regionModel::time_, kinematicSingleLayer::transfer_, and kinematicSingleLayer::turbulence_.
Referenced by thermoSingleLayer::evolveRegion().
|
protectedvirtual |
Return the wall/surface heat transfer term for the enthalpy equation.
Definition at line 256 of file thermoSingleLayer.C.
References kinematicSingleLayer::alpha_, thermoSingleLayer::Cp_, thermoSingleLayer::hs(), thermoSingleLayer::htcs_, thermoSingleLayer::htcw_, Foam::fvm::Sp(), thermoSingleLayer::T_, thermoSingleLayer::TPrimary_, and thermoSingleLayer::Tw_.
Referenced by thermoSingleLayer::solveEnergy().
|
protectedvirtual |
Solve energy equation.
Definition at line 271 of file thermoSingleLayer.C.
References thermoSingleLayer::correctThermoFields(), Foam::fvm::ddt(), DebugInFunction, kinematicSingleLayer::deltaRho_, DimensionedField< Type, GeoMesh >::dimensions(), Foam::fvm::div(), Foam::constant::electromagnetic::e, Foam::endl(), thermoSingleLayer::hs_, thermoSingleLayer::hsSp_, kinematicSingleLayer::phi_, kinematicSingleLayer::pPrimary_, thermoSingleLayer::q(), thermoSingleLayer::radiation_, Foam::solve(), thermoSingleLayer::T_, thermoSingleLayer::updateSurfaceTemperatures(), and thermoSingleLayer::viscosity_.
Referenced by thermoSingleLayer::evolveRegion().
| TypeName | ( | "thermoSingleLayer" | ) |
Runtime type information.
Return const reference to the SLGThermo object.
Definition at line 37 of file thermoSingleLayerI.H.
References thermoSingleLayer::thermo_.
Referenced by standardPhaseChange::correctModel(), and waxSolventEvaporation::correctModel().
|
virtual |
Return the film specific heat capacity [J/kg/K].
Reimplemented from kinematicSingleLayer.
Definition at line 643 of file thermoSingleLayer.C.
References thermoSingleLayer::Cp_.
|
virtual |
Return the film thermal conductivity [W/m/K].
Reimplemented from kinematicSingleLayer.
Definition at line 649 of file thermoSingleLayer.C.
References thermoSingleLayer::kappa_.
|
virtual |
Return the film mean temperature [K].
Reimplemented from kinematicSingleLayer.
Definition at line 655 of file thermoSingleLayer.C.
References thermoSingleLayer::T_.
Referenced by standardPhaseChange::correctModel(), waxSolventEvaporation::correctModel(), solidification::correctModel(), and thermoSingleLayer::evolveRegion().
|
virtual |
Return the film surface temperature [K].
Reimplemented from kinematicSingleLayer.
Definition at line 661 of file thermoSingleLayer.C.
References thermoSingleLayer::Ts_.
Referenced by filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs().
|
virtual |
Return the film wall temperature [K].
Reimplemented from kinematicSingleLayer.
Definition at line 667 of file thermoSingleLayer.C.
References thermoSingleLayer::Tw_.
|
virtual |
Return the film sensible enthalpy [J/kg].
Reimplemented from kinematicSingleLayer.
Definition at line 673 of file thermoSingleLayer.C.
References thermoSingleLayer::hs_.
Referenced by thermoSingleLayer::correctHsForMappedT(), standardPhaseChange::correctModel(), waxSolventEvaporation::correctModel(), and thermoSingleLayer::q().
|
inline |
Return sensible enthalpy as a function of temperature.
for a patch
Definition at line 44 of file thermoSingleLayerI.H.
|
inline |
Return sensible enthalpy as a function of temperature.
Definition at line 55 of file thermoSingleLayerI.H.
References IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, and Foam::T().
|
inline |
Return temperature as a function of sensible enthalpy.
Definition at line 78 of file thermoSingleLayerI.H.
References IOobject::name(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, and tmp< T >::ref().
|
virtual |
External hook to add sources to the film.
Reimplemented from kinematicSingleLayer.
Definition at line 564 of file thermoSingleLayer.C.
References kinematicSingleLayer::addSources(), DebugInfo, and Foam::nl.
|
inline |
Energy [J/m2/s].
Definition at line 105 of file thermoSingleLayerI.H.
References thermoSingleLayer::hsSp_.
|
inline |
Energy [J/m2/s].
Definition at line 111 of file thermoSingleLayerI.H.
References thermoSingleLayer::hsSpPrimary_.
|
inline |
Temperature [K].
Definition at line 117 of file thermoSingleLayerI.H.
References thermoSingleLayer::TPrimary_.
|
inline |
Specie mass fractions [0-1].
Definition at line 123 of file thermoSingleLayerI.H.
References thermoSingleLayer::YPrimary_.
Referenced by standardPhaseChange::correctModel(), and waxSolventEvaporation::correctModel().
|
inline |
Return const access to the (surface) heat transfer model.
Definition at line 129 of file thermoSingleLayerI.H.
References thermoSingleLayer::htcs_.
|
inline |
Return const access to the (wall) heat transfer model.
Definition at line 135 of file thermoSingleLayerI.H.
References thermoSingleLayer::htcw_.
Referenced by filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs().
|
inline |
Return const access to the phase change model.
Definition at line 141 of file thermoSingleLayerI.H.
References thermoSingleLayer::phaseChange_.
|
inline |
Return const access to the radiation model.
Definition at line 147 of file thermoSingleLayerI.H.
References thermoSingleLayer::radiation_.
|
inline |
Return the convective heat energy from film to wall.
Definition at line 153 of file thermoSingleLayerI.H.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), thermoSingleLayer::htcw_, thermoSingleLayer::T_, and thermoSingleLayer::Tw_.
|
inline |
Return the convective heat energy from primary region to film.
Definition at line 163 of file thermoSingleLayerI.H.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), thermoSingleLayer::htcs_, thermoSingleLayer::T_, and thermoSingleLayer::TPrimary_.
|
virtual |
Pre-evolve film hook.
Reimplemented from kinematicSingleLayer.
Definition at line 590 of file thermoSingleLayer.C.
References DebugInFunction, Foam::dimEnergy, Foam::endl(), kinematicSingleLayer::preEvolveRegion(), thermoSingleLayer::primaryEnergyTrans_, and Foam::Zero.
|
virtual |
Evolve the film equations.
Reimplemented from kinematicSingleLayer.
Definition at line 599 of file thermoSingleLayer.C.
References DebugInFunction, kinematicSingleLayer::delta_, kinematicSingleLayer::deltaRho_, Foam::endl(), thermoSingleLayer::hs_, kinematicSingleLayer::nCorr_, kinematicSingleLayer::nOuterCorr_, kinematicSingleLayer::pp(), kinematicSingleLayer::pu(), kinematicSingleLayer::rho_, kinematicSingleLayer::solveContinuity(), thermoSingleLayer::solveEnergy(), kinematicSingleLayer::solveMomentum(), kinematicSingleLayer::solveThickness(), thermoSingleLayer::T(), thermoSingleLayer::T_, tUEqn(), UEqn, and thermoSingleLayer::updateSubmodels().
|
virtual |
Return total mass source - Eulerian phase only.
Reimplemented from kinematicSingleLayer.
Definition at line 694 of file thermoSingleLayer.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), polyMesh::boundaryMesh(), cells, TimeState::deltaTValue(), Foam::dimMass, Foam::dimTime, Foam::dimVolume, polyBoundaryMesh::faceCells(), forAll, regionModel::intCoupledPatchIDs(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, kinematicSingleLayer::primaryMassTrans_, regionModel::primaryMesh(), regionModel::primaryPatchIDs(), tmp< T >::ref(), regionModel::time(), regionModel::time_, timeName, regionModel::toPrimary(), fvMesh::V(), and Foam::Zero.
|
virtual |
Return mass source for specie i - Eulerian phase only.
Reimplemented from kinematicSingleLayer.
Definition at line 742 of file thermoSingleLayer.C.
References cells, Foam::dimMass, Foam::dimTime, Foam::dimVolume, forAll, Foam::name(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, tmp< T >::ref(), and Foam::Zero.
|
virtual |
Return enthalpy source - Eulerian phase only.
Reimplemented from kinematicSingleLayer.
Definition at line 796 of file thermoSingleLayer.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), polyMesh::boundaryMesh(), cells, TimeState::deltaTValue(), Foam::dimEnergy, Foam::dimTime, Foam::dimVolume, polyBoundaryMesh::faceCells(), forAll, regionModel::intCoupledPatchIDs_, IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, thermoSingleLayer::primaryEnergyTrans_, regionModel::primaryMesh(), regionModel::primaryPatchIDs(), tmp< T >::ref(), regionModel::time(), regionModel::time_, timeName, regionModel::toPrimary(), fvMesh::V(), and Foam::Zero.
|
virtual |
Provide some feedback.
Reimplemented from kinematicSingleLayer.
Definition at line 679 of file thermoSingleLayer.C.
References Foam::gAverage(), Foam::gMax(), Foam::gMin(), Foam::indent(), Foam::Info, kinematicSingleLayer::info(), Foam::nl, thermoSingleLayer::phaseChange_, and thermoSingleLayer::T_.
|
protected |
Reference to the SLGThermo.
Definition at line 94 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::thermo().
|
protected |
Specific heat capacity [J/kg/K].
Definition at line 102 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::correctThermoFields(), thermoSingleLayer::Cp(), and thermoSingleLayer::q().
|
protected |
Thermal conductivity [W/m/K].
Definition at line 107 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::correctThermoFields(), and thermoSingleLayer::kappa().
|
protected |
Temperature - mean [K].
Definition at line 112 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::correctHsForMappedT(), thermoSingleLayer::evolveRegion(), thermoSingleLayer::info(), thermoSingleLayer::q(), thermoSingleLayer::qconvp(), thermoSingleLayer::qconvw(), thermoSingleLayer::solveEnergy(), thermoSingleLayer::T(), and thermoSingleLayer::updateSurfaceTemperatures().
|
protected |
Temperature - surface [K].
Definition at line 117 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::Ts(), and thermoSingleLayer::updateSurfaceTemperatures().
|
protected |
Temperature - wall [K].
Definition at line 122 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::q(), thermoSingleLayer::qconvw(), thermoSingleLayer::Tw(), and thermoSingleLayer::updateSurfaceTemperatures().
|
protected |
Sensible enthalpy [J/kg].
Definition at line 127 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::correctHsForMappedT(), thermoSingleLayer::evolveRegion(), thermoSingleLayer::hs(), thermoSingleLayer::solveEnergy(), and thermoSingleLayer::updateSubmodels().
|
protected |
Film energy transfer.
Definition at line 135 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::preEvolveRegion(), thermoSingleLayer::Sh(), and thermoSingleLayer::updateSubmodels().
|
protected |
Threshold film thickness beyond which the film is considered 'wet'.
Definition at line 141 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::correctAlpha().
|
protected |
Activation flag.
Definition at line 149 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::correctAlpha().
|
protected |
Length scale applied to deltaWet_ to determine when a wet.
surface becomes dry, typically 0.5
Definition at line 156 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::correctAlpha().
|
protected |
Length scale applied to deltaWet_ to determine when a dry.
surface becomes wet, typically 0.001
Definition at line 163 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::correctAlpha().
|
protected |
Energy [J/m2/s].
Definition at line 175 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::hsSp(), thermoSingleLayer::resetPrimaryRegionSourceTerms(), thermoSingleLayer::solveEnergy(), thermoSingleLayer::transferPrimaryRegionSourceFields(), and thermoSingleLayer::updateSubmodels().
|
protected |
Energy [J/m2/s].
Definition at line 184 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::hsSpPrimary(), thermoSingleLayer::resetPrimaryRegionSourceTerms(), and thermoSingleLayer::transferPrimaryRegionSourceFields().
|
protected |
Temperature [K].
Definition at line 193 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::q(), thermoSingleLayer::qconvp(), thermoSingleLayer::TPrimary(), and thermoSingleLayer::transferPrimaryRegionThermoFields().
|
protected |
List of specie mass fractions [0-1].
Definition at line 198 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::transferPrimaryRegionThermoFields(), and thermoSingleLayer::YPrimary().
|
protected |
Viscosity model.
Definition at line 206 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::solveEnergy().
|
protected |
Heat transfer coefficient between film surface and primary.
region [W/m2/K]
Definition at line 213 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::htcs(), thermoSingleLayer::q(), thermoSingleLayer::qconvp(), and thermoSingleLayer::updateSubmodels().
|
protected |
Heat transfer coefficient between wall and film [W/m2/K].
Definition at line 218 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::htcw(), thermoSingleLayer::q(), thermoSingleLayer::qconvw(), and thermoSingleLayer::updateSubmodels().
|
protected |
Phase change.
Definition at line 223 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::info(), thermoSingleLayer::phaseChange(), and thermoSingleLayer::updateSubmodels().
|
protected |
Radiation.
Definition at line 228 of file thermoSingleLayer.H.
Referenced by thermoSingleLayer::radiation(), thermoSingleLayer::solveEnergy(), and thermoSingleLayer::updateSubmodels().
|
protected |
Minimum temperature limit (optional)
Definition at line 236 of file thermoSingleLayer.H.
|
protected |
Maximum temperature limit (optional)
Definition at line 241 of file thermoSingleLayer.H.
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.
Generated by
1.8.14
