porosityModel Class Referenceabstract

Top level model for porosity models. More...

Inheritance diagram for porosityModel:
Collaboration diagram for porosityModel:

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...
 
const wordzoneName () const
 Return const access to the cell zone name. More...
 
const dictionarydict () const
 Return dictionary used for model construction. More...
 
virtual void transformModelData ()
 Transform the model data wrt mesh changes. More...
 
virtual tmp< vectorFieldforce (const volVectorField &U, const volScalarField &rho, const volScalarField &mu) const
 Return the force over the cell zone(s) More...
 
virtual void addResistance (fvVectorMatrix &UEqn)
 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...
 
virtual bool read ()
 Inherit read from regIOobject. 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 &)
 Copy constructor. More...
 
 regIOobject (const regIOobject &&)
 Move constructor. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Copy constructor, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy constructor with new name, transferring registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Copy constructor with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
virtual bool global () const
 Return true if object is global, i.e. same for all processors. More...
 
virtual bool globalFile () const
 Return true if object is global, i.e. same for all processors. More...
 
const fileNamecaseName () const
 
fileName path () const
 Return complete path. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool registered () const
 Is this object registered with the 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...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool read=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool dependenciesModified () const
 Return true if the object's dependencies have been modified. 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 bool write) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool write=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 Assign to IOobject. More...
 
void operator= (const regIOobject &)=delete
 Disallow default assignment. More...
 
const fileNamecaseName (const bool global) const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
- 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...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
 IOobject (const IOobject &io)=default
 Copy constructor. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. 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...
 
wordheaderClassName ()
 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 bool global) const
 
fileNameinstance () const
 Return the instance directory, constant, system, <time> etc. More...
 
void updateInstance () const
 If the instance is a time directory update to the current time. More...
 
const fileNamelocal () const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName relativePath () const
 Return the path relative to the case directory. More...
 
fileName relativeObjectPath () const
 Return complete relativePath + object name. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read header of local object without type-checking. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. 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)
 
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 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 calcTransformModelData ()=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 (const fvVectorMatrix &UEqn, volTensorField &AU) const =0
 
label fieldIndex (const label index) const
 Return label index. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
 Read header, check readOpt flags and read data if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &)
 Set the object state to bad. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType)
 Read header using typeGlobalFile to find file. 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...
 
word zoneName_
 Name of cellZone. More...
 
coordinateSystem coordSys_
 Local co-ordinate system. More...
 

Additional Inherited Members

- 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...
 
enum  fileCheckTypes { timeStamp , timeStampMaster , inotify , inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
static constexpr const char * foamFile = "FoamFile"
 Keyword for the FoamFile header sub-dictionary. More...
 
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 

Detailed Description

Top level model for porosity models.

Source files

Definition at line 54 of file porosityModel.H.

Constructor & Destructor Documentation

◆ porosityModel()

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

◆ ~porosityModel()

~porosityModel ( )
virtual

Destructor.

Definition at line 124 of file porosityModel.C.

Member Function Documentation

◆ calcTransformModelData()

virtual void calcTransformModelData ( )
protectedpure virtual

Transform the model data wrt mesh changes.

Implemented in solidification, powerLaw, fixedCoeff, DarcyForchheimer, and powerLawLopesdaCosta.

◆ adjustNegativeResistance()

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< Form, Cmpt, Ncmpts >::nComponents, and dimensioned< Type >::value().

Referenced by DarcyForchheimer::DarcyForchheimer(), and fixedCoeff::fixedCoeff().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ calcForce()

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

Calculate the porosity force.

Implemented in solidification, powerLaw, fixedCoeff, DarcyForchheimer, and powerLawLopesdaCosta.

◆ correct() [1/2]

virtual void correct ( fvVectorMatrix UEqn) const
protectedpure virtual

◆ correct() [2/2]

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

◆ fieldIndex()

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

Return label index.

Definition at line 66 of file porosityModel.C.

◆ TypeName()

TypeName ( "porosityModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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.

◆ New()

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

Selector.

Definition at line 30 of file porosityModelNew.C.

References porosityModel::dict(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::lookup(), porosityModel::name(), and Foam::nl.

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ name()

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::New(), and porosityModelList::read().

Here is the caller graph for this function:

◆ zoneName()

const Foam::word & zoneName ( ) const
inline

Return const access to the cell zone name.

Definition at line 38 of file porosityModelI.H.

Referenced by forcesBase::calcForcesMoments(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setCdAv(), and kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setPorosityCoefficient().

Here is the caller graph for this function:

◆ dict()

const Foam::dictionary & dict ( ) const
inline

Return dictionary used for model construction.

Definition at line 32 of file porosityModelI.H.

Referenced by porosityModel::New(), porosityModel::iNew::operator()(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setCdAv(), and kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setPorosityCoefficient().

Here is the caller graph for this function:

◆ transformModelData()

void transformModelData ( )
virtual

Transform the model data wrt mesh changes.

Definition at line 130 of file porosityModel.C.

◆ force()

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

Return the force over the cell zone(s)

Referenced by forcesBase::calcForcesMoments().

Here is the caller graph for this function:

◆ addResistance() [1/2]

void addResistance ( fvVectorMatrix UEqn)
virtual

Add resistance.

Definition at line 158 of file porosityModel.C.

References Foam::MULES::correct().

Here is the call graph for this function:

◆ addResistance() [2/2]

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

Add resistance.

Definition at line 165 of file porosityModel.C.

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

Here is the call graph for this function:

◆ writeData()

bool writeData ( Ostream os) const
virtual

Write.

Implements regIOobject.

Reimplemented in solidification, powerLaw, fixedCoeff, DarcyForchheimer, and powerLawLopesdaCosta.

Definition at line 185 of file porosityModel.C.

◆ read() [1/2]

bool read ( const dictionary dict)
virtual

Read porosity dictionary.

Definition at line 191 of file porosityModel.C.

References dict, dictionary::lookup(), dictionary::optionalSubDict(), and Foam::type().

Referenced by porosityModelList::read().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ read() [2/2]

bool read
virtual

Inherit read from regIOobject.

Reimplemented from regIOobject.

Definition at line 273 of file regIOobjectRead.C.

Member Data Documentation

◆ name_

word name_
protected

Porosity name.

Definition at line 72 of file porosityModel.H.

Referenced by porosityModel::name().

◆ mesh_

const fvMesh& mesh_
protected

Reference to the mesh database.

Definition at line 75 of file porosityModel.H.

Referenced by porosityModel::porosityModel().

◆ dict_

const dictionary dict_
protected

Dictionary used for model construction.

Definition at line 78 of file porosityModel.H.

◆ coeffs_

dictionary coeffs_
protected

Model coefficients dictionary.

Definition at line 81 of file porosityModel.H.

◆ zoneName_

word zoneName_
protected

Name of cellZone.

Definition at line 84 of file porosityModel.H.

Referenced by porosityModel::porosityModel().

◆ coordSys_

coordinateSystem coordSys_
protected

Local co-ordinate system.

Definition at line 87 of file porosityModel.H.


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