A centralized porousZone collection. More...
#include <finiteVolume/porousZones.H>
A centralized porousZone collection.
Container class for a set of porousZones with the porousZone member functions implemented to loop over the functions for each porousZone.
The input file constant/porousZone is implemented as IOPtrList<porousZone> and contains the following type of data:
1
(
cat1
{
coordinateSystemsystem_10;
porosity0.781;
Darcy
{
d d [0 -2 0 0 0] (-1000 -1000 0.50753e+08);
f f [0 -1 0 0 0] (-1000 -1000 12.83);
}
}
)
Definition at line 77 of file porousZones.H.
Inheritance diagram for porousZones:
Collaboration diagram for porousZones:Public Member Functions | |
| porousZones (const fvMesh &) | |
| Construct from fvMesh. | |
| template<class Type > | |
| tmp< fvMatrix< Type > > | ddt (GeometricField< Type, fvPatchField, volMesh > &) |
| mirror fvm::ddt with porosity | |
| template<class Type > | |
| tmp< fvMatrix< Type > > | ddt (const geometricOneField &, GeometricField< Type, fvPatchField, volMesh > &) |
| mirror fvm::ddt with porosity | |
| template<class Type > | |
| tmp< fvMatrix< Type > > | ddt (const dimensionedScalar &, GeometricField< Type, fvPatchField, volMesh > &) |
| mirror fvm::ddt with porosity | |
| template<class Type > | |
| tmp< fvMatrix< Type > > | ddt (const volScalarField &, GeometricField< Type, fvPatchField, volMesh > &) |
| mirror fvm::ddt with porosity | |
| void | addResistance (fvVectorMatrix &UEqn) const |
| Add the viscous and inertial resistance force contribution. | |
| void | addResistance (const fvVectorMatrix &UEqn, volTensorField &AU) const |
| Add the viscous and inertial resistance force contribution. | |
| virtual bool | readData (Istream &) |
| read modified data | |
| bool | writeData (Ostream &, bool subDict=true) const |
| write data | |
Public Member Functions inherited from IOPtrList< porousZone > | |
| TypeName ("PtrList") | |
| Runtime type information. | |
| IOPtrList (const IOobject &, const INew &) | |
| Construct from IOobject using given Istream constructor class. | |
| IOPtrList (const IOobject &) | |
| Construct from IOobject. | |
| IOPtrList (const IOobject &, const label) | |
| Construct from IOobject with given size. | |
| IOPtrList (const IOobject &, const PtrList< porousZone > &) | |
| Construct from IOobject and a PtrList. | |
| IOPtrList (const IOobject &, const Xfer< PtrList< porousZone > > &) | |
| Construct by transferring the PtrList contents. | |
| virtual | ~IOPtrList () |
| bool | writeData (Ostream &) const |
| Pure virtual writaData function. | |
| void | operator= (const IOPtrList< porousZone > &) |
Public Member Functions inherited from regIOobject | |
| TypeName ("regIOobject") | |
| Runtime type information. | |
| regIOobject (const IOobject &, const bool isTime=false) | |
| Construct from IOobject. Optional flag for if IOobject is the. | |
| regIOobject (const regIOobject &) | |
| Construct as copy. | |
| regIOobject (const regIOobject &, bool registerCopy) | |
| Construct as copy, and transferring registry registration to copy. | |
| virtual | ~regIOobject () |
| bool | checkIn () |
| Add object to registry. | |
| bool | checkOut () |
| Remove object from registry. | |
| bool | ownedByRegistry () const |
| Is this object owned by the registry? | |
| void | store () |
| Transfer ownership of this object to its registry. | |
| void | release () |
| Release ownership of this object from its registry. | |
| label | eventNo () const |
| Event number at last update. | |
| label & | eventNo () |
| Event number at last update. | |
| bool | upToDate (const word &) const |
| Am I uptodate with respect to other regIOobjects. | |
| bool | upToDate (const word &, const word &) const |
| bool | upToDate (const word &, const word &, const word &) const |
| bool | upToDate (const word &, const word &, const word &, const word &) const |
| void | setUpToDate () |
| Flag me as up to date. | |
| virtual void | rename (const word &newName) |
| Rename. | |
| Istream & | readStream (const word &) |
| Return Istream and check object type against that given. | |
| void | close () |
| Close Istream. | |
| virtual bool | read () |
| Read object. | |
| virtual bool | modified () const |
| Return true if the object's file has been modified. | |
| virtual bool | readIfModified () |
| Read object if modified. | |
| virtual bool | writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const |
| Write using given format, version and compression. | |
| virtual bool | write () const |
| Write using setting from DB. | |
| void | operator= (const IOobject &) |
Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Runtime type information. | |
| 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. | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from name, instance, local, registry, io options. | |
| IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from path, registry, io options. | |
| Foam::autoPtr< IOobject > | clone () const |
| Clone. | |
| virtual | ~IOobject () |
| const Time & | time () const |
| Return time. | |
| const objectRegistry & | db () const |
| Return the local objectRegistry. | |
| const word & | name () const |
| Return name. | |
| const word & | headerClassName () const |
| Return name of the class name read from header. | |
| string & | note () |
| Return non-constant access to the optional note. | |
| const string & | note () const |
| Return the optional note. | |
| bool | registerObject () const |
| Register object created from this IOobject with registry if true. | |
| readOption | readOpt () const |
| readOption & | readOpt () |
| writeOption | writeOpt () const |
| writeOption & | writeOpt () |
| const fileName & | rootPath () const |
| const fileName & | caseName () const |
| const fileName & | instance () const |
| fileName & | instance () |
| const fileName & | local () const |
| fileName | path () const |
| Return complete path. | |
| fileName | path (const word &instance, const fileName &local="") const |
| Return complete path with alternative instance and local. | |
| fileName | objectPath () const |
| Return complete path + object name. | |
| fileName | filePath () const |
| Return complete path + object name if the file exists. | |
| bool | readHeader (Istream &) |
| Read header. | |
| bool | headerOk () |
| Read and check header info. | |
| bool | writeHeader (Ostream &) const |
| Write header. | |
| bool | good () const |
| bool | bad () const |
| InfoProxy< IOobject > | info () const |
| Return info proxy. | |
Public Member Functions inherited from PtrList< porousZone > | |
| PtrList () | |
| Null Constructor. | |
| PtrList (const label) | |
| Construct with length specified. | |
| PtrList (const PtrList< porousZone > &) | |
| Copy constructor. | |
| PtrList (const PtrList< porousZone > &, const CloneArg &) | |
| Copy constructor with additional argument for clone. | |
| PtrList (const Xfer< PtrList< porousZone > > &) | |
| Construct by transferring the parameter contents. | |
| PtrList (PtrList< porousZone > &, bool reUse) | |
| Construct as copy or re-use as specified. | |
| PtrList (const SLPtrList< porousZone > &) | |
| Construct as copy of SLPtrList<T> | |
| PtrList (Istream &, const INew &) | |
| Construct from Istream using given Istream constructor class. | |
| PtrList (Istream &) | |
| Construct from Istream using default Istream constructor class. | |
| ~PtrList () | |
| label | size () const |
| Return the number of elements in the PtrList. | |
| bool | empty () const |
| Return true if the PtrList is empty (ie, size() is zero). | |
| void | setSize (const label) |
| Reset size of PtrList. This can only be used to set the size. | |
| void | resize (const label) |
| Reset size of PtrList. This can only be used to set the size. | |
| void | clear () |
| Clear the PtrList, i.e. set size to zero deleting all the. | |
| void | transfer (PtrList< porousZone > &) |
| Transfer the contents of the argument PtrList into this PtrList. | |
| Xfer< PtrList< porousZone > > | xfer () |
| Transfer contents to the Xfer container. | |
| bool | set (const label) const |
| Is element set. | |
| autoPtr< porousZone > | set (const label, porousZone *) |
| Set element. Return old element (can be NULL). | |
| autoPtr< porousZone > | set (const label, const autoPtr< porousZone > &) |
| autoPtr< porousZone > | set (const label, const tmp< porousZone > &) |
| void | reorder (const UList< label > &) |
| Reorders elements. Ordering does not have to be done in. | |
| const porousZone & | operator[] (const label) const |
| Return element const reference. | |
| porousZone & | operator[] (const label) |
| Return element reference. | |
| const porousZone * | operator() (const label) const |
| Return element const pointer. | |
| PtrList< porousZone > & | operator= (const PtrList< porousZone > &) |
| Assignment. | |
| iterator | begin () |
| Return an iterator to begin traversing the PtrList. | |
| iterator | end () |
| Return an iterator to end traversing the PtrList. | |
| porousZones | ( | const fvMesh & | mesh | ) |
Construct from fvMesh.
with automatically constructed coordinate systems list
Definition at line 40 of file porousZones.C.
| Foam::tmp< Foam::fvMatrix< Type > > ddt | ( | GeometricField< Type, fvPatchField, volMesh > & | vf | ) |
mirror fvm::ddt with porosity
Definition at line 48 of file porousZonesTemplates.C.
References Foam::fvm::ddt().
| Foam::tmp< Foam::fvMatrix< Type > > ddt | ( | const geometricOneField & | , |
| GeometricField< Type, fvPatchField, volMesh > & | vf | ||
| ) |
mirror fvm::ddt with porosity
Definition at line 61 of file porousZonesTemplates.C.
References Foam::fvm::ddt().
| Foam::tmp< Foam::fvMatrix< Type > > ddt | ( | const dimensionedScalar & | rho, |
| GeometricField< Type, fvPatchField, volMesh > & | vf | ||
| ) |
mirror fvm::ddt with porosity
Definition at line 75 of file porousZonesTemplates.C.
References Foam::fvm::ddt().
| Foam::tmp< Foam::fvMatrix< Type > > ddt | ( | const volScalarField & | rho, |
| GeometricField< Type, fvPatchField, volMesh > & | vf | ||
| ) |
mirror fvm::ddt with porosity
Definition at line 89 of file porousZonesTemplates.C.
References Foam::fvm::ddt().
| void addResistance | ( | fvVectorMatrix & | UEqn | ) | const |
Add the viscous and inertial resistance force contribution.
to the momentum equation
Definition at line 62 of file porousZones.C.
References porousZone::addResistance(), forAll, and PtrList< porousZone >::operator[]().
| void addResistance | ( | const fvVectorMatrix & | UEqn, |
| volTensorField & | AU | ||
| ) | const |
Add the viscous and inertial resistance force contribution.
to the tensorial diagonal
Definition at line 72 of file porousZones.C.
References GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), and forAll.
|
virtual |
read modified data
Reimplemented from regIOobject.
Definition at line 91 of file porousZones.C.
References clear(), IOstream::good(), IOobject::MUST_READ, and IOobject::NO_WRITE.
| bool writeData | ( | Ostream & | os, |
| bool | subDict = true |
||
| ) | const |
write data
Definition at line 115 of file porousZones.C.
References token::BEGIN_LIST, token::END_LIST, forAll, IOstream::good(), and Foam::nl.