FreeFOAM The Cross-Platform CFD Toolkit
MRFZones Class Reference

Container class for a set of MRFZones with the MRFZone member functions implemented to loop over the functions for each MRFZone. More...

#include <finiteVolume/MRFZones.H>


Detailed Description

Container class for a set of MRFZones with the MRFZone member functions implemented to loop over the functions for each MRFZone.

Source files

Definition at line 51 of file MRFZones.H.

+ Inheritance diagram for MRFZones:
+ Collaboration diagram for MRFZones:

List of all members.

Public Member Functions

 MRFZones (const fvMesh &mesh)
 Construct from fvMesh.
void addCoriolis (fvVectorMatrix &UEqn) const
 Add the Coriolis force contribution to the momentum equation.
void addCoriolis (const volScalarField &rho, fvVectorMatrix &UEqn) const
 Add the Coriolis force contribution to the momentum equation.
void relativeVelocity (volVectorField &U) const
 Make the given absolute velocity relative within the MRF region.
void absoluteVelocity (volVectorField &U) const
 Make the given relative velocity absolute within the MRF region.
void relativeFlux (surfaceScalarField &phi) const
 Make the given absolute flux relative within the MRF region.
void relativeFlux (const surfaceScalarField &rho, surfaceScalarField &phi) const
 Make the given absolute mass-flux relative within the MRF region.
void absoluteFlux (surfaceScalarField &phi) const
 Make the given relative flux absolute within the MRF region.
void absoluteFlux (const surfaceScalarField &rho, surfaceScalarField &phi) const
 Make the given relative mass-flux absolute within the MRF region.
void correctBoundaryVelocity (volVectorField &U) const
 Correct the boundary velocity for the roation of the MRF region.
- Public Member Functions inherited from IOPtrList< MRFZone >
 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< MRFZone > &)
 Construct from IOobject and a PtrList.
 IOPtrList (const IOobject &, const Xfer< PtrList< MRFZone > > &)
 Construct by transferring the PtrList contents.
virtual ~IOPtrList ()
bool writeData (Ostream &) const
 Pure virtual writaData function.
void operator= (const IOPtrList< MRFZone > &)
- 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.
IstreamreadStream (const word &)
 Return Istream and check object type against that given.
void close ()
 Close Istream.
virtual bool readData (Istream &)
 Virtual readData function.
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 &registry, 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 &registry, 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 &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options.
Foam::autoPtr< IOobjectclone () const
 Clone.
virtual ~IOobject ()
const Timetime () const
 Return time.
const objectRegistrydb () const
 Return the local objectRegistry.
const wordname () const
 Return name.
const wordheaderClassName () const
 Return name of the class name read from header.
stringnote ()
 Return non-constant access to the optional note.
const stringnote () const
 Return the optional note.
bool registerObject () const
 Register object created from this IOobject with registry if true.
readOption readOpt () const
readOptionreadOpt ()
writeOption writeOpt () const
writeOptionwriteOpt ()
const fileNamerootPath () const
const fileNamecaseName () const
const fileNameinstance () const
fileNameinstance ()
const fileNamelocal () 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< IOobjectinfo () const
 Return info proxy.
- Public Member Functions inherited from PtrList< MRFZone >
 PtrList ()
 Null Constructor.
 PtrList (const label)
 Construct with length specified.
 PtrList (const PtrList< MRFZone > &)
 Copy constructor.
 PtrList (const PtrList< MRFZone > &, const CloneArg &)
 Copy constructor with additional argument for clone.
 PtrList (const Xfer< PtrList< MRFZone > > &)
 Construct by transferring the parameter contents.
 PtrList (PtrList< MRFZone > &, bool reUse)
 Construct as copy or re-use as specified.
 PtrList (const SLPtrList< MRFZone > &)
 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< MRFZone > &)
 Transfer the contents of the argument PtrList into this PtrList.
Xfer< PtrList< MRFZone > > xfer ()
 Transfer contents to the Xfer container.
bool set (const label) const
 Is element set.
autoPtr< MRFZoneset (const label, MRFZone *)
 Set element. Return old element (can be NULL).
autoPtr< MRFZoneset (const label, const autoPtr< MRFZone > &)
autoPtr< MRFZoneset (const label, const tmp< MRFZone > &)
void reorder (const UList< label > &)
 Reorders elements. Ordering does not have to be done in.
const MRFZoneoperator[] (const label) const
 Return element const reference.
MRFZoneoperator[] (const label)
 Return element reference.
const MRFZoneoperator() (const label) const
 Return element const pointer.
PtrList< MRFZone > & operator= (const PtrList< MRFZone > &)
 Assignment.
iterator begin ()
 Return an iterator to begin traversing the PtrList.
iterator end ()
 Return an iterator to end traversing the PtrList.

Constructor & Destructor Documentation

MRFZones ( const fvMesh mesh)

Construct from fvMesh.

Definition at line 39 of file MRFZones.C.


Member Function Documentation

void addCoriolis ( fvVectorMatrix UEqn) const

Add the Coriolis force contribution to the momentum equation.

Definition at line 58 of file MRFZones.C.

References forAll.

void addCoriolis ( const volScalarField rho,
fvVectorMatrix UEqn 
) const

Add the Coriolis force contribution to the momentum equation.

Definition at line 68 of file MRFZones.C.

References forAll.

void relativeVelocity ( volVectorField U) const

Make the given absolute velocity relative within the MRF region.

Definition at line 80 of file MRFZones.C.

References forAll.

void absoluteVelocity ( volVectorField U) const

Make the given relative velocity absolute within the MRF region.

Definition at line 89 of file MRFZones.C.

References forAll.

void relativeFlux ( surfaceScalarField phi) const

Make the given absolute flux relative within the MRF region.

Definition at line 98 of file MRFZones.C.

References forAll.

void relativeFlux ( const surfaceScalarField rho,
surfaceScalarField phi 
) const

Make the given absolute mass-flux relative within the MRF region.

Definition at line 108 of file MRFZones.C.

References forAll.

void absoluteFlux ( surfaceScalarField phi) const

Make the given relative flux absolute within the MRF region.

Definition at line 120 of file MRFZones.C.

References forAll.

void absoluteFlux ( const surfaceScalarField rho,
surfaceScalarField phi 
) const

Make the given relative mass-flux absolute within the MRF region.

Definition at line 130 of file MRFZones.C.

References forAll.

void correctBoundaryVelocity ( volVectorField U) const

Correct the boundary velocity for the roation of the MRF region.

Definition at line 142 of file MRFZones.C.

References forAll.


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