Kinematic form of single-cell layer surface film model. More...
#include <kinematicSingleLayer.H>
Public Member Functions | |
| TypeName ("kinematicSingleLayer") | |
| Runtime type information. | |
| kinematicSingleLayer (const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word ®ionType, const bool readFields=true) | |
| Construct from components. | |
| virtual | ~kinematicSingleLayer () |
| Destructor. | |
| virtual scalar | CourantNumber () const |
| Courant number evaluation. | |
| Switch | momentumPredictor () const |
| Return the momentum predictor. | |
| label | nOuterCorr () const |
| Return the number of outer correctors. | |
| label | nCorr () const |
| Return the number of PISO correctors. | |
| label | nNonOrthCorr () const |
| Return the number of non-orthogonal correctors. | |
| const dimensionedScalar & | deltaSmall () const |
| Return small delta. | |
| const volScalarField & | mu () const |
| Return const access to the dynamic viscosity [Pa.s]. | |
| const volScalarField & | sigma () const |
| Return const access to the surface tension [kg/s2]. | |
| const volScalarField & | delta () const |
| Return const access to the film thickness [m]. | |
| const volScalarField & | alpha () const |
| Return the film coverage, 1 = covered, 0 = uncovered []. | |
| virtual const volVectorField & | U () const |
| Return the film velocity [m/s]. | |
| virtual const volVectorField & | Us () const |
| Return the film surface velocity [m/s]. | |
| virtual const volVectorField & | Uw () const |
| Return the film wall velocity [m/s]. | |
| virtual const volScalarField & | deltaRho () const |
| Return the film thickness*density (helper field) [kg/m3]. | |
| virtual const surfaceScalarField & | phi () const |
| Return the film flux [kg.m/s]. | |
| virtual const volScalarField & | rho () const |
| Return the film density [kg/m3]. | |
| virtual const volScalarField & | T () const |
| Return the film mean temperature [K]. | |
| virtual const volScalarField & | Ts () const |
| Return the film surface temperature [K]. | |
| virtual const volScalarField & | Tw () const |
| Return the film wall temperature [K]. | |
| virtual const volScalarField & | hs () const |
| Return the film surface enthalpy [J/kg]. | |
| virtual const volScalarField & | Cp () const |
| Return the film specific heat capacity [J/kg/K]. | |
| virtual const volScalarField & | kappa () const |
| Return the film thermal conductivity [W/m/K]. | |
| virtual tmp< volScalarField > | primaryMassTrans () const |
| Return mass transfer source - Eulerian phase only. | |
| virtual const volScalarField & | cloudMassTrans () const |
| Return the film mass available for transfer to cloud. | |
| virtual const volScalarField & | cloudDiameterTrans () const |
| Return the parcel diameters originating from film to cloud. | |
| 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. | |
| volVectorField & | USpPrimary () |
| Momentum [kg/m/s2]. | |
| volScalarField & | pSpPrimary () |
| Pressure [Pa]. | |
| volScalarField & | rhoSpPrimary () |
| Mass [kg/m2/s]. | |
| volVectorField & | USp () |
| Momentum [kg/m/s2]. | |
| volScalarField & | pSp () |
| Pressure [Pa]. | |
| volScalarField & | rhoSp () |
| Mass [kg/m2/s]. | |
| const volVectorField & | USp () const |
| Momentum [kg/m/s2]. | |
| const volScalarField & | pSp () const |
| Pressure [Pa]. | |
| const volScalarField & | rhoSp () const |
| Mass [kg/m2/s]. | |
| const volVectorField & | UPrimary () const |
| Velocity [m/s]. | |
| const volScalarField & | pPrimary () const |
| Pressure [Pa]. | |
| const volScalarField & | rhoPrimary () const |
| Density [kg/m3]. | |
| const volScalarField & | muPrimary () const |
| Viscosity [Pa.s]. | |
| const filmThermoModel & | filmThermo () const |
| Film thermo. | |
| injectionModelList & | injection () |
| Injection. | |
| transferModelList & | transfer () |
| Transfer. | |
| const filmTurbulenceModel & | turbulence () const |
| Turbulence. | |
| tmp< volScalarField > | mass () const |
| Return the current film mass. | |
| tmp< volScalarField > | deltaMass () const |
| Return the change in film mass due to sources/sinks. | |
| tmp< volScalarField > | gNorm () const |
| Return the gravity normal-to-patch component contribution. | |
| tmp< volScalarField > | gNormClipped () const |
| Return the gravity normal-to-patch component contribution. | |
| tmp< volVectorField > | gTan () const |
| Return the gravity tangential component contributions. | |
| tmp< vectorField > | gTan (const label patchI) const |
| Return the gravity tangential component contributions for patchI. | |
| virtual void | preEvolveRegion () |
| Pre-evolve film hook. | |
| virtual void | evolveRegion () |
| Evolve the film equations. | |
| virtual void | postEvolveRegion () |
| Post-evolve film hook. | |
| virtual tmp< volScalarField::Internal > | Srho () const |
| Return total mass source - Eulerian phase only. | |
| virtual tmp< volScalarField::Internal > | Srho (const label i) const |
| Return mass source for specie i - Eulerian phase only. | |
| virtual tmp< volScalarField::Internal > | Sh () const |
| Return enthalpy source - Eulerian phase only. | |
| virtual void | info () |
| Provide some feedback. | |
| Public Member Functions inherited from surfaceFilmRegionModel | |
| TypeName ("surfaceFilmRegionModel") | |
| Runtime type information. | |
| surfaceFilmRegionModel (const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word ®ionType) | |
| Construct from type name, mesh and gravity vector. | |
| virtual | ~surfaceFilmRegionModel () |
| Destructor. | |
| const dimensionedVector & | g () const |
| Return the acceleration due to gravity. | |
| virtual void | evolve () |
| Main driver routing to evolve the region - calls other evolves. | |
| Public Member Functions inherited from surfaceFilmModel | |
| TypeName ("surfaceFilmModel") | |
| Runtime type information. | |
| declareRunTimeSelectionTable (autoPtr, surfaceFilmModel, mesh,(const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word ®ionType),(modelType, mesh, g, regionType)) | |
| surfaceFilmModel () | |
| Constructor. | |
| virtual | ~surfaceFilmModel () |
| Destructor. | |
| Public Member Functions inherited from singleLayerRegion | |
| TypeName ("regionModel") | |
| Runtime type information. | |
| singleLayerRegion (const fvMesh &mesh, const word ®ionType) | |
| Construct null. | |
| singleLayerRegion (const fvMesh &mesh, const word ®ionType, const word &modelName, bool readFields=true) | |
| Construct from mesh, region type and name. | |
| virtual | ~singleLayerRegion () |
| Destructor. | |
| virtual const volVectorField & | nHat () const |
| Return the patch normal vectors. | |
| virtual const volScalarField & | magSf () const |
| Return the face area magnitudes / [m2]. | |
| virtual const labelList & | passivePatchIDs () const |
| Return the list of patch IDs opposite to internally. | |
| template<class Type> | |
| wordList | mappedFieldAndInternalPatchTypes () const |
| Return boundary types for mapped field patches. | |
| template<class Type> | |
| wordList | mappedPushedFieldPatchTypes () const |
| Return boundary types for pushed mapped field patches. | |
| 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. | |
| regionModel (const fvMesh &mesh, const word ®ionType) | |
| Construct null. | |
| regionModel (const fvMesh &mesh, const word ®ionType, const word &modelName, bool readFields=true) | |
| Construct from mesh, region type and name. | |
| regionModel (const fvMesh &mesh, const word ®ionType, const word &modelName, const dictionary &dict, bool readFields=true) | |
| Construct from mesh and name and dict. | |
| virtual | ~regionModel ()=default |
| Destructor. | |
| const fvMesh & | primaryMesh () const noexcept |
| Return the reference to the primary mesh database. | |
| const Time & | time () const noexcept |
| Return the reference to the time database. | |
| Switch | active () const noexcept |
| Return the active flag. | |
| Switch | infoOutput () const noexcept |
| Return the information flag. | |
| const word & | modelName () const noexcept |
| Return the model name. | |
| const fvMesh & | regionMesh () const |
| Return the region mesh database. | |
| fvMesh & | regionMesh () |
| Return the region mesh database for manipulation. | |
| const dictionary & | coeffs () const noexcept |
| Return the model coefficients dictionary. | |
| const dictionary & | solution () const |
| Return the solution dictionary. | |
| const IOdictionary & | outputProperties () const |
| Return const access to the output properties dictionary. | |
| IOdictionary & | outputProperties () |
| Return output properties dictionary. | |
| const labelList & | primaryPatchIDs () const noexcept |
| List of patch IDs on the primary region coupled to this region. | |
| const labelList & | intCoupledPatchIDs () const noexcept |
| List of patch IDs internally coupled with the primary region. | |
| bool | isCoupledPatch (const label regionPatchi) const |
| True if patchi on the local region is a coupled patch to the primary region. | |
| bool | isRegionPatch (const label primaryPatchi) const |
| True if patchi on the primary region is a coupled patch to the local region. | |
| label | regionPatchID (const label primaryPatchi) const |
| Return region ID corresponding to primaryPatch ID. | |
| label | nbrCoupledPatchID (const regionModel &nbrRegion, const label regionPatchi) const |
| Return the coupled patch ID paired with coupled patch. | |
| 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. | |
| 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. | |
| 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. | |
| template<class Type> | |
| void | toPrimary (const label regionPatchi, List< Type > ®ionField) const |
| Convert a local region field to the primary region. | |
| template<class Type> | |
| void | toRegion (const label regionPatchi, List< Type > &primaryFieldField) const |
| Convert a primary region field to the local region. | |
| 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. | |
| 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. | |
| 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. | |
| IOdictionary (const IOobject &io, const dictionary &dict) | |
| Construct given an IOobject and fallback dictionary content. | |
| IOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr) | |
| Construct given an IOobject, wanted typeName and optional fallback dictionary content. | |
| IOdictionary (const IOobject &io, Istream &is) | |
| Construct given an IOobject and Istream. | |
| virtual | ~IOdictionary ()=default |
| Destructor. | |
| virtual bool | global () const |
| The object is global. | |
| virtual fileName | filePath () const |
| Return complete path + object name if the file exists either in the case/processor or case otherwise null. | |
| Public Member Functions inherited from baseIOdictionary | |
| TypeName ("dictionary") | |
| Declare type-name, virtual type (with debug switch). | |
| baseIOdictionary (const baseIOdictionary &)=default | |
| Copy construct. | |
| baseIOdictionary (baseIOdictionary &&)=default | |
| Move construct. | |
| virtual | ~baseIOdictionary ()=default |
| Destructor. | |
| baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr) | |
| Construct given an IOobject and optional fallback dictionary content (ununsed). | |
| baseIOdictionary (const IOobject &io, const dictionary &dict) | |
| Construct given an IOobject and fallback dictionary content (ununsed). | |
| baseIOdictionary (const IOobject &io, Istream &is) | |
| Construct given an IOobject and Istream (ununsed). | |
| const word & | name () const |
| Name function is needed to disambiguate those inherited from regIOobject and dictionary. | |
| virtual bool | readData (Istream &) |
| The readData function required by regIOobject read operation. | |
| virtual bool | writeData (Ostream &) const |
| The writeData function required by regIOobject write operation. | |
| void | operator= (const baseIOdictionary &rhs) |
| Copy assignment of dictionary entries. | |
| void | operator= (baseIOdictionary &&rhs) |
| Move assignment of dictionary entries. | |
| void | operator= (const dictionary &rhs) |
| Copy assignment of dictionary entries. | |
| Public Member Functions inherited from regIOobject | |
| void | operator= (const regIOobject &)=delete |
| No copy assignment. | |
| TypeName ("regIOobject") | |
| Runtime type information. | |
| 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). | |
| regIOobject (const regIOobject &rio) | |
| Copy construct. | |
| regIOobject (const regIOobject &rio, bool registerCopy) | |
| Copy construct, transferring registry registration to the copy if registerCopy is true. | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| Copy construct with new name, transferring registry registration to the copy if registerCopy is true. | |
| regIOobject (const IOobject &io, const regIOobject &rio) | |
| Copy construct with new IO parameters. | |
| virtual | ~regIOobject () |
| Destructor. | |
| bool | checkIn () |
| Add object to registry, if not already registered. | |
| bool | checkOut () |
| Remove object from registry, and remove all file watches. | |
| virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED). | |
| 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. | |
| bool | ownedByRegistry () const noexcept |
| Is this object owned by the registry? | |
| bool | store () |
| Register object with its registry and transfer ownership to the registry. | |
| void | release (const bool unregister=false) noexcept |
| Set object as not ownedByRegistry. | |
| label | eventNo () const noexcept |
| Event number at last update. | |
| label & | eventNo () noexcept |
| Event number at last update. | |
| bool | upToDate (const regIOobject &) const |
| Return true if up-to-date with respect to given object. | |
| bool | upToDate (const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| void | setUpToDate () |
| Set as up-to-date. | |
| virtual void | rename (const word &newName) |
| Rename. | |
| const dictionary * | findMetaData () const noexcept |
| Return pointer to meta-data or nullptr. | |
| dictionary & | getMetaData () noexcept |
| Get or create meta-data. | |
| void | removeMetaData () |
| Remove meta-data. | |
| virtual void | updateMetaData () |
| Update internal meta-data (eg, prior to writing). | |
| bool | headerOk () |
| Read and check header info. Does not check the headerClassName. | |
| Istream & | readStream (const word &, const bool readOnProc=true) |
| Return Istream and check object type against that given. | |
| void | close () |
| Close Istream. | |
| virtual label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. | |
| const labelList & | watchIndices () const noexcept |
| Read access to file-monitoring handles. | |
| labelList & | watchIndices () noexcept |
| Write access to file-monitoring handles. | |
| virtual bool | modified () const |
| Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time). | |
| virtual bool | readIfModified () |
| Read object if modified (as set by call to modified). | |
| virtual bool | writeObject (IOstreamOption streamOpt, const bool writeOnProc) const |
| Write using stream options. | |
| virtual bool | write (const bool writeOnProc=true) const |
| Write using setting from DB. | |
| void | operator= (const IOobject &io) |
| Copy assignment. | |
| virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const |
| Write using given format, version and compression. | |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Declare type-name, virtual type (with debug switch). | |
| IOobject (const IOobject &)=default | |
| Copy construct. | |
| virtual | ~IOobject ()=default |
| Destructor. | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from name, instance, registry, io options. | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from name, instance, local, registry, io options. | |
| IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from path, registry, io options. | |
| 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. | |
| 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. | |
| 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. | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| Copy construct, resetting registry. | |
| IOobject (const IOobject &io, const word &name) | |
| Copy construct, resetting name. | |
| IOobject (const IOobject &io, const word &name, const fileName &local) | |
| Copy construct, resetting name and local component. | |
| IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) | |
| Copy construct, resetting read/write options. | |
| IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) | |
| Copy construct, resetting register option. | |
| autoPtr< IOobject > | clone () const |
| Clone. | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. | |
| const objectRegistry & | db () const noexcept |
| Return the local objectRegistry. | |
| const Time & | time () const noexcept |
| Return Time associated with the objectRegistry. | |
| const word & | name () const noexcept |
| Return the object name. | |
| const word & | headerClassName () const noexcept |
| Return name of the class name read from header. | |
| word & | headerClassName () noexcept |
| Modifiable access to the class name read from header. | |
| const string & | note () const noexcept |
| Return the optional note. | |
| string & | note () noexcept |
| Modifiable access to the optional note. | |
| unsigned | labelByteSize () const noexcept |
| The sizeof (label) in bytes, possibly read from the header. | |
| unsigned | scalarByteSize () const noexcept |
| The sizeof (scalar) in bytes, possibly read from the header. | |
| void | resetHeader (const word &newName=word::null) |
| Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. | |
| bool | hasHeaderClass () const noexcept |
| True if headerClassName() is non-empty (after reading). | |
| bool | isHeaderClass (const word &expectedType) const |
| Check if headerClassName() equals the expected type. Always true if the expected type is empty. | |
| template<class Type> | |
| bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName Always true for a void type. | |
| word | group () const |
| Return group (extension part of name). | |
| word | member () const |
| Return member (name without the extension). | |
| const fileName & | rootPath () const noexcept |
| Return the Time::rootPath(). | |
| const fileName & | caseName () const noexcept |
| Return the Time::caseName(). | |
| const fileName & | globalCaseName () const noexcept |
| Return the Time::globalCaseName(). | |
| const fileName & | caseName (IOobjectOption::Layout) const noexcept |
| Return the Time::caseName() - normal or global. | |
| const fileName & | instance () const noexcept |
| Read access to instance path component. | |
| fileName & | instance () noexcept |
| Modifiable access to instance path component. | |
| scalar | instanceValue () const |
| Return the scalar value of the instance component (or 0), which often corresponds to a time index/value. | |
| const fileName & | local () const noexcept |
| Read access to local path component. | |
| fileName & | local () noexcept |
| Modifiable access to the local path component. | |
| fileName | path () const |
| The complete path for the object (with instance, local,...). | |
| fileName | globalPath () const |
| The complete global path for the object (with instance, local,...). | |
| fileName | path (IOobjectOption::Layout) const |
| The complete path (normal or global) for the object. | |
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. | |
| fileName | globalPath (const word &instance, const fileName &local=fileName::null) const |
| The complete global path with alternative instance and local. | |
| fileName | path (IOobjectOption::Layout, const word &instance, const fileName &local=fileName::null) const |
| The complete path (normal or global) with alternative instance and local. | |
| fileName | objectPath () const |
| The complete path + object name. | |
| fileName | globalObjectPath () const |
| The complete global path + object name. | |
| fileName | objectPath (IOobjectOption::Layout) const |
| The complete path (normal or global) + object name. | |
| fileName | objectPath (IOobjectOption::Layout, const word &instance) const |
| The complete path (normal or global) + object name with alternative instance. | |
| fileName | objectPath (const word &instance) const |
| The complete path + object name with alternative instance. | |
| fileName | globalObjectPath (const word &instance) const |
| The complete global path + object name with alternative instance. | |
| fileName | objectRelPath () const |
| The object path relative to the case. | |
| fileName | localFilePath (const word &typeName, const bool search=true) const |
| Redirect to fileHandler filePath, searching locally. | |
| fileName | globalFilePath (const word &typeName, const bool search=true) const |
| Redirect to fileHandler filePath, searching up if in parallel. | |
| IOstreamOption | parseHeader (const dictionary &headerDict) |
| Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. | |
| bool | readHeader (Istream &is) |
| Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. | |
| bool | readHeader (dictionary &headerDict, Istream &is) |
| Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. | |
| 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. A void type suppresses trait and type-name checks. | |
| template<class Type, bool Searching> | |
| bool | typeHeaderOk (const bool checkType=true, const bool verbose=true) |
Forwards to single-parameter version with the specified search type. A void type suppresses trait and type-name checks. | |
| template<class Type> | |
| fileName | typeFilePath (const bool search=true) const |
| Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. | |
| template<class Type> | |
| void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. | |
| bool | writeHeader (Ostream &os) const |
| Write header with current type(). | |
| bool | writeHeader (Ostream &os, const word &objectType) const |
| Write header with override of type. | |
| void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
| Write header into a dictionary with current type() and given output format. | |
| void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
| Write header into a dictionary with override of type and given output format. | |
| bool | good () const noexcept |
| Did last readHeader() succeed? | |
| bool | bad () const noexcept |
| Did last readHeader() fail? | |
| InfoProxy< IOobject > | info () const noexcept |
| Return info proxy, for printing information to a stream. | |
| void | operator= (const IOobject &io) |
| Copy assignment, copies all values (except the registry). | |
| template<class Type> | |
| bool | isHeaderClassName () const |
| Same as isHeaderClass(). | |
| 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. | |
| constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Construct NO_WRITE with specified read/register options. | |
| constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Construct NO_READ with specified write/register options. | |
| constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
| Construct (NO_READ, NO_WRITE) with specified register option. | |
| constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
| Construct from components with specified register option as bool. | |
| constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
| Construct (NO_READ, NO_WRITE) with specified register option as bool. | |
| readOption | readOpt () const noexcept |
| Get the read option. | |
| readOption | readOpt (readOption opt) noexcept |
| Set the read option. | |
| writeOption | writeOpt () const noexcept |
| Get the write option. | |
| writeOption | writeOpt (writeOption opt) noexcept |
| Set the write option. | |
| bool | registerObject () const noexcept |
| Should objects created with this IOobject be registered? | |
| bool | registerObject (bool on) noexcept |
| Change registration preference. | |
| bool | globalObject () const noexcept |
| True if object is treated the same for all processors. | |
| bool | globalObject (bool on) noexcept |
| Change global-object status. | |
| bool | isAnyRead () const noexcept |
| True if any reading may be required (ie, != NO_READ). | |
| bool | isReadRequired () const noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. | |
| bool | isReadOptional () const noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. | |
| readOption & | readOpt () noexcept |
| Access to the read option. | |
| writeOption & | writeOpt () noexcept |
| Access to the write option. | |
| bool & | registerObject () noexcept |
| Access to the register object option. | |
| bool & | globalObject () noexcept |
| Access to the global object option. | |
| Public Member Functions inherited from dictionary | |
| ClassName ("dictionary") | |
| dictionary () | |
| Default construct, a top-level empty dictionary. | |
| dictionary (const fileName &name) | |
| Construct top-level empty dictionary with given name. | |
| 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. | |
| 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. | |
| dictionary (Istream &is, bool keepHeader) | |
| Construct top-level dictionary from Istream, reading entries until EOF, optionally keeping the header. | |
| dictionary (const dictionary &parentDict, const dictionary &dict) | |
| Copy construct given the parent dictionary. | |
| dictionary (const dictionary &dict) | |
| Copy construct top-level dictionary. | |
| dictionary (const dictionary *dict) | |
| Construct top-level dictionary as copy from pointer to dictionary. | |
| dictionary (const dictionary &parentDict, dictionary &&dict) | |
| Move construct for given parent dictionary. | |
| dictionary (dictionary &&dict) | |
| Move construct top-level dictionary. | |
| autoPtr< dictionary > | clone () const |
| Construct and return clone. | |
| virtual | ~dictionary () |
| Destructor. | |
| const fileName & | name () const noexcept |
| The dictionary name. | |
| fileName & | name () noexcept |
| The dictionary name for modification (use with caution). | |
| word | dictName () const |
| The local dictionary name (final part of scoped name). | |
| fileName | relativeName (const bool caseTag=false) const |
| The dictionary name relative to the case. | |
| bool | isNullDict () const noexcept |
| The dictionary is actually dictionary::null (root dictionary). | |
| const dictionary & | parent () const noexcept |
| Return the parent dictionary. | |
| const dictionary & | topDict () const |
| Return the top of the tree. | |
| label | startLineNumber () const |
| Return line number of first token in dictionary. | |
| label | endLineNumber () const |
| Return line number of last token in dictionary. | |
| SHA1Digest | digest () const |
| Return the SHA1 digest of the dictionary contents. | |
| tokenList | tokens () const |
| Return the dictionary as a list of tokens. | |
| const entry * | findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Find an entry (const access) with the given keyword. | |
| entry * | findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| Find an entry (non-const access) with the given keyword. | |
| bool | found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Find an entry (const access) with the given keyword. | |
| const entry * | findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Search for a scoped entry (const access) with the given keyword. | |
| const dictionary * | findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Find and return a sub-dictionary pointer if present (and it is a dictionary) otherwise return nullptr. | |
| dictionary * | findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| Find and return a sub-dictionary pointer if present (and it is a dictionary) otherwise return nullptr. | |
| ITstream * | findStream (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Find and return an entry stream if present (and it is a stream) otherwise return nullptr. | |
| const entry & | lookupEntry (const word &keyword, enum keyType::option matchOpt) const |
| Search for an entry (const access) with the given keyword. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| const dictionary & | subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Find and return a sub-dictionary. | |
| dictionary & | subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| Find and return a sub-dictionary for manipulation. | |
| dictionary & | subDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| Find and return a sub-dictionary for manipulation. | |
| 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. | |
| const dictionary & | optionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Find and return a sub-dictionary, otherwise return this dictionary. | |
| wordList | toc () const |
| Return the table of contents. | |
| wordList | sortedToc () const |
| Return the sorted table of contents. | |
| template<class Compare> | |
| wordList | sortedToc (const Compare &comp) const |
| Return table of contents sorted using the specified comparator. | |
| List< keyType > | keys (bool patterns=false) const |
| Return the list of available keys or patterns. | |
| bool | substituteKeyword (const word &keyword, bool mergeEntry=false) |
| Substitute the given keyword (which is prefixed by '$'). | |
| bool | substituteScopedKeyword (const word &keyword, bool mergeEntry=false) |
| Substitute the given scoped keyword (which is prefixed by '$'). | |
| entry * | add (entry *entryPtr, bool mergeEntry=false) |
| Add a new entry. | |
| entry * | add (const entry &e, bool mergeEntry=false) |
| Add an entry. | |
| entry * | add (const keyType &k, const word &v, bool overwrite=false) |
| Add a word entry. | |
| entry * | add (const keyType &k, const string &v, bool overwrite=false) |
| Add a string entry. | |
| entry * | add (const keyType &k, const label v, bool overwrite=false) |
| Add a label entry. | |
| entry * | add (const keyType &k, const scalar v, bool overwrite=false) |
| Add a scalar entry. | |
| entry * | add (const keyType &k, const dictionary &d, bool mergeEntry=false) |
| Add a dictionary entry. | |
| template<class T> | |
| entry * | add (const keyType &k, const T &v, bool overwrite=false) |
| Add a T entry. | |
| entry * | set (entry *entryPtr) |
| Assign a new entry, overwriting any existing entry. | |
| entry * | set (const entry &e) |
| Assign a new entry, overwriting any existing entry. | |
| entry * | set (const keyType &k, const dictionary &v) |
| Assign a dictionary entry, overwriting any existing entry. | |
| entry * | set (const keyType &k, std::nullptr_t) |
| Assign an empty primitive entry, overwriting any existing entry. | |
| entry * | set (const keyType &k, const UList< token > &tokens) |
| Assign a primitive entry from a list of tokens, overwriting any existing entry. | |
| entry * | set (const keyType &k, List< token > &&tokens) |
| Assign a primitive entry from a list of tokens, overwriting any existing entry. | |
| template<class T> | |
| entry * | set (const keyType &k, const T &v) |
| Assign a T entry, overwriting any existing entry. | |
| bool | remove (const word &keyword) |
| Remove an entry specified by keyword. | |
| bool | changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false) |
| Change the keyword for an entry,. | |
| bool | merge (const dictionary &dict) |
| Merge entries from the given dictionary. | |
| void | clear () |
| Clear the dictionary. | |
| void | transfer (dictionary &dict) |
| Transfer the contents of the argument and annul the argument. | |
| 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. | |
| 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. | |
| 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. | |
| void | writeEntry (Ostream &os) const |
| Write sub-dictionary with its dictName as its header. | |
| void | writeEntry (const keyType &keyword, Ostream &os) const |
| Write sub-dictionary with the keyword as its header. | |
| void | writeEntries (Ostream &os, const bool extraNewLine=false) const |
| Write dictionary entries. | |
| void | write (Ostream &os, const bool subDict=true) const |
| Write dictionary, normally with sub-dictionary formatting. | |
| const_searcher | csearch (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Search dictionary for given keyword. | |
| const_searcher | search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Search dictionary for given keyword. | |
| searcher | search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| Search dictionary for given keyword. | |
| const_searcher | csearchScoped (const word &keyword, enum keyType::option matchOpt) const |
| Search using scoping. | |
| const_searcher | searchScoped (const word &keyword, enum keyType::option matchOpt) const |
| Search using dot or slash scoping. | |
| searcher | searchScoped (const word &keyword, enum keyType::option matchOpt) |
| Search using dot or slash scoping. | |
| const dictionary * | cfindScopedDict (const fileName &dictPath) const |
| Locate a sub-dictionary using slash-scoping. | |
| const dictionary * | findScopedDict (const fileName &dictPath) const |
| Locate a sub-dictionary using slash-scoping. | |
| dictionary * | findScopedDict (const fileName &dictPath) |
| Locate a sub-dictionary using slash-scoping. | |
| dictionary * | makeScopedDict (const fileName &dictPath) |
| Locate existing or create sub-dictionary using slash-scoping. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| void | operator= (const dictionary &rhs) |
| Copy assignment. | |
| void | operator+= (const dictionary &rhs) |
| Include entries from the given dictionary. | |
| void | operator|= (const dictionary &rhs) |
| Conditionally include entries from the given dictionary. | |
| void | operator<<= (const dictionary &rhs) |
| Unconditionally include entries from the given dictionary. | |
| bool | getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as get<bool>(const word&, keyType::option). | |
| label | getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as get<label>(const word&, keyType::option). | |
| scalar | getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as get<scalar>(const word&, keyType::option). | |
| string | getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as get<string>(const word&, keyType::option). | |
| word | getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as get<word>(const word&, keyType::option). | |
| fileName | getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as get<fileName>(const word&, keyType::option). | |
| bool | isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Check for existence of a sub-dictionary. Generally prefer findDict() for more flexibility. | |
| template<class T> | |
| T | lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as getOrDefault(). | |
| template<class T> | |
| T | lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) |
| Same as getOrAdd(). | |
| ITstream & | operator[] (const word &keyword) const |
| Deprecated(2018-07) - use lookup() method. | |
| bool | found (const word &keyword, bool recursive, bool patternMatch=true) const |
| Deprecated(2018-10). | |
| entry * | lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) |
| Deprecated(2018-10). | |
| const entry * | lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const |
| Deprecated(2018-10). | |
| const entry * | lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const |
| Deprecated(2018-10). | |
| const dictionary * | subDictPtr (const word &keyword) const |
| Deprecated(2018-10). | |
| dictionary * | subDictPtr (const word &keyword) |
| Deprecated(2018-10) Find and return a sub-dictionary pointer if present. | |
| const entry & | lookupEntry (const word &keyword, bool recursive, bool patternMatch) const |
| Deprecated(2018-10). | |
| ITstream & | lookup (const word &keyword, bool recursive, bool patternMatch=true) const |
| Deprecated(2018-10). | |
| template<class T> | |
| T | lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const |
| Deprecated(2018-10). | |
| template<class T> | |
| T | lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) |
| Deprecated(2018-10). | |
| template<class T> | |
| bool | readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const |
| Deprecated(2018-10). | |
| template<class T> | |
| T | lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const |
| Deprecated(2018-10) find and return a T. | |
| 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< DLListBase, T > | |
| ILList ()=default | |
| Default construct. | |
| ILList (T *item) | |
| Construct and add initial item pointer. | |
| ILList (Istream &is) | |
| Construct from Istream. | |
| ILList (const ILList< DLListBase, T > &lst) | |
| Copy construct using the 'clone()' method for each element. | |
| ILList (ILList< DLListBase, T > &&lst) | |
| Move construct. | |
| ILList (const ILList< DLListBase, T > &lst, const CloneArg &cloneArg) | |
| Copy constructor with additional argument for clone 'clone()'. | |
| ILList (Istream &is, const INew &inew) | |
| Construct from Istream using given Istream constructor class. | |
| ~ILList () | |
| Destructor. Calls clear(). | |
| void | clear () |
| Clear the contents of the list. | |
| void | pop_front (label n=1) |
| Remove first element(s) from the list (deletes pointers). | |
| bool | erase (T *item) |
| Remove the specified element from the list and delete it. | |
| void | transfer (ILList< DLListBase, T > &lst) |
| Transfer the contents of the argument into this List and annul the argument list. | |
| void | operator= (const ILList< DLListBase, T > &lst) |
| Copy assignment using the 'clone()' method for each element. | |
| void | operator= (ILList< DLListBase, T > &&lst) |
| Move assignment. | |
| Public Member Functions inherited from UILList< DLListBase, T > | |
| UILList ()=default | |
| Default construct. | |
| UILList (T *item) | |
| Construct and add initial item pointer. | |
| UILList (const UILList< DLListBase, T > &list) | |
| Construct as copy. | |
| T * | front () |
| The first entry in the list. | |
| const T * | front () const |
| The first entry in the list (const access). | |
| T * | back () |
| The last entry in the list. | |
| const T * | back () const |
| The last entry in the list (const access). | |
| T * | removeHead () |
| Remove and return head. | |
| T * | remove (T *item) |
| Remove and return element. | |
| T * | remove (iterator &iter) |
| Remove and return item specified by iterator. | |
| void | operator= (const UILList< DLListBase, T > &lst) |
| Copy assignment. | |
| bool | operator== (const UILList< DLListBase, T > &lst) const |
| Equality. True both lists are element-wise equal. | |
| bool | operator!= (const UILList< DLListBase, T > &lst) const |
| The opposite of the equality operation. Takes linear time. | |
| Ostream & | writeList (Ostream &os, const label shortLen=0) const |
| Write UILList with line-breaks when length exceeds shortLen. | |
| iterator | begin () |
| Iterator to first item in list with non-const access. | |
| const_iterator | cbegin () const |
| Iterator to first item in list with const access. | |
| reverse_iterator | rbegin () |
| Iterator to last item in list with non-const access. | |
| const_reverse_iterator | crbegin () const |
| Iterator to last item in list with const access. | |
| const_iterator | begin () const |
| Iterator to first item in list with const access. | |
| const_reverse_iterator | rbegin () const |
| Iterator to last item in list with const access. | |
| const iterator & | end () |
| End of list for forward iterators. | |
| const const_iterator & | cend () const |
| End of list for forward iterators. | |
| const reverse_iterator & | rend () |
| End of list for reverse iterators. | |
| const const_reverse_iterator & | crend () const |
| End of list for reverse iterators. | |
| const const_iterator & | end () const |
| End of list for forward iterators. | |
| const const_reverse_iterator & | rend () const |
| End of list for reverse iterators. | |
| T * | first () |
| The first entry in the list. | |
| const T * | first () const |
| The first entry in the list (const access). | |
| T * | last () |
| The last entry in the list. | |
| const T * | last () const |
| The last entry in the list (const access). | |
| Public Member Functions inherited from DLListBase | |
| DLListBase ()=default | |
| Default construct. | |
| DLListBase (const DLListBase &)=delete | |
| No copy construct. | |
| void | operator= (const DLListBase &)=delete |
| No copy assignment. | |
| ~DLListBase ()=default | |
| Destructor. | |
| bool | empty () const noexcept |
| True if the list is empty. | |
| label | size () const noexcept |
| The number of elements in list. | |
| link * | front () |
| Return first entry. | |
| const link * | front () const |
| Return const access to first entry. | |
| link * | back () |
| Return last entry. | |
| const link * | back () const |
| Return const access to last entry. | |
| void | push_front (link *item) |
| Add at front of list. | |
| void | push_back (link *item) |
| Add at back of list. | |
| bool | swapUp (link *item) |
| Swap this element with the one above unless it is at the top. | |
| bool | swapDown (link *item) |
| Swap this element with the one below unless it is at the bottom. | |
| link * | removeHead () |
| Remove and return first entry. | |
| link * | remove (link *item) |
| Remove and return element. | |
| link * | remove (iterator &iter) |
| Remove and return element specified by iterator. | |
| link * | replace (link *oldLink, link *newLink) |
| Replace oldLink with newLink and return element. | |
| link * | replace (iterator &oldIter, link *newitem) |
| Replace oldIter with newItem and return element. | |
| void | clear () |
| Clear the list. | |
| void | swap (DLListBase &lst) |
| Swap the contents of the list. | |
| void | transfer (DLListBase &lst) |
| Transfer the contents of the argument into this list and annul the argument list. | |
| iterator | begin () |
| Iterator to first item in list with non-const access. | |
| const_iterator | cbegin () const |
| Iterator to first item in list with const access. | |
| const_iterator | crbegin () const |
| Iterator to last item in list with const access. | |
| const iterator & | end () |
| End of list for iterators. | |
| const const_iterator & | cend () const |
| End of list for iterators. | |
| const const_iterator & | crend () const |
| End of list for reverse iterators. | |
| link * | first () |
| Return first entry. | |
| const link * | first () const |
| Return const access to first entry. | |
| link * | last () |
| Return last entry. | |
| const link * | last () const |
| Return const access to last entry. | |
| void | prepend (link *item) |
| Add at front of list. | |
| void | append (link *item) |
| Add at back of list. | |
Protected Member Functions | |
| virtual bool | read () |
| Read control parameters from dictionary. | |
| virtual void | correctThermoFields () |
| Correct the thermo fields. | |
| virtual void | resetPrimaryRegionSourceTerms () |
| Reset source term fields. | |
| virtual void | transferPrimaryRegionThermoFields () |
| Transfer thermo fields from the primary region to the film region. | |
| virtual void | transferPrimaryRegionSourceFields () |
| Transfer source fields from the primary region to the film region. | |
| virtual tmp< volScalarField > | pu () |
| Explicit pressure source contribution. | |
| virtual tmp< volScalarField > | pp () |
| Implicit pressure source coefficient. | |
| virtual void | correctAlpha () |
| Correct film coverage field. | |
| virtual void | updateSubmodels () |
| Update the film sub-models. | |
| virtual void | continuityCheck () |
| Continuity check. | |
| virtual void | updateSurfaceVelocities () |
| Update film surface velocities. | |
| template<class Type> | |
| void | constrainFilmField (Type &field, const typename Type::cmptType &value) |
| Constrain a film region master/slave boundaries of a field to a. | |
| virtual void | solveContinuity () |
| Solve continuity equation. | |
| virtual tmp< fvVectorMatrix > | solveMomentum (const volScalarField &pu, const volScalarField &pp) |
| Solve for film velocity. | |
| virtual void | solveThickness (const volScalarField &pu, const volScalarField &pp, fvVectorMatrix &UEqn) |
| Solve coupled velocity-thickness equations. | |
| Protected Member Functions inherited from regionModel | |
| virtual bool | read (const dictionary &dict) |
| Read control parameters from dictionary. | |
| 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. | |
| Protected Member Functions inherited from regIOobject | |
| bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
| Helper: check readOpt flags and read if necessary. | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &s) |
| Set the object state to bad. | |
| Protected Member Functions inherited from DLListBase | |
| template<class IteratorType> | |
| IteratorType | iterator_first () const |
| Return iterator to first item or end-iterator if list is empty. | |
| template<class IteratorType> | |
| IteratorType | iterator_last () const |
| Return iterator to last item or end-iterator if list is empty. | |
Protected Attributes | |
| Switch | momentumPredictor_ |
| Momentum predictor. | |
| label | nOuterCorr_ |
| Number of outer correctors. | |
| label | nCorr_ |
| Number of PISO-like correctors. | |
| label | nNonOrthCorr_ |
| Number of non-orthogonal correctors. | |
| scalar | cumulativeContErr_ |
| Cumulative continuity error. | |
| const dimensionedScalar | deltaSmall_ |
| Small delta. | |
| scalar | deltaCoLimit_ |
| Film thickness above which Courant number calculation in valid. | |
| volScalarField | rho_ |
| Density [kg/m3]. | |
| volScalarField | mu_ |
| Dynamic viscosity [Pa.s]. | |
| volScalarField | sigma_ |
| Surface tension [m/s2]. | |
| volScalarField | delta_ |
| Film thickness [m]. | |
| volScalarField | alpha_ |
| Film coverage indicator, 1 = covered, 0 = uncovered []. | |
| volVectorField | U_ |
| Velocity - mean [m/s]. | |
| volVectorField | Us_ |
| Velocity - surface [m/s]. | |
| volVectorField | Uw_ |
| Velocity - wall [m/s]. | |
| volScalarField | deltaRho_ |
| Film thickness*density (helper field) [kg/m2]. | |
| surfaceScalarField | phi_ |
| Mass flux (includes film thickness) [kg.m/s]. | |
| volScalarField | primaryMassTrans_ |
| Film mass available for transfer to the primary region. | |
| volScalarField | cloudMassTrans_ |
| Film mass available for transfer to cloud. | |
| volScalarField | cloudDiameterTrans_ |
| Parcel diameters originating from film to cloud. | |
| volVectorField | USp_ |
| Momentum [kg/m/s2]. | |
| volScalarField | pSp_ |
| Pressure [Pa]. | |
| volScalarField | rhoSp_ |
| Mass [kg/m2/s]. | |
| volVectorField | USpPrimary_ |
| Momentum [kg/m/s2]. | |
| volScalarField | pSpPrimary_ |
| Pressure [Pa]. | |
| volScalarField | rhoSpPrimary_ |
| Mass [kg/m2/s]. | |
| volVectorField | UPrimary_ |
| Velocity [m/s]. | |
| volScalarField | pPrimary_ |
| Pressure [Pa]. | |
| volScalarField | rhoPrimary_ |
| Density [kg/m3]. | |
| volScalarField | muPrimary_ |
| Viscosity [Pa.s]. | |
| autoPtr< filmThermoModel > | filmThermo_ |
| Film thermo model. | |
| scalarField | availableMass_ |
| Available mass for transfer via sub-models. | |
| injectionModelList | injection_ |
| Cloud injection. | |
| transferModelList | transfer_ |
| Transfer with the continuous phase. | |
| autoPtr< filmTurbulenceModel > | turbulence_ |
| Turbulence model. | |
| forceList | forces_ |
| List of film forces. | |
| scalar | addedMassTotal_ |
| Cumulative mass added via sources [kg]. | |
| Protected Attributes inherited from surfaceFilmRegionModel | |
| const dimensionedVector & | g_ |
| Acceleration due to gravity [m/s2]. | |
| Protected Attributes inherited from singleLayerRegion | |
| autoPtr< volVectorField > | nHatPtr_ |
| Patch normal vectors. | |
| autoPtr< volScalarField > | magSfPtr_ |
| Face area magnitudes / [m2]. | |
| labelList | passivePatchIDs_ |
| List of patch IDs opposite to internally coupled patches. | |
| Protected Attributes inherited from regionModel | |
| const fvMesh & | primaryMesh_ |
| Reference to the primary mesh database. | |
| const Time & | time_ |
| Reference to the time database. | |
| Switch | active_ |
| Active flag. | |
| Switch | infoOutput_ |
| Active information output. | |
| const word | modelName_ |
| Model name. | |
| dictionary | coeffs_ |
| Model coefficients dictionary. | |
| autoPtr< IOdictionary > | outputPropertiesPtr_ |
| Dictionary of output properties. | |
| labelList | primaryPatchIDs_ |
| List of patch IDs on the primary region coupled to this region. | |
| labelList | intCoupledPatchIDs_ |
| List of patch IDs internally coupled with the primary region. | |
| word | regionName_ |
| Region name. | |
| regionModelFunctionObjectList | functions_ |
| Region model function objects. | |
| wordList | interRegionAMINames_ |
| List of region names this region is coupled to. | |
| PtrList< PtrList< AMIPatchToPatchInterpolation > > | interRegionAMI_ |
| List of AMI objects per coupled region. | |
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 = 1 , timeStampMaster = 3 , inotify = 4 , inotifyMaster = 6 } |
| Enumeration defining the file checking options (time-stamp | inotify) | (all | masterOnly). 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... | |
| enum class | Layout : unsigned char { regular , global } |
| The layout of the case structure. More... | |
| Public Types inherited from dictionary | |
| typedef Searcher< true > | const_searcher |
| Searcher with const access. | |
| typedef Searcher< false > | searcher |
| Searcher with non-const access. | |
| Public Types inherited from UILList< DLListBase, T > | |
| typedef T | value_type |
| Type of values stored. | |
| typedef T * | pointer |
| Pointer for value_type. | |
| typedef const T * | const_pointer |
| Const pointer for value_type. | |
| typedef T & | reference |
| Reference for value_type. | |
| typedef const T & | const_reference |
| Const reference for value_type. | |
| typedef label | size_type |
| The type that can represent the container size. | |
| typedef label | difference_type |
| The difference between iterator objects. | |
| using | base_iterator |
| using | const_base_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. | |
| Static Public Member Functions inherited from IOdictionary | |
| static dictionary | readContents (const IOobject &io) |
| Read and return contents, testing for "dictionary" type. The IOobject will not be registered. | |
| static dictionary | readContents (const IOobject &io, const word &wantedType) |
| Read and return contents, testing for expected type. The IOobject will not be registered. | |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type> | |
| static Type & | store (Type *p) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (std::unique_ptr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (autoPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (autoPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (refPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (refPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (tmp< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (tmp< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| Static Public Member Functions inherited from IOobject | |
| static bool | bannerEnabled () noexcept |
| Status of output file banner. | |
| static bool | bannerEnabled (bool on) noexcept |
| Enable/disable output file banner. | |
| static bool | fileModificationChecking_masterOnly () noexcept |
| Test fileModificationChecking for master-only. | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. | |
| template<class StringType> | |
| static word | groupName (StringType base, const word &group) |
| Create dot-delimited name.group string. | |
| static word | group (const word &name) |
| Return group (extension part of name). | |
| static word | member (const word &name) |
| Return member (name without the extension). | |
| static word | scopedName (const std::string &scope, const word &name) |
| Create scope:name or scope_name string. | |
| static word | scopedName (const std::string &scope, const word &name1, const word &name2) |
| Create scope:name1:name2 or scope_name1_name2 string. | |
| static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. | |
| static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
| Write the standard OpenFOAM file/dictionary banner. | |
| static Ostream & | writeDivider (Ostream &os) |
| Write the standard file section divider. | |
| static Ostream & | writeEndDivider (Ostream &os) |
| Write the standard end file divider. | |
| Static Public Member Functions inherited from IOobjectOption | |
| static bool | isAnyRead (readOption opt) noexcept |
| True if any reading may be required (ie, != NO_READ). | |
| static bool | isReadRequired (readOption opt) noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. | |
| static bool | isReadOptional (readOption opt) noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. | |
| static readOption | lazierRead (readOption opt) noexcept |
| Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. | |
| Static Public Member Functions inherited from dictionary | |
| static int | reportOptional () noexcept |
| Return the state of reporting optional (default) entries. | |
| static int | reportOptional (const int level) noexcept |
| Change the state of reporting optional (default) entries. | |
| static autoPtr< dictionary > | New (Istream &is) |
| Construct top-level dictionary on freestore from Istream. | |
| Public Attributes inherited from dictionary | |
| friend | const_searcher |
| Declare friendship with the searcher classes. | |
| friend | searcher |
| Static Public Attributes inherited from surfaceFilmModel | |
| static const dimensionedScalar | Tref |
| Reference temperature for enthalpy. | |
| Static Public Attributes inherited from IOobject | |
| static const Enum< fileCheckTypes > | fileCheckTypesNames |
| Names for the fileCheckTypes. | |
| static char | scopeSeparator |
| Character for scoping object names (':' or '_'). | |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. | |
| static float | fileModificationSkew |
| Time skew (seconds) for file modification checks. | |
| static int | maxFileModificationPolls |
| Max number of times to poll for file modification changes. | |
| Static Public Attributes inherited from dictionary | |
| static int | writeOptionalEntries |
| Report optional keywords and values if not present in dictionary. | |
| static const dictionary | null |
| An empty dictionary, which is also the parent for all dictionaries. | |
| static refPtr< OSstream > | reportingOutput |
| Output location when reporting default values. | |
| 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. | |
| 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. | |
| Static Protected Member Functions inherited from DLListBase | |
| template<class IteratorType> | |
| static const IteratorType & | iterator_end () |
| Factory method to return an iterator end. | |
| template<class IteratorType> | |
| static const IteratorType & | iterator_rend () |
| Factory method to return an iterator reverse end. | |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. | |
Kinematic form of single-cell layer surface film model.
Definition at line 63 of file kinematicSingleLayer.H.
| kinematicSingleLayer | ( | const word & | modelType, |
| const fvMesh & | mesh, | ||
| const dimensionedVector & | g, | ||
| const word & | regionType, | ||
| const bool | readFields = true ) |
Construct from components.
Definition at line 409 of file kinematicSingleLayer.C.
References addedMassTotal_, alpha_, IOobjectOption::AUTO_WRITE, availableMass_, cloudDiameterTrans_, cloudMassTrans_, regionModel::coeffs_, correctAlpha(), correctThermoFields(), cumulativeContErr_, delta_, deltaCoLimit_, deltaRho_, deltaSmall_, Foam::dimArea, Foam::dimDensity, Foam::dimLength, Foam::dimless, Foam::dimMass, Foam::dimPressure, Foam::dimTime, Foam::dimVelocity, e, filmThermo_, Foam::fvc::flux(), forces_, surfaceFilmRegionModel::g(), dictionary::get(), dictionary::getOrDefault(), injection_, singleLayerRegion::mappedFieldAndInternalPatchTypes(), singleLayerRegion::mappedPushedFieldPatchTypes(), mesh, momentumPredictor_, mu_, muPrimary_, IOobjectOption::MUST_READ, baseIOdictionary::name(), nCorr_, surfaceFilmModel::New(), nNonOrthCorr_, IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, nOuterCorr_, phi_, pPrimary_, primaryMassTrans_, regionModel::primaryMesh(), pSp_, pSpPrimary_, IOobjectOption::READ_IF_PRESENT, Foam::readFields(), regionModel::regionMesh(), rho_, rhoPrimary_, rhoSp_, rhoSpPrimary_, sigma_, regionModel::solution(), Foam::sqr(), dictionary::subDict(), regionModel::time(), regionModel::time_, timeName, transfer_, transferPrimaryRegionThermoFields(), turbulence_, U_, UPrimary_, Us_, USp_, USpPrimary_, Uw_, and Foam::Zero.
|
virtual |
Destructor.
Definition at line 797 of file kinematicSingleLayer.C.
|
protectedvirtual |
Read control parameters from dictionary.
Reimplemented from surfaceFilmRegionModel.
Reimplemented in thermoSingleLayer.
Definition at line 52 of file kinematicSingleLayer.C.
References momentumPredictor_, nCorr_, nNonOrthCorr_, nOuterCorr_, surfaceFilmRegionModel::read(), dictionary::readEntry(), regionModel::solution(), and dictionary::subDict().
Referenced by thermoSingleLayer::read().
|
protectedvirtual |
Correct the thermo fields.
Reimplemented in thermoSingleLayer.
Definition at line 69 of file kinematicSingleLayer.C.
References filmThermo_, mu_, rho_, and sigma_.
Referenced by kinematicSingleLayer(), and preEvolveRegion().
|
protectedvirtual |
Reset source term fields.
Reimplemented in thermoSingleLayer.
Definition at line 77 of file kinematicSingleLayer.C.
References DebugInFunction, Foam::endl(), pSpPrimary_, rhoSpPrimary_, USpPrimary_, and Foam::Zero.
Referenced by postEvolveRegion(), and thermoSingleLayer::resetPrimaryRegionSourceTerms().
|
protectedvirtual |
Transfer thermo fields from the primary region to the film region.
Reimplemented in thermoSingleLayer.
Definition at line 87 of file kinematicSingleLayer.C.
References DebugInFunction, Foam::endl(), muPrimary_, pPrimary_, rhoPrimary_, and UPrimary_.
Referenced by kinematicSingleLayer(), preEvolveRegion(), and thermoSingleLayer::transferPrimaryRegionThermoFields().
|
protectedvirtual |
Transfer source fields from the primary region to the film region.
Reimplemented in thermoSingleLayer.
Definition at line 100 of file kinematicSingleLayer.C.
References dictionary::add(), addedMassTotal_, DebugInFunction, Foam::endl(), forAll, singleLayerRegion::magSf(), regionModel::outputProperties(), regionModel::primaryMesh(), pSp_, pSpPrimary_, dictionary::readIfPresent(), Foam::returnReduce(), rhoSp_, rhoSpPrimary_, regionModel::time(), regionModel::time_, USp_, and USpPrimary_.
Referenced by preEvolveRegion(), and thermoSingleLayer::transferPrimaryRegionSourceFields().
|
protectedvirtual |
Explicit pressure source contribution.
Definition at line 150 of file kinematicSingleLayer.C.
References delta_, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, Foam::fvc::laplacian(), GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, pPrimary_, pSp_, IOobject::scopedName(), and sigma_.
Referenced by evolveRegion(), thermoSingleLayer::evolveRegion(), solveMomentum(), and solveThickness().
|
protectedvirtual |
Implicit pressure source coefficient.
Definition at line 165 of file kinematicSingleLayer.C.
References Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, gNormClipped(), GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, rho_, and IOobject::scopedName().
Referenced by evolveRegion(), thermoSingleLayer::evolveRegion(), solveMomentum(), solveThickness(), thermoSingleLayer::updateSurfaceTemperatures(), and updateSurfaceVelocities().
|
protectedvirtual |
Correct film coverage field.
Reimplemented in thermoSingleLayer.
Definition at line 178 of file kinematicSingleLayer.C.
References alpha_, delta_, deltaSmall_, and Foam::pos().
Referenced by kinematicSingleLayer(), and preEvolveRegion().
|
protectedvirtual |
Update the film sub-models.
Reimplemented in thermoSingleLayer.
Definition at line 184 of file kinematicSingleLayer.C.
References availableMass_, cloudDiameterTrans_, cloudMassTrans_, DebugInFunction, TimeState::deltaT(), Foam::endl(), injection_, singleLayerRegion::magSf(), rhoSp_, regionModel::time(), transfer_, and turbulence_.
Referenced by evolveRegion().
|
protectedvirtual |
Continuity check.
Definition at line 201 of file kinematicSingleLayer.C.
References cumulativeContErr_, deltaRho_, Foam::dimMass, Foam::dimVolume, Foam::fvc::domainIntegrate(), Foam::endl(), globalContErr, InfoInFunction, Foam::mag(), singleLayerRegion::magSf(), mass(), Foam::nl, solveContinuity(), sumLocalContErr, totalMass, and Foam::type().
Referenced by solveThickness().
|
protectedvirtual |
Update film surface velocities.
Definition at line 249 of file kinematicSingleLayer.C.
References polyMesh::boundaryMesh(), regionModel::intCoupledPatchIDs_, singleLayerRegion::nHat(), pp(), regionModel::regionMesh(), turbulence_, U_, Us_, and Uw_.
Referenced by preEvolveRegion(), and solveThickness().
|
protected |
Constrain a film region master/slave boundaries of a field to a.
given value
Definition at line 35 of file kinematicSingleLayerTemplates.C.
References Foam::endl(), field(), forAll, Foam::Info, regionModel::intCoupledPatchIDs_, and singleLayerRegion::passivePatchIDs_.
Referenced by solveThickness().
|
protectedvirtual |
Solve continuity equation.
Definition at line 235 of file kinematicSingleLayer.C.
References Foam::fvm::ddt(), DebugInFunction, deltaRho_, Foam::fvc::div(), Foam::endl(), phi_, rhoSp_, and solve().
Referenced by continuityCheck(), evolveRegion(), and thermoSingleLayer::evolveRegion().
|
protectedvirtual |
Solve for film velocity.
Definition at line 266 of file kinematicSingleLayer.C.
References Foam::fvm::ddt(), DebugInFunction, delta_, deltaRho_, Foam::fvm::div(), Foam::endl(), Foam::fvc::flux(), forces_, gTan(), Foam::fvc::interpolate(), singleLayerRegion::magSf(), momentumPredictor_, singleLayerRegion::nHat(), phi_, pp(), pu(), Foam::fvc::reconstruct(), regionModel::regionMesh(), rho_, rhoSp_, Foam::fvc::snGrad(), solve(), tUEqn(), turbulence_, U_, UEqn, and USp_.
Referenced by evolveRegion(), and thermoSingleLayer::evolveRegion().
|
protectedvirtual |
Solve coupled velocity-thickness equations.
Definition at line 321 of file kinematicSingleLayer.C.
References constrainFilmField(), continuityCheck(), Foam::fvm::ddt(), DebugInFunction, delta_, Foam::fvm::div(), Foam::endl(), Foam::fvc::flux(), fvMatrix< Type >::flux(), gTan(), Foam::fvc::interpolate(), Foam::fvm::laplacian(), fvMesh::magSf(), singleLayerRegion::magSf(), singleLayerRegion::nHat(), nNonOrthCorr_, phi_, phid(), pp(), pu(), Foam::fvc::reconstruct(), regionModel::regionMesh(), rho_, rhof(), rhoSp_, schemesLookup::setFluxRequired(), Foam::fvc::snGrad(), fvMatrix< Type >::solve(), U_, UEqn, and updateSurfaceVelocities().
Referenced by evolveRegion(), and thermoSingleLayer::evolveRegion().
| TypeName | ( | "kinematicSingleLayer" | ) |
Runtime type information.
References surfaceFilmRegionModel::g(), mesh, and Foam::readFields().
|
virtual |
Courant number evaluation.
Implements surfaceFilmModel.
Definition at line 895 of file kinematicSingleLayer.C.
References alpha_, CoNum, delta_, deltaCoLimit_, deltaRho_, Foam::endl(), forAll, Foam::Info, Foam::mag(), singleLayerRegion::magSf(), Foam::max(), phi_, Foam::reduce(), regionModel::regionMesh(), Foam::fvc::surfaceSum(), and regionModel::time_.
|
inline |
Return the momentum predictor.
Definition at line 37 of file kinematicSingleLayerI.H.
References momentumPredictor_.
|
inline |
Return the number of outer correctors.
Definition at line 43 of file kinematicSingleLayerI.H.
References nOuterCorr_.
|
inline |
Return the number of PISO correctors.
Definition at line 49 of file kinematicSingleLayerI.H.
References nCorr_.
|
inline |
Return the number of non-orthogonal correctors.
Definition at line 55 of file kinematicSingleLayerI.H.
References nNonOrthCorr_.
|
inline |
|
inline |
Return const access to the dynamic viscosity [Pa.s].
Definition at line 67 of file kinematicSingleLayerI.H.
References mu_.
|
inlinevirtual |
Return const access to the surface tension [kg/s2].
Implements surfaceFilmRegionModel.
Definition at line 73 of file kinematicSingleLayerI.H.
References sigma_.
|
inlinevirtual |
Return const access to the film thickness [m].
Implements surfaceFilmRegionModel.
Definition at line 79 of file kinematicSingleLayerI.H.
References delta_.
Referenced by filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs().
|
inlinevirtual |
Return the film coverage, 1 = covered, 0 = uncovered [].
Implements surfaceFilmRegionModel.
Definition at line 85 of file kinematicSingleLayerI.H.
References alpha_.
|
virtual |
Return the film velocity [m/s].
Implements surfaceFilmRegionModel.
Definition at line 926 of file kinematicSingleLayer.C.
References U_.
|
virtual |
Return the film surface velocity [m/s].
Implements surfaceFilmRegionModel.
Definition at line 932 of file kinematicSingleLayer.C.
References Us_.
|
virtual |
Return the film wall velocity [m/s].
Implements surfaceFilmRegionModel.
Definition at line 938 of file kinematicSingleLayer.C.
References Uw_.
|
virtual |
Return the film thickness*density (helper field) [kg/m3].
Definition at line 944 of file kinematicSingleLayer.C.
References deltaRho_.
|
virtual |
Return the film flux [kg.m/s].
Definition at line 950 of file kinematicSingleLayer.C.
References phi_.
|
virtual |
Return the film density [kg/m3].
Implements surfaceFilmRegionModel.
Definition at line 956 of file kinematicSingleLayer.C.
References rho_.
|
virtual |
Return the film mean temperature [K].
Implements surfaceFilmRegionModel.
Reimplemented in thermoSingleLayer.
Definition at line 962 of file kinematicSingleLayer.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().
|
virtual |
Return the film surface temperature [K].
Implements surfaceFilmRegionModel.
Reimplemented in thermoSingleLayer.
Definition at line 971 of file kinematicSingleLayer.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().
|
virtual |
Return the film wall temperature [K].
Implements surfaceFilmRegionModel.
Reimplemented in thermoSingleLayer.
Definition at line 980 of file kinematicSingleLayer.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().
|
virtual |
Return the film surface enthalpy [J/kg].
Implements surfaceFilmRegionModel.
Reimplemented in thermoSingleLayer.
Definition at line 989 of file kinematicSingleLayer.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().
|
virtual |
Return the film specific heat capacity [J/kg/K].
Implements surfaceFilmRegionModel.
Reimplemented in thermoSingleLayer.
Definition at line 998 of file kinematicSingleLayer.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().
|
virtual |
Return the film thermal conductivity [W/m/K].
Implements surfaceFilmRegionModel.
Reimplemented in thermoSingleLayer.
Definition at line 1007 of file kinematicSingleLayer.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().
|
virtual |
Return mass transfer source - Eulerian phase only.
Implements surfaceFilmRegionModel.
Definition at line 1016 of file kinematicSingleLayer.C.
References primaryMassTrans_.
|
virtual |
Return the film mass available for transfer to cloud.
Implements surfaceFilmRegionModel.
Definition at line 1022 of file kinematicSingleLayer.C.
References cloudMassTrans_.
|
virtual |
Return the parcel diameters originating from film to cloud.
Implements surfaceFilmRegionModel.
Definition at line 1028 of file kinematicSingleLayer.C.
References cloudDiameterTrans_.
|
virtual |
External hook to add sources to the film.
Implements surfaceFilmRegionModel.
Reimplemented in thermoSingleLayer.
Definition at line 803 of file kinematicSingleLayer.C.
References addedMassTotal_, DebugInFunction, Foam::endl(), Foam::nl, pSpPrimary_, rhoSpPrimary_, Foam::type(), and USpPrimary_.
Referenced by thermoSingleLayer::addSources().
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Return the current film mass.
Definition at line 193 of file kinematicSingleLayerI.H.
References deltaRho_, and singleLayerRegion::magSf().
Referenced by continuityCheck(), and preEvolveRegion().
|
inline |
Return the change in film mass due to sources/sinks.
Definition at line 199 of file kinematicSingleLayerI.H.
References TimeState::deltaT(), singleLayerRegion::magSf(), rhoSp_, and regionModel::time().
|
inline |
Return the gravity normal-to-patch component contribution.
Definition at line 205 of file kinematicSingleLayerI.H.
References surfaceFilmRegionModel::g_, GeometricField< scalar, fvPatchField, volMesh >::New(), singleLayerRegion::nHat(), and IOobjectOption::NO_REGISTER.
Referenced by gTan().
|
inline |
Return the gravity normal-to-patch component contribution.
Clipped so that only non-zero if g & nHat_ < 0
Definition at line 216 of file kinematicSingleLayerI.H.
References surfaceFilmRegionModel::g_, gNormClipped(), GeometricField< scalar, fvPatchField, volMesh >::New(), singleLayerRegion::nHat(), and IOobjectOption::NO_REGISTER.
Referenced by gNormClipped(), and pp().
|
inline |
Return the gravity tangential component contributions.
Definition at line 232 of file kinematicSingleLayerI.H.
References surfaceFilmRegionModel::g_, gNorm(), GeometricField< vector, fvPatchField, volMesh >::New(), singleLayerRegion::nHat(), and IOobjectOption::NO_REGISTER.
Referenced by solveMomentum(), and solveThickness().
|
inline |
Return the gravity tangential component contributions for patchI.
Definition at line 243 of file kinematicSingleLayerI.H.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), surfaceFilmRegionModel::g(), surfaceFilmRegionModel::g_, and singleLayerRegion::nHat().
|
virtual |
Pre-evolve film hook.
Reimplemented from regionModel.
Reimplemented in thermoSingleLayer.
Definition at line 827 of file kinematicSingleLayer.C.
References availableMass_, cloudDiameterTrans_, cloudMassTrans_, correctAlpha(), correctThermoFields(), DebugInFunction, Foam::endl(), mass(), regionModel::preEvolveRegion(), primaryMassTrans_, transferPrimaryRegionSourceFields(), transferPrimaryRegionThermoFields(), updateSurfaceVelocities(), and Foam::Zero.
Referenced by thermoSingleLayer::preEvolveRegion().
|
virtual |
Evolve the film equations.
Reimplemented from regionModel.
Reimplemented in thermoSingleLayer.
Definition at line 851 of file kinematicSingleLayer.C.
References DebugInFunction, delta_, deltaRho_, Foam::endl(), nCorr_, nOuterCorr_, pp(), pu(), rho_, solveContinuity(), solveMomentum(), solveThickness(), tUEqn(), UEqn, and updateSubmodels().
|
virtual |
Post-evolve film hook.
Reimplemented from regionModel.
Definition at line 886 of file kinematicSingleLayer.C.
References DebugInFunction, Foam::endl(), and resetPrimaryRegionSourceTerms().
|
virtual |
Return total mass source - Eulerian phase only.
Implements surfaceFilmModel.
Reimplemented in thermoSingleLayer.
Definition at line 1064 of file kinematicSingleLayer.C.
References Foam::dimMass, Foam::dimTime, Foam::dimVolume, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, regionModel::primaryMesh(), IOobject::scopedName(), and Foam::Zero.
|
virtual |
Return mass source for specie i - Eulerian phase only.
Implements surfaceFilmModel.
Reimplemented in thermoSingleLayer.
Definition at line 1076 of file kinematicSingleLayer.C.
References Foam::dimMass, Foam::dimTime, Foam::dimVolume, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, Foam::name(), GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, regionModel::primaryMesh(), IOobject::scopedName(), and Foam::Zero.
|
virtual |
Return enthalpy source - Eulerian phase only.
Implements surfaceFilmModel.
Reimplemented in thermoSingleLayer.
Definition at line 1091 of file kinematicSingleLayer.C.
References Foam::dimEnergy, Foam::dimTime, Foam::dimVolume, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, regionModel::primaryMesh(), IOobject::scopedName(), and Foam::Zero.
|
virtual |
Provide some feedback.
Reimplemented from regionModel.
Reimplemented in thermoSingleLayer.
Definition at line 1034 of file kinematicSingleLayer.C.
References addedMassTotal_, alpha_, delta_, deltaRho_, Foam::endl(), Foam::gMinMax(), Foam::gMinMaxMag(), Foam::gWeightedAverage(), Foam::gWeightedSum(), Foam::indent(), Foam::Info, injection_, singleLayerRegion::magSf(), MinMax< T >::max(), MinMax< T >::min(), Foam::nl, regionModel::outputProperties(), dictionary::readIfPresent(), Foam::returnReduce(), transfer_, Foam::type(), and U_.
Referenced by thermoSingleLayer::info().
|
protected |
Momentum predictor.
Definition at line 91 of file kinematicSingleLayer.H.
Referenced by kinematicSingleLayer(), momentumPredictor(), read(), and solveMomentum().
|
protected |
Number of outer correctors.
Definition at line 96 of file kinematicSingleLayer.H.
Referenced by evolveRegion(), thermoSingleLayer::evolveRegion(), kinematicSingleLayer(), nOuterCorr(), and read().
|
protected |
Number of PISO-like correctors.
Definition at line 101 of file kinematicSingleLayer.H.
Referenced by evolveRegion(), thermoSingleLayer::evolveRegion(), kinematicSingleLayer(), nCorr(), and read().
|
protected |
Number of non-orthogonal correctors.
Definition at line 106 of file kinematicSingleLayer.H.
Referenced by kinematicSingleLayer(), nNonOrthCorr(), read(), and solveThickness().
|
protected |
Cumulative continuity error.
Definition at line 111 of file kinematicSingleLayer.H.
Referenced by continuityCheck(), and kinematicSingleLayer().
|
protected |
Small delta.
Definition at line 116 of file kinematicSingleLayer.H.
Referenced by correctAlpha(), deltaSmall(), and kinematicSingleLayer().
|
protected |
Film thickness above which Courant number calculation in valid.
Definition at line 121 of file kinematicSingleLayer.H.
Referenced by CourantNumber(), and kinematicSingleLayer().
|
protected |
Density [kg/m3].
Definition at line 131 of file kinematicSingleLayer.H.
Referenced by correctThermoFields(), thermoSingleLayer::correctThermoFields(), evolveRegion(), thermoSingleLayer::evolveRegion(), kinematicSingleLayer(), pp(), rho(), solveMomentum(), solveThickness(), and thermoSingleLayer::thermoSingleLayer().
|
protected |
Dynamic viscosity [Pa.s].
Definition at line 136 of file kinematicSingleLayer.H.
Referenced by correctThermoFields(), kinematicSingleLayer(), mu(), and thermoSingleLayer::thermoSingleLayer().
|
protected |
Surface tension [m/s2].
Definition at line 141 of file kinematicSingleLayer.H.
Referenced by correctThermoFields(), thermoSingleLayer::correctThermoFields(), kinematicSingleLayer(), pu(), and sigma().
|
protected |
Film thickness [m].
Definition at line 149 of file kinematicSingleLayer.H.
Referenced by correctAlpha(), thermoSingleLayer::correctAlpha(), CourantNumber(), delta(), evolveRegion(), thermoSingleLayer::evolveRegion(), info(), kinematicSingleLayer(), pu(), solveMomentum(), solveThickness(), and thermoSingleLayer::thermoSingleLayer().
|
protected |
Film coverage indicator, 1 = covered, 0 = uncovered [].
Definition at line 154 of file kinematicSingleLayer.H.
Referenced by alpha(), correctAlpha(), thermoSingleLayer::correctAlpha(), CourantNumber(), info(), kinematicSingleLayer(), and thermoSingleLayer::q().
|
protected |
Velocity - mean [m/s].
Definition at line 159 of file kinematicSingleLayer.H.
Referenced by info(), kinematicSingleLayer(), solveMomentum(), solveThickness(), thermoSingleLayer::thermoSingleLayer(), U(), and updateSurfaceVelocities().
|
protected |
Velocity - surface [m/s].
Definition at line 164 of file kinematicSingleLayer.H.
Referenced by kinematicSingleLayer(), updateSurfaceVelocities(), and Us().
|
protected |
Velocity - wall [m/s].
Definition at line 169 of file kinematicSingleLayer.H.
Referenced by kinematicSingleLayer(), updateSurfaceVelocities(), and Uw().
|
protected |
Film thickness*density (helper field) [kg/m2].
Definition at line 174 of file kinematicSingleLayer.H.
Referenced by continuityCheck(), CourantNumber(), deltaRho(), evolveRegion(), thermoSingleLayer::evolveRegion(), info(), kinematicSingleLayer(), mass(), solveContinuity(), thermoSingleLayer::solveEnergy(), solveMomentum(), and thermoSingleLayer::thermoSingleLayer().
|
protected |
Mass flux (includes film thickness) [kg.m/s].
Definition at line 179 of file kinematicSingleLayer.H.
Referenced by CourantNumber(), kinematicSingleLayer(), phi(), solveContinuity(), thermoSingleLayer::solveEnergy(), solveMomentum(), solveThickness(), and thermoSingleLayer::thermoSingleLayer().
|
protected |
Film mass available for transfer to the primary region.
Definition at line 187 of file kinematicSingleLayer.H.
Referenced by kinematicSingleLayer(), preEvolveRegion(), primaryMassTrans(), thermoSingleLayer::Srho(), thermoSingleLayer::Srho(), and thermoSingleLayer::updateSubmodels().
|
protected |
Film mass available for transfer to cloud.
Definition at line 192 of file kinematicSingleLayer.H.
Referenced by cloudMassTrans(), kinematicSingleLayer(), preEvolveRegion(), updateSubmodels(), and thermoSingleLayer::updateSubmodels().
|
protected |
Parcel diameters originating from film to cloud.
Definition at line 197 of file kinematicSingleLayer.H.
Referenced by cloudDiameterTrans(), kinematicSingleLayer(), preEvolveRegion(), updateSubmodels(), and thermoSingleLayer::updateSubmodels().
|
protected |
Momentum [kg/m/s2].
Definition at line 209 of file kinematicSingleLayer.H.
Referenced by kinematicSingleLayer(), solveMomentum(), transferPrimaryRegionSourceFields(), USp(), and USp().
|
protected |
Pressure [Pa].
Definition at line 214 of file kinematicSingleLayer.H.
Referenced by kinematicSingleLayer(), pSp(), pSp(), pu(), thermoSingleLayer::thermoSingleLayer(), transferPrimaryRegionSourceFields(), and thermoSingleLayer::updateSubmodels().
|
protected |
Mass [kg/m2/s].
Definition at line 219 of file kinematicSingleLayer.H.
Referenced by deltaMass(), kinematicSingleLayer(), rhoSp(), rhoSp(), solveContinuity(), solveMomentum(), solveThickness(), transferPrimaryRegionSourceFields(), updateSubmodels(), and thermoSingleLayer::updateSubmodels().
|
protected |
Momentum [kg/m/s2].
Definition at line 228 of file kinematicSingleLayer.H.
Referenced by addSources(), kinematicSingleLayer(), resetPrimaryRegionSourceTerms(), transferPrimaryRegionSourceFields(), and USpPrimary().
|
protected |
Pressure [Pa].
Definition at line 233 of file kinematicSingleLayer.H.
Referenced by addSources(), kinematicSingleLayer(), pSpPrimary(), resetPrimaryRegionSourceTerms(), and transferPrimaryRegionSourceFields().
|
protected |
Mass [kg/m2/s].
Definition at line 238 of file kinematicSingleLayer.H.
Referenced by addSources(), kinematicSingleLayer(), resetPrimaryRegionSourceTerms(), rhoSpPrimary(), and transferPrimaryRegionSourceFields().
|
protected |
Velocity [m/s].
Definition at line 247 of file kinematicSingleLayer.H.
Referenced by kinematicSingleLayer(), transferPrimaryRegionThermoFields(), and UPrimary().
|
protected |
Pressure [Pa].
Definition at line 252 of file kinematicSingleLayer.H.
Referenced by kinematicSingleLayer(), pPrimary(), pu(), thermoSingleLayer::solveEnergy(), thermoSingleLayer::thermoSingleLayer(), and transferPrimaryRegionThermoFields().
|
protected |
Density [kg/m3].
Definition at line 257 of file kinematicSingleLayer.H.
Referenced by kinematicSingleLayer(), rhoPrimary(), transferPrimaryRegionThermoFields(), and thermoSingleLayer::updateSubmodels().
|
protected |
Viscosity [Pa.s].
Definition at line 262 of file kinematicSingleLayer.H.
Referenced by kinematicSingleLayer(), muPrimary(), and transferPrimaryRegionThermoFields().
|
protected |
Film thermo model.
Definition at line 270 of file kinematicSingleLayer.H.
Referenced by correctThermoFields(), thermoSingleLayer::correctThermoFields(), filmThermo(), kinematicSingleLayer(), and thermoSingleLayer::Srho().
|
protected |
Available mass for transfer via sub-models.
Definition at line 275 of file kinematicSingleLayer.H.
Referenced by kinematicSingleLayer(), preEvolveRegion(), updateSubmodels(), and thermoSingleLayer::updateSubmodels().
|
protected |
Cloud injection.
Definition at line 280 of file kinematicSingleLayer.H.
Referenced by info(), injection(), kinematicSingleLayer(), updateSubmodels(), and thermoSingleLayer::updateSubmodels().
|
protected |
Transfer with the continuous phase.
Definition at line 285 of file kinematicSingleLayer.H.
Referenced by info(), kinematicSingleLayer(), transfer(), updateSubmodels(), and thermoSingleLayer::updateSubmodels().
|
protected |
Turbulence model.
Definition at line 290 of file kinematicSingleLayer.H.
Referenced by kinematicSingleLayer(), solveMomentum(), turbulence(), updateSubmodels(), thermoSingleLayer::updateSubmodels(), and updateSurfaceVelocities().
|
protected |
List of film forces.
Definition at line 295 of file kinematicSingleLayer.H.
Referenced by kinematicSingleLayer(), and solveMomentum().
|
protected |
Cumulative mass added via sources [kg].
Definition at line 303 of file kinematicSingleLayer.H.
Referenced by addSources(), info(), kinematicSingleLayer(), and transferPrimaryRegionSourceFields().
1.16.1 