Basic sub-grid obstacle drag model. Details supplied by J Puttock 2/7/06. More...
Public Member Functions | |
| TypeName ("basic") | |
| Runtime type information. More... | |
| basic (const dictionary &PDRProperties, const compressible::RASModel &turbulence, const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi) | |
| Construct from components. More... | |
| virtual | ~basic () |
| Destructor. More... | |
| virtual tmp< volSymmTensorField > | Dcu () const |
| Return the momentum drag coefficient. More... | |
| virtual tmp< volScalarField > | Gk () const |
| Return the momentum drag turbulence generation rate. More... | |
| virtual bool | read (const dictionary &PDRProperties) |
| Update properties from given dictionary. More... | |
| void | writeFields () const |
| Write fields. More... | |
 Public Member Functions inherited from PDRDragModel | |
| TypeName ("PDRDragModel") | |
| Runtime type information. More... | |
| declareRunTimeSelectionTable (autoPtr, PDRDragModel, dictionary,(const dictionary &PDRProperties, const compressible::RASModel &turbulence, const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi),(PDRProperties, turbulence, rho, U, phi)) | |
| PDRDragModel (const dictionary &PDRProperties, const compressible::RASModel &turbulence, const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi) | |
| Construct from components. More... | |
| virtual | ~PDRDragModel () |
| Destructor. More... | |
| bool | on () const |
| Return true if the drag model is switched on. More... | |
| virtual bool | writeData (Ostream &) const |
| Pure virtual writeData function. More... | |
| virtual bool | read () |
| Inherit read from regIOobject. More... | |
| Public Member Functions inherited from regIOobject | |
| TypeName ("regIOobject") | |
| Runtime type information. More... | |
| regIOobject (const IOobject &io, const bool isTime=false) | |
| regIOobject (const regIOobject &rio) | |
| Copy construct. More... | |
| regIOobject (const regIOobject &rio, bool registerCopy) | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| regIOobject (const IOobject &io, const regIOobject &rio) | |
| Copy construct with new IO parameters. More... | |
| virtual | ~regIOobject () |
| Destructor. More... | |
| bool | checkIn () |
| Add object to registry, if not already registered. More... | |
| bool | checkOut () |
| Remove all file watches and remove object from registry. More... | |
| virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
| bool | ownedByRegistry () const |
| Is this object owned by the registry? More... | |
| bool | store () |
| void | release (const bool unregister=false) |
| Release ownership of this object from its registry. More... | |
| label | eventNo () const |
| Event number at last update. More... | |
| label & | eventNo () |
| Event number at last update. More... | |
| bool | upToDate (const regIOobject &) const |
| Return true if up-to-date with respect to given object. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| void | setUpToDate () |
| Set as up-to-date. More... | |
| virtual void | rename (const word &newName) |
| Rename. More... | |
| virtual fileName | filePath () const |
| Return complete path + object name if the file exists. More... | |
| bool | headerOk () |
| Read and check header info. More... | |
| Istream & | readStream (const word &, const bool valid=true) |
| Return Istream and check object type against that given. More... | |
| void | close () |
| Close Istream. More... | |
| virtual bool | readData (Istream &) |
| Virtual readData function. More... | |
| virtual bool | read () |
| Read object. More... | |
| virtual label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. More... | |
| const labelList & | watchIndices () const |
| Return file-monitoring handles. More... | |
| labelList & | watchIndices () |
| Return file-monitoring handles. More... | |
| virtual bool | modified () const |
| virtual bool | readIfModified () |
| Read object if modified (as set by call to modified) More... | |
| virtual bool | writeObject (IOstreamOption streamOpt, const bool valid) const |
| Write using stream options. More... | |
| virtual bool | write (const bool valid=true) const |
| Write using setting from DB. More... | |
| virtual bool | global () const |
| Is object global. More... | |
| void | operator= (const IOobject &io) |
| Copy assignment. More... | |
| virtual bool | writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType comp, const bool valid) const |
| Write using given format, version and compression. More... | |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Declare type-name, virtual type (with debug switch) More... | |
| IOobject (const IOobject &)=default | |
| Copy construct. More... | |
| virtual | ~IOobject ()=default |
| Destructor. More... | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from name, instance, registry, io options. More... | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from name, instance, local, registry, io options. More... | |
| IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from path, registry, io options. More... | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| Copy construct, resetting registry. More... | |
| IOobject (const IOobject &io, const word &name) | |
| Copy construct, resetting name. More... | |
| autoPtr< IOobject > | clone () const |
| Clone. More... | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. More... | |
| const objectRegistry & | db () const |
| Return the local objectRegistry. More... | |
| const Time & | time () const |
| Return time. More... | |
| const word & | name () const |
| Return name. More... | |
| const word & | headerClassName () const |
| Return name of the class name read from header. More... | |
| word & | headerClassName () |
| Return non-constant access to the class name read from header. More... | |
| const string & | note () const |
| Return the optional note. More... | |
| string & | note () |
| Return non-constant access to the optional note. More... | |
| bool | registerObject () const |
| Should object created with this IOobject be registered? More... | |
| bool & | registerObject () |
| Should object created with this IOobject be registered? More... | |
| bool | globalObject () const |
| Is object same for all processors? More... | |
| bool & | globalObject () |
| Is object same for all processors? More... | |
| unsigned | labelByteSize () const |
| The label byte-size, possibly read from the header. More... | |
| unsigned | scalarByteSize () const |
| The scalar byte-size, possibly read from the header. More... | |
| bool | isHeaderClassName (const word &clsName) const |
| Test if headerClassName() equals the given class name. More... | |
| template<class Type > | |
| bool | isHeaderClassName () const |
| Test if headerClassName() equals Type::typeName. More... | |
| readOption | readOpt () const |
| The read option. More... | |
| readOption & | readOpt () |
| Non-constant access to the read option. More... | |
| writeOption | writeOpt () const |
| The write option. More... | |
| writeOption & | writeOpt () |
| Non-constant access to the write option. More... | |
| word | group () const |
| Return group (extension part of name) More... | |
| word | member () const |
| Return member (name without the extension) More... | |
| const fileName & | rootPath () const |
| const fileName & | caseName () const |
| const fileName & | instance () const |
| fileName & | instance () |
| const fileName & | local () const |
| fileName | path () const |
| The complete path. More... | |
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. More... | |
| fileName | objectPath () const |
| The complete path + object name. More... | |
| fileName | localFilePath (const word &typeName, const bool search=true) const |
| Helper for filePath that searches locally. More... | |
| fileName | globalFilePath (const word &typeName, const bool search=true) const |
| Helper for filePath that searches up if in parallel. More... | |
| bool | readHeader (Istream &is) |
| Read header. More... | |
| template<class Type > | |
| bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
| Read header (uses typeFilePath to find file) and check its info. More... | |
| template<class Type > | |
| void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. More... | |
| bool | writeHeader (Ostream &os) const |
| Write header. More... | |
| bool | writeHeader (Ostream &os, const word &objectType) const |
| Write header. Allow override of type. More... | |
| bool | good () const |
| bool | bad () const |
| InfoProxy< IOobject > | info () const |
| Return info proxy. More... | |
| void | operator= (const IOobject &io) |
| template<> | |
| bool | isHeaderClassName () const |
Specialization for void always returns true (no headerClassName check). More... | |
| template<class StringType > | |
| Foam::word | groupName (StringType base, const word &group) |
| template<class StringType > | |
| Foam::word | scopedName (StringType scope, const word &name) |
Additional Inherited Members | |
| Public Types inherited from IOobject | |
| enum | objectState : char { GOOD, BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ } |
| Enumeration defining the read options. More... | |
| enum | writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 } |
| Enumeration defining the write options. More... | |
| enum | fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster } |
| Enumeration defining the file checking options. More... | |
| Static Public Member Functions inherited from PDRDragModel | |
| static autoPtr< PDRDragModel > | New (const dictionary &PDRProperties, const compressible::RASModel &turbulence, const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi) |
| Return a reference to the selected Xi model. More... | |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type > | |
| static Type & | store (Type *p) |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &aptr) |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &&aptr) |
| template<class Type > | |
| static Type & | store (tmp< Type > &tptr) |
| template<class Type > | |
| static Type & | store (tmp< Type > &&tptr) |
| Static Public Member Functions inherited from IOobject | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. More... | |
| template<class StringType > | |
| static word | groupName (StringType base, const word &group) |
| Create dot-delimited name.group string. More... | |
| static word | group (const word &name) |
| Return group (extension part of name) More... | |
| static word | member (const word &name) |
| Return member (name without the extension) More... | |
| template<class StringType > | |
| static word | scopedName (StringType scope, const word &name) |
| Create scope:name or scope_name string. More... | |
| static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. More... | |
| static Ostream & | writeBanner (Ostream &os, bool noHint=false) |
| Write the standard OpenFOAM file/dictionary banner. More... | |
| static Ostream & | writeDivider (Ostream &os) |
| Write the standard file section divider. More... | |
| static Ostream & | writeEndDivider (Ostream &os) |
| Write the standard end file divider. More... | |
| Static Public Attributes inherited from regIOobject | |
| static float | fileModificationSkew |
| static int | maxFileModificationPolls |
| Static Public Attributes inherited from IOobject | |
| static const Enum< fileCheckTypes > | fileCheckTypesNames |
| Names for the fileCheckTypes. More... | |
| static char | scopeSeparator |
| Character for scoping object names (':' or '_') More... | |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. More... | |
| Protected Member Functions inherited from regIOobject | |
| bool | readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName) |
| Helper: check readOpt flags and read if necessary. More... | |
| Istream * | objectStream () |
| Construct and return an IFstream for the object. More... | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &s) |
| Set the object state to bad. More... | |
| Protected Attributes inherited from PDRDragModel | |
| dictionary | PDRDragModelCoeffs_ |
| const compressible::RASModel & | turbulence_ |
| const volScalarField & | rho_ |
| const volVectorField & | U_ |
| const surfaceScalarField & | phi_ |
| bool | on_ |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. More... | |
Basic sub-grid obstacle drag model. Details supplied by J Puttock 2/7/06.
The resistance term (force per unit of volume) is given by:
\[ R = -\frac{1}{2} \rho \vert \dwea{\vec{U}} \vert \dwea{\vec{U}}.D \]
where:
\( D \) is the tensor field "CR" in \( m^{-1} \)
This is term is treated implicitly in UEqn.H
Sub-grid turbulence generation
The turbulence source term \( G_{R} \) occurring in the \( \kappa-\epsilon \) equations for the generation of turbulence due to interaction with unresolved obstacles :
\( G_{R} = C_{s}\beta_{\nu} \mu_{eff} A_{w}^{2}(\dwea{\vec{U}}-\dwea{\vec{U}_{s}})^2 + \frac{1}{2} \rho \vert \dwea{\vec{U}} \vert \dwea{\vec{U}}.T.\dwea{\vec{U}} \)
where:
\( C_{s} \) = 1
\( \beta_{\nu} \) is the volume porosity (file "betav").
\( \mu_{eff} \) is the effective viscosity.
\( A_{w}^{2}\) is the obstacle surface area per unit of volume (file "Aw").
\( \dwea{\vec{U}_{s}} \) is the slip velocity and is considered \( \frac{1}{2}. \dwea{\vec{U}} \).
\( T \) is a tensor in the file CT.
The term \( G_{R} \) is treated explicitly in the \( \kappa-\epsilon \) Eqs in the PDRkEpsilon.C file.
| basic | ( | const dictionary & | PDRProperties, |
| const compressible::RASModel & | turbulence, | ||
| const volScalarField & | rho, | ||
| const volVectorField & | U, | ||
| const surfaceScalarField & | phi | ||
| ) |
Construct from components.
|
virtual |
Destructor.
| TypeName | ( | "basic" | ) |
Runtime type information.
|
virtual |
Return the momentum drag coefficient.
Implements PDRDragModel.
|
virtual |
Return the momentum drag turbulence generation rate.
Implements PDRDragModel.
|
virtual |
Update properties from given dictionary.
Implements PDRDragModel.
|
virtual |
Write fields.
Reimplemented from PDRDragModel.
1.8.17 