Top level model for porosity models. More...
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 word & | name () const |
Return const access to the porosity model name. More... | |
bool | active () const |
Return const access to the porosity active flag. More... | |
const labelList & | cellZoneIDs () const |
Return const access to the cell zone IDs. More... | |
const dictionary & | dict () const |
Return dictionary used for model construction. More... | |
virtual void | transformModelData () |
Transform the model data wrt mesh changes. More... | |
virtual tmp< vectorField > | force (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 &) | |
Copy 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... | |
bool | checkIn () |
Add object to registry. More... | |
bool | checkOut () |
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... | |
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... | |
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 up to date (obviously) More... | |
virtual void | rename (const word &newName) |
Rename. More... | |
virtual fileName | filePath () const |
Return complete path + object name if the file exists. More... | |
bool | headerOk () |
Read and check header info. More... | |
Istream & | readStream (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... | |
virtual bool | read () |
Read object. More... | |
virtual label | addWatch (const fileName &) |
Add file watch for fileName on object if not yet watched. Return. More... | |
const labelList & | watchIndices () const |
Return file-monitoring handles. More... | |
labelList & | watchIndices () |
Return file-monitoring handles. 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 | global () const |
Is object same for all processors. 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 &) |
Public Member Functions inherited from IOobject | |
TypeName ("IOobject") | |
Runtime type information. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, 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 ®istry, 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 ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
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< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
virtual | ~IOobject () |
Destructor. More... | |
const Time & | time () const |
Return time. More... | |
const objectRegistry & | db () const |
Return the local objectRegistry. More... | |
const word & | name () const |
Return name. More... | |
const word & | headerClassName () const |
Return name of the class name read from header. More... | |
word & | headerClassName () |
Return name of the class name read from header. More... | |
string & | note () |
Return non-constant access to the optional note. More... | |
const string & | note () 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 |
readOption & | readOpt () |
writeOption | writeOpt () const |
writeOption & | writeOpt () |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
word | modelName (const char *name) const |
Return the name of the object within this model. More... | |
const fileName & | rootPath () const |
const fileName & | caseName () const |
const fileName & | instance () const |
fileName & | instance () |
const fileName & | local () 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 | localPath () const |
Return the path relative to the case. More... | |
fileName | objectPath () const |
Return complete path + object name. More... | |
fileName | localObjectPath () const |
Return complete localPath + object name. More... | |
fileName | localFilePath (const word &typeName) const |
Helper for filePath that searches locally. More... | |
fileName | globalFilePath (const word &typeName) const |
Helper for filePath that searches up if in parallel. More... | |
bool | readHeader (Istream &) |
Read header. More... | |
template<class Type > | |
bool | typeHeaderOk (const bool checkType=true) |
Read header (uses typeFilePath to find file) and check header. 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< IOobject > | info () const |
Return info proxy. More... | |
void | operator= (const IOobject &) |
template<class Name > | |
Foam::word | groupName (Name name, const word &group) |
template<class Name > | |
Foam::word | modelName (Name name, const word &model) |
Static Public Member Functions | |
static autoPtr< porosityModel > | New (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 Name > | |
static word | modelName (Name name, const word &model) |
Return the name of the object within the given model. 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 (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 regIOobject | |
bool | readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName) |
Helper: check readOpt flags and read if necessary. More... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &) |
Set the object state to bad. More... | |
Protected Attributes | |
word | name_ |
Porosity name. More... | |
const fvMesh & | mesh_ |
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 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... | |
porosityModel | ( | const word & | name, |
const word & | modelType, | ||
const fvMesh & | mesh, | ||
const dictionary & | dict, | ||
const word & | cellZoneName = word::null |
||
) |
Constructor.
Definition at line 80 of file porosityModel.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, UPstream::master(), word::null, dictionary::readIfPresent(), and Foam::reduce().
|
virtual |
Destructor.
Definition at line 132 of file porosityModel.C.
Referenced by porosityModel::iNew::operator()().
|
protectedpure virtual |
Transform the model data wrt mesh changes.
Implemented in solidification, powerLawLopesdaCosta, DarcyForchheimer, powerLaw, and fixedCoeff.
|
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< scalar >, scalar, 3 >::nComponents, and dimensioned< Type >::value().
|
protectedpure virtual |
Calculate the porosity force.
Implemented in solidification, powerLawLopesdaCosta, DarcyForchheimer, powerLaw, and fixedCoeff.
|
protectedpure virtual |
Implemented in solidification, powerLawLopesdaCosta, DarcyForchheimer, powerLaw, and fixedCoeff.
|
protectedpure virtual |
Implemented in solidification, powerLawLopesdaCosta, DarcyForchheimer, powerLaw, and fixedCoeff.
|
protectedpure virtual |
Implemented in solidification, powerLawLopesdaCosta, DarcyForchheimer, powerLaw, and fixedCoeff.
|
protected |
Return label index.
Definition at line 66 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.
|
static |
Selector.
Definition at line 31 of file porosityModelNew.C.
References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::lookup(), mesh, Foam::name(), and Foam::nl.
Referenced by explicitPorositySource::explicitPorositySource(), interRegionExplicitPorositySource::initialise(), porosityModel::iNew::operator()(), and porosityModelList::reset().
|
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().
|
inline |
Return const access to the porosity active flag.
Definition at line 32 of file porosityModelI.H.
References porosityModel::active_.
Referenced by porosityModel::iNew::operator()().
|
inline |
Return const access to the cell zone IDs.
Definition at line 44 of file porosityModelI.H.
References porosityModel::cellZoneIDs_.
Referenced by forces::calcForcesMoment(), porosityModel::iNew::operator()(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setCdSigma(), and kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setPorosityCoefficient().
|
inline |
Return dictionary used for model construction.
Definition at line 38 of file porosityModelI.H.
References porosityModel::dict_.
Referenced by porosityModel::iNew::operator()(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setCdSigma(), and kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setPorosityCoefficient().
|
virtual |
Transform the model data wrt mesh changes.
Definition at line 138 of file porosityModel.C.
References Foam::constant::physicoChemical::mu, tmp< T >::ref(), rho, List< T >::size(), U, and Foam::Zero.
Referenced by porosityModel::iNew::operator()().
|
virtual |
Return the force over the cell zone(s)
Referenced by forces::calcForcesMoment(), and porosityModel::iNew::operator()().
|
virtual |
Add resistance.
Definition at line 170 of file porosityModel.C.
References correct.
Referenced by porosityModel::addResistance(), and porosityModel::iNew::operator()().
|
virtual |
Add resistance.
Definition at line 183 of file porosityModel.C.
References porosityModel::addResistance(), and correct.
|
virtual |
Add resistance.
Definition at line 200 of file porosityModel.C.
References correct, and GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions().
|
virtual |
Write.
Implements regIOobject.
Reimplemented in solidification, powerLawLopesdaCosta, DarcyForchheimer, powerLaw, and fixedCoeff.
Definition at line 224 of file porosityModel.C.
Referenced by porosityModel::iNew::operator()().
|
virtual |
Read porosity dictionary.
Definition at line 230 of file porosityModel.C.
References dictionary::lookup(), dictionary::optionalSubDict(), dictionary::readIfPresent(), and Foam::type().
Referenced by porosityModelList::read().
|
protected |
|
protected |
Reference to the mesh database.
Definition at line 76 of file porosityModel.H.
|
protected |
Dictionary used for model construction.
Definition at line 79 of file porosityModel.H.
Referenced by porosityModel::dict().
|
protected |
Model coefficients dictionary.
Definition at line 82 of file porosityModel.H.
|
protected |
Porosity active flag.
Definition at line 85 of file porosityModel.H.
Referenced by porosityModel::active().
|
protected |
Name(s) of cell-zone.
Definition at line 88 of file porosityModel.H.
|
protected |
Cell zone IDs.
Definition at line 91 of file porosityModel.H.
Referenced by porosityModel::cellZoneIDs().
|
protected |
Local co-ordinate system.
Definition at line 94 of file porosityModel.H.