Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
porosityModel Class Referenceabstract

Top level model for porosity models. More...

Inheritance diagram for porosityModel:
Inheritance graph
[legend]
Collaboration diagram for porosityModel:
Collaboration graph
[legend]

Classes

class  iNew
 Return pointer to new porosityModel object created on the freestore. More...
 

Public Member Functions

 TypeName ("porosityModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, porosityModel, mesh,( const word &modelName, const word &name, const fvMesh &mesh, const dictionary &dict, const word &cellZoneName ),(modelName, name, mesh, dict, cellZoneName))
 Selection table. More...
 
 porosityModel (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict, const word &cellZoneName=word::null)
 Constructor. More...
 
virtual ~porosityModel ()
 Destructor. More...
 
const wordname () const
 Return const access to the porosity model name. More...
 
bool active () const
 Return const access to the porosity active flag. More...
 
const labelListcellZoneIDs () const
 Return const access to the cell zone IDs. More...
 
virtual void transformModelData ()
 Transform the model data wrt mesh changes. More...
 
virtual tmp< vectorFieldforce (const volVectorField &U, const volScalarField &rho, const volScalarField &mu)
 Return the force over the cell zone(s) More...
 
virtual void addResistance (fvVectorMatrix &UEqn)
 Add resistance. More...
 
virtual void addResistance (fvVectorMatrix &UEqn, const volScalarField &rho, const volScalarField &mu)
 Add resistance. More...
 
virtual void addResistance (const fvVectorMatrix &UEqn, volTensorField &AU, bool correctAUprocBC)
 Add resistance. More...
 
virtual bool writeData (Ostream &os) const
 Write. More...
 
virtual bool read (const dictionary &dict)
 Read porosity dictionary. 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)
 

Static Public Member Functions

static autoPtr< porosityModelNew (const word &name, const fvMesh &mesh, const dictionary &dict, const word &cellZoneName=word::null)
 Selector. More...
 
- 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...
 

Protected Member Functions

virtual void calcTranformModelData ()=0
 Transform the model data wrt mesh changes. More...
 
void adjustNegativeResistance (dimensionedVector &resist)
 Adjust negative resistance values to be multiplier of max value. More...
 
virtual void calcForce (const volVectorField &U, const volScalarField &rho, const volScalarField &mu, vectorField &force) const =0
 Calculate the porosity force. More...
 
virtual void correct (fvVectorMatrix &UEqn) const =0
 
virtual void correct (fvVectorMatrix &UEqn, const volScalarField &rho, const volScalarField &mu) const =0
 
virtual void correct (const fvVectorMatrix &UEqn, volTensorField &AU) const =0
 
label fieldIndex (const label index) const
 Return label index. More...
 
- 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

word name_
 Porosity name. More...
 
const fvMeshmesh_
 Reference to the mesh database. More...
 
const dictionary dict_
 Dictionary used for model construction. More...
 
dictionary coeffs_
 Model coefficients dictionary. More...
 
bool active_
 Porosity active flag. More...
 
keyType zoneName_
 Name(s) of cell-zone. More...
 
labelList cellZoneIDs_
 Cell zone IDs. More...
 
coordinateSystem coordSys_
 Local co-ordinate system. More...
 

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 Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static int fileModificationSkew
 
static fileCheckTypes fileModificationChecking
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Top level model for porosity models.

Source files

Definition at line 55 of file porosityModel.H.

Constructor & Destructor Documentation

porosityModel ( const word name,
const word modelType,
const fvMesh mesh,
const dictionary dict,
const word cellZoneName = word::null 
)

Constructor.

Definition at line 78 of file porosityModel.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::lookup(), UPstream::master(), word::null, and Foam::reduce().

Here is the call graph for this function:

~porosityModel ( )
virtual

Destructor.

Definition at line 130 of file porosityModel.C.

Referenced by porosityModel::iNew::operator()().

Here is the caller graph for this function:

Member Function Documentation

virtual void calcTranformModelData ( )
protectedpure virtual

Transform the model data wrt mesh changes.

Implemented in DarcyForchheimer, powerLaw, and fixedCoeff.

void adjustNegativeResistance ( dimensionedVector resist)
protected

Adjust negative resistance values to be multiplier of max value.

Definition at line 40 of file porosityModel.C.

References Foam::cmptMax(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::max(), VectorSpace< Vector< Cmpt >, Cmpt, 3 >::nComponents, and dimensioned< Type >::value().

Here is the call graph for this function:

virtual void calcForce ( const volVectorField U,
const volScalarField rho,
const volScalarField mu,
vectorField force 
) const
protectedpure virtual

Calculate the porosity force.

Implemented in DarcyForchheimer, powerLaw, and fixedCoeff.

virtual void correct ( fvVectorMatrix UEqn) const
protectedpure virtual

Implemented in DarcyForchheimer, powerLaw, and fixedCoeff.

virtual void correct ( fvVectorMatrix UEqn,
const volScalarField rho,
const volScalarField mu 
) const
protectedpure virtual

Implemented in DarcyForchheimer, powerLaw, and fixedCoeff.

virtual void correct ( const fvVectorMatrix UEqn,
volTensorField AU 
) const
protectedpure virtual

Implemented in DarcyForchheimer, powerLaw, and fixedCoeff.

Foam::label fieldIndex ( const label  index) const
protected

Return label index.

Definition at line 64 of file porosityModel.C.

TypeName ( "porosityModel"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
porosityModel  ,
mesh  ,
( const word &modelName, const word &name, const fvMesh &mesh, const dictionary &dict, const word &cellZoneName )  ,
(modelName, name, mesh, dict, cellZoneName)   
)

Selection table.

Foam::autoPtr< Foam::porosityModel > New ( const word name,
const fvMesh mesh,
const dictionary dict,
const word cellZoneName = word::null 
)
static
const Foam::word & name ( ) const
inline

Return const access to the porosity model name.

Definition at line 26 of file porosityModelI.H.

References porosityModel::name_.

Referenced by porosityModel::iNew::operator()(), and porosityModelList::read().

Here is the caller graph for this function:

bool active ( ) const
inline

Return const access to the porosity active flag.

Definition at line 32 of file porosityModelI.H.

References porosityModel::active_.

Referenced by porosityModelList::active(), and porosityModel::iNew::operator()().

Here is the caller graph for this function:

const Foam::labelList & cellZoneIDs ( ) const
inline

Return const access to the cell zone IDs.

Definition at line 38 of file porosityModelI.H.

References porosityModel::cellZoneIDs_.

Referenced by forces::calcForcesMoment(), and porosityModel::iNew::operator()().

Here is the caller graph for this function:

void transformModelData ( )
virtual

Transform the model data wrt mesh changes.

Definition at line 136 of file porosityModel.C.

References Foam::constant::physicoChemical::mu, rho, List< T >::size(), U, and Vector< Cmpt >::zero.

Referenced by porosityModel::iNew::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual tmp<vectorField> force ( const volVectorField U,
const volScalarField rho,
const volScalarField mu 
)
virtual

Return the force over the cell zone(s)

Referenced by forces::calcForcesMoment(), and porosityModel::iNew::operator()().

Here is the caller graph for this function:

void addResistance ( fvVectorMatrix UEqn)
virtual

Add resistance.

Definition at line 168 of file porosityModel.C.

References correct.

Referenced by porosityModelList::addResistance(), porosityModel::addResistance(), and porosityModel::iNew::operator()().

Here is the caller graph for this function:

void addResistance ( fvVectorMatrix UEqn,
const volScalarField rho,
const volScalarField mu 
)
virtual

Add resistance.

Definition at line 181 of file porosityModel.C.

References porosityModel::addResistance(), and correct.

Here is the call graph for this function:

void addResistance ( const fvVectorMatrix UEqn,
volTensorField AU,
bool  correctAUprocBC 
)
virtual

Add resistance.

Definition at line 198 of file porosityModel.C.

References correct, and GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions().

Here is the call graph for this function:

bool writeData ( Ostream os) const
virtual

Write.

Implements regIOobject.

Reimplemented in DarcyForchheimer, powerLaw, and fixedCoeff.

Definition at line 222 of file porosityModel.C.

Referenced by porosityModel::iNew::operator()(), and porosityModelList::writeData().

Here is the caller graph for this function:

bool read ( const dictionary dict)
virtual

Read porosity dictionary.

Definition at line 228 of file porosityModel.C.

References dictionary::lookup(), Foam::readBool(), dictionary::subDict(), and Foam::type().

Referenced by porosityModelList::read().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

word name_
protected

Porosity name.

Definition at line 73 of file porosityModel.H.

Referenced by porosityModel::name().

const fvMesh& mesh_
protected

Reference to the mesh database.

Definition at line 76 of file porosityModel.H.

const dictionary dict_
protected

Dictionary used for model construction.

Definition at line 79 of file porosityModel.H.

dictionary coeffs_
protected

Model coefficients dictionary.

Definition at line 82 of file porosityModel.H.

bool active_
protected

Porosity active flag.

Definition at line 85 of file porosityModel.H.

Referenced by porosityModel::active().

keyType zoneName_
protected

Name(s) of cell-zone.

Definition at line 88 of file porosityModel.H.

labelList cellZoneIDs_
protected

Cell zone IDs.

Definition at line 91 of file porosityModel.H.

Referenced by porosityModel::cellZoneIDs().

coordinateSystem coordSys_
protected

Local co-ordinate system.

Definition at line 94 of file porosityModel.H.


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