Public Member Functions | List of all members
noVirtualMass Class Reference
Inheritance diagram for noVirtualMass:
Inheritance graph
[legend]
Collaboration diagram for noVirtualMass:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("none")
 Runtime type information. More...
 
 noVirtualMass (const dictionary &dict, const phasePair &pair, const bool registerObject)
 Construct from a dictionary and a phase pair. More...
 
virtual ~noVirtualMass ()
 Destructor. More...
 
virtual tmp< volScalarFieldCvm () const
 Virtual mass coefficient. More...
 
virtual tmp< volScalarFieldK () const
 The virtual mass function K used in the momentum equation. More...
 
 TypeName ("none")
 Runtime type information. More...
 
 noVirtualMass (const dictionary &dict, const phasePair &pair, const bool registerObject)
 Construct from a dictionary and a phase pair. More...
 
virtual ~noVirtualMass ()
 Destructor. More...
 
virtual tmp< volScalarFieldCvm () const
 Virtual mass coefficient. More...
 
virtual tmp< volScalarFieldK () const
 The virtual mass function K used in the momentum equation. More...
 
- Public Member Functions inherited from virtualMassModel
 TypeName ("virtualMassModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, virtualMassModel, dictionary,( const dictionary &dict, const phasePair &pair, const bool registerObject ),(dict, pair, registerObject))
 
 virtualMassModel (const dictionary &dict, const phasePair &pair, const bool registerObject)
 Construct from a dictionary and a phase pair. More...
 
virtual ~virtualMassModel ()
 Destructor. More...
 
virtual tmp< volScalarFieldKi () const
 Return the phase-intensive virtual mass coefficient Ki. More...
 
virtual tmp< surfaceScalarFieldKf () const
 Return the virtual mass coefficient Kf. More...
 
bool writeData (Ostream &os) const
 Pure virtual writaData function. More...
 
 TypeName ("virtualMassModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, virtualMassModel, dictionary,( const dictionary &dict, const phasePair &pair, const bool registerObject ),(dict, pair, registerObject))
 
 virtualMassModel (const dictionary &dict, const phasePair &pair, const bool registerObject)
 Construct from a dictionary and a phase pair. More...
 
virtual ~virtualMassModel ()
 Destructor. More...
 
virtual tmp< volScalarFieldKi () const
 Return the phase-intensive virtual mass coefficient Ki. More...
 
virtual tmp< surfaceScalarFieldKf () const
 Return the virtual mass coefficient Kf. More...
 
bool writeData (Ostream &os) const
 Pure virtual writaData function. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Construct as copy. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Construct as copy with new name, transfering registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Construct as copy with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 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 up to date (obviously) More...
 
virtual void rename (const word &newName)
 Rename. More...
 
IstreamreadStream (const word &)
 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...
 
label watchIndex () const
 Return file-monitoring handle. More...
 
labelwatchIndex ()
 Return file-monitoring handle. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
 Write using given format, version and compression. More...
 
virtual bool write () const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 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. More...
 
 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. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
Foam::autoPtr< IOobjectclone () const
 Clone. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
bool & registerObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () const
 
fileName path () const
 Return complete path. More...
 
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read and check header info. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 

Additional Inherited Members

- Public Types inherited from regIOobject
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Types of communications. More...
 
- Public Types inherited from IOobject
enum  objectState { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
- Static Public Member Functions inherited from virtualMassModel
static autoPtr< virtualMassModelNew (const dictionary &dict, const phasePair &pair)
 
static autoPtr< virtualMassModelNew (const dictionary &dict, const phasePair &pair)
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- 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 Name >
static word groupName (Name name, const word &group)
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 
- Static Public Attributes inherited from virtualMassModel
static const dimensionSet dimK
 Coefficient dimensions. More...
 
- Static Public Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static int fileModificationSkew
 
static fileCheckTypes fileModificationChecking
 
- Protected Member Functions inherited from IOobject
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
IstreamobjectStream (const fileName &)
 Construct and return an IFstream for the object given the. More...
 
void setBad (const string &)
 Set the object state to bad. More...
 
- Protected Attributes inherited from virtualMassModel
const phasePairpair_
 Phase pair. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Source files

Source files

Definition at line 52 of file noVirtualMass.H.

Constructor & Destructor Documentation

noVirtualMass ( const dictionary dict,
const phasePair pair,
const bool  registerObject 
)

Construct from a dictionary and a phase pair.

virtual ~noVirtualMass ( )
virtual

Destructor.

noVirtualMass ( const dictionary dict,
const phasePair pair,
const bool  registerObject 
)

Construct from a dictionary and a phase pair.

virtual ~noVirtualMass ( )
virtual

Destructor.

Member Function Documentation

TypeName ( "none"  )

Runtime type information.

virtual tmp<volScalarField> Cvm ( ) const
virtual

Virtual mass coefficient.

Implements virtualMassModel.

virtual tmp<volScalarField> K ( ) const
virtual

The virtual mass function K used in the momentum equation.

Reimplemented from virtualMassModel.

TypeName ( "none"  )

Runtime type information.

virtual tmp<volScalarField> Cvm ( ) const
virtual

Virtual mass coefficient.

Implements virtualMassModel.

virtual tmp<volScalarField> K ( ) const
virtual

The virtual mass function K used in the momentum equation.

Reimplemented from virtualMassModel.


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