porosityModel Class Referenceabstract

Top level model for porosity models. More...

Inheritance diagram for porosityModel:
[legend]
Collaboration diagram for porosityModel:
[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 ()=default
 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...
 
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)
 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 global () const
 Is object global. More...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. 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 &io, const bool isTimeObject=false)
 
 regIOobject (const regIOobject &rio)
 Copy construct. More...
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 Copy construct with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry, if not already registered. More...
 
bool checkOut ()
 Remove all file watches and remove object from registry. More...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
bool store ()
 
void release (const bool unregister=false)
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
label & eventNo ()
 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 as up-to-date. More...
 
virtual void rename (const word &newName)
 Rename. More...
 
const dictionaryfindMetaData () const noexcept
 Return pointer to meta-data or nullptr. More...
 
dictionarygetMetaData () noexcept
 Get or create meta-data. More...
 
void removeMetaData ()
 Remove meta-data. More...
 
virtual void updateMetaData ()
 Update internal meta-data (eg, prior to writing) More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool valid=true)
 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...
 
virtual label addWatch (const fileName &)
 Add file watch for fileName on object if not yet watched. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 Write using stream options. More...
 
virtual bool write (const bool valid=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &io)
 Copy assignment. More...
 
virtual bool writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
 Write using given format, version and compression. More...
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Declare type-name, virtual type (with debug switch) More...
 
 IOobject (const IOobject &)=default
 Copy construct. More...
 
virtual ~IOobject ()=default
 Destructor. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 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, bool globalObject=false)
 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, bool globalObject=false)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Copy construct, resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Copy construct, resetting name. More...
 
 IOobject (const IOobject &io, readOption, writeOption)
 Copy construct, resetting io options. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
const objectRegistrydb () const noexcept
 Return the local objectRegistry. More...
 
const Timetime () const
 Return Time associated with the objectRegistry. More...
 
const wordname () const noexcept
 Return name. More...
 
const wordheaderClassName () const noexcept
 Return name of the class name read from header. More...
 
wordheaderClassName () noexcept
 Return non-constant access to the class name read from header. More...
 
const stringnote () const noexcept
 Return the optional note. More...
 
stringnote () noexcept
 Return non-constant access to the optional note. More...
 
bool registerObject () const noexcept
 Should object created with this IOobject be registered? More...
 
bool registerObject (bool on) noexcept
 Change registration preference, return previous value. More...
 
bool globalObject () const noexcept
 Is object same for all processors? More...
 
bool globalObject (bool on) noexcept
 Change global-object status, return previous value. More...
 
unsigned labelByteSize () const noexcept
 The sizeof (label) in bytes, possibly read from the header. More...
 
unsigned scalarByteSize () const noexcept
 The sizeof (scalar) in bytes, possibly read from the header. More...
 
bool isHeaderClassName (const word &clsName) const
 Test if headerClassName() equals the given class name. More...
 
template<class Type >
bool isHeaderClassName () const
 Test if headerClassName() equals Type::typeName. More...
 
readOption readOpt () const noexcept
 The read option. More...
 
readOption readOpt (readOption opt) noexcept
 Change the read option, return previous value. More...
 
writeOption writeOpt () const noexcept
 The write option. More...
 
writeOption writeOpt (writeOption opt) noexcept
 Change the write option, return previous value. More...
 
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 noexcept
 
fileNameinstance () noexcept
 
const fileNamelocal () const noexcept
 
fileName path () const
 The complete path. More...
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 The complete path with alternative instance and local. More...
 
fileName objectPath () const
 The complete path + object name. More...
 
fileName objectRelPath () const
 The object path relative to the root. More...
 
fileName localFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches up if in parallel. More...
 
IOstreamOption parseHeader (const dictionary &headerDict)
 
bool readHeader (Istream &is)
 
bool readHeader (dictionary &headerDict, Istream &is)
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 Read header (uses typeFilePath to find file) and check its info. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &os) const
 Write header with current type() More...
 
bool writeHeader (Ostream &os, const word &objectType) const
 Write header with override of type. More...
 
void writeHeader (dictionary &dict, IOstreamOption streamOpt) const
 
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 
bool good () const noexcept
 
bool bad () const noexcept
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &io)
 
readOptionreadOpt () noexcept
 Access to the read option. More...
 
writeOptionwriteOpt () noexcept
 Access to the write option. More...
 
boolregisterObject () noexcept
 Access to the register object option. More...
 
boolglobalObject () noexcept
 Access to the global object option. More...
 
template<>
bool isHeaderClassName () const
 Specialization for void always returns true (no headerClassName check). More...
 
template<class StringType >
Foam::word groupName (StringType base, 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 *p)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 Status of output file banner. More...
 
static bool bannerEnabled (bool on) noexcept
 Enable/disable an output file banner. More...
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class StringType >
static word groupName (StringType base, const word &group)
 Create dot-delimited name.group string. More...
 
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...
 
static word scopedName (const std::string &scope, const word &name)
 Create scope:name or scope_name string. More...
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 Return the IOobject, but also consider an alternative file name. More...
 
static OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
static OstreamwriteDivider (Ostream &os)
 Write the standard file section divider. More...
 
static OstreamwriteEndDivider (Ostream &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 (fvVectorMatrix &UEqn, const volScalarField &rho, const volScalarField &mu) const =0
 
virtual void correct (const fvVectorMatrix &UEqn, volTensorField &AU) const =0
 
const coordinateSystemcsys () const
 Local coordinate system. More...
 
label fieldIndex (const label index) const
 Return label index. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 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...
 
wordRe zoneName_
 Name(s) of cell-zone. More...
 
labelList cellZoneIDs_
 Cell zone IDs. More...
 
autoPtr< coordinateSystemcsysPtr_
 Local coordinate system. More...
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState : char { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 Names for the fileCheckTypes. More...
 
static char scopeSeparator
 Character for scoping object names (':' or '_') More...
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
static float fileModificationSkew
 Time skew (seconds) for file modification checks. More...
 
static int maxFileModificationPolls
 Max number of times to poll for file modification changes. More...
 
- Static Protected Member Functions inherited from IOobject
static void writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
 
static void writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
 
- 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 57 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 
)

Constructor.

Definition at line 71 of file porosityModel.C.

References boundBox::add(), Foam::constant::universal::c, cells, Foam::decrIndent(), dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::incrIndent(), Foam::indent(), Foam::Info, UPstream::master(), Foam::nl, points, dictionary::readIfPresent(), Foam::reduce(), boundBox::reduce(), and boundBox::span().

Here is the call graph for this function:

◆ ~porosityModel()

virtual ~porosityModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ calcTransformModelData()

virtual void calcTransformModelData ( )
protectedpure virtual

Transform the model data wrt mesh changes.

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

◆ adjustNegativeResistance()

void adjustNegativeResistance ( dimensionedVector resist)
protected

Adjust negative resistance values to be multiplier of max value.

Definition at line 43 of file porosityModel.C.

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

Here is the call 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, powerLawLopesdaCosta, DarcyForchheimer, powerLaw, and fixedCoeff.

◆ correct() [1/3]

virtual void correct ( fvVectorMatrix UEqn) const
protectedpure virtual

◆ correct() [2/3]

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

◆ correct() [3/3]

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

◆ csys()

const Foam::coordinateSystem & csys ( ) const
inlineprotected

Local coordinate system.

Definition at line 30 of file porosityModelI.H.

References porosityModel::csysPtr_.

Referenced by DarcyForchheimer::calcTransformModelData().

Here is the caller graph for this function:

◆ fieldIndex()

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

Return label index.

Definition at line 36 of file porosityModelI.H.

◆ 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 34 of file porosityModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, mesh, Foam::name(), and Foam::nl.

Referenced by interRegionExplicitPorositySource::initialise(), 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 44 of file porosityModelI.H.

Referenced by porosityModelList::read().

Here is the caller graph for this function:

◆ active()

bool active ( ) const
inline

Return const access to the porosity active flag.

Definition at line 50 of file porosityModelI.H.

◆ cellZoneIDs()

const Foam::labelList & cellZoneIDs ( ) const
inline

Return const access to the cell zone IDs.

Definition at line 62 of file porosityModelI.H.

Referenced by forces::calcForcesMoment(), forces::initialiseBins(), kEpsilonLopesdaCosta< BasicTurbulenceModel >::setCdSigma(), and kEpsilonLopesdaCosta< BasicTurbulenceModel >::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 56 of file porosityModelI.H.

Referenced by porosityModel::iNew::operator()(), kEpsilonLopesdaCosta< BasicTurbulenceModel >::setCdSigma(), and kEpsilonLopesdaCosta< BasicTurbulenceModel >::setPorosityCoefficient().

Here is the caller graph for this function:

◆ transformModelData()

void transformModelData ( )
virtual

Transform the model data wrt mesh changes.

Definition at line 154 of file porosityModel.C.

◆ force()

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().

Here is the caller graph for this function:

◆ addResistance() [1/3]

void addResistance ( fvVectorMatrix UEqn)
virtual

Add resistance.

Definition at line 186 of file porosityModel.C.

References correct().

Here is the call graph for this function:

◆ addResistance() [2/3]

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

Add resistance.

Definition at line 199 of file porosityModel.C.

References correct(), Foam::constant::physicoChemical::mu, and rho.

Here is the call graph for this function:

◆ addResistance() [3/3]

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

Add resistance.

Definition at line 216 of file porosityModel.C.

References 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, powerLawLopesdaCosta, DarcyForchheimer, powerLaw, and fixedCoeff.

Definition at line 240 of file porosityModel.C.

◆ global()

virtual bool global ( ) const
inlinevirtual

Is object global.

Reimplemented from regIOobject.

Definition at line 273 of file porosityModel.H.

◆ filePath()

virtual fileName filePath ( ) const
inlinevirtual

Return complete path + object name if the file exists.

either in the case/processor or case otherwise null

Reimplemented from regIOobject.

Definition at line 280 of file porosityModel.H.

◆ read() [1/2]

bool read ( const dictionary dict)
virtual

Read porosity dictionary.

Definition at line 246 of file porosityModel.C.

References dict, dictionary::optionalSubDict(), dictionary::readEntry(), dictionary::readIfPresent(), 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

Inherit read from regIOobject.

Definition at line 191 of file regIOobjectRead.C.

Member Data Documentation

◆ name_

word name_
protected

Porosity name.

Definition at line 75 of file porosityModel.H.

◆ mesh_

const fvMesh& mesh_
protected

Reference to the mesh database.

Definition at line 78 of file porosityModel.H.

Referenced by DarcyForchheimer::calcTransformModelData().

◆ dict_

const dictionary dict_
protected

Dictionary used for model construction.

Definition at line 81 of file porosityModel.H.

◆ coeffs_

dictionary coeffs_
protected

Model coefficients dictionary.

Definition at line 84 of file porosityModel.H.

◆ active_

bool active_
protected

Porosity active flag.

Definition at line 87 of file porosityModel.H.

◆ zoneName_

wordRe zoneName_
protected

Name(s) of cell-zone.

Definition at line 90 of file porosityModel.H.

◆ cellZoneIDs_

labelList cellZoneIDs_
protected

Cell zone IDs.

Definition at line 93 of file porosityModel.H.

Referenced by DarcyForchheimer::calcTransformModelData().

◆ csysPtr_

autoPtr<coordinateSystem> csysPtr_
protected

Local coordinate system.

Definition at line 96 of file porosityModel.H.

Referenced by porosityModel::csys().


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