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

Base class for area region models. More...

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

Public Member Functions

 TypeName ("regionFaModel")
 
 regionFaModel (const fvPatch &patch, const word &regionType, const word &modelName, const dictionary &dict, bool readFields=true)
 
 regionFaModel (const regionFaModel &)=delete
 
void operator= (const regionFaModel &)=delete
 
virtual ~regionFaModel ()=default
 
const fvMesh & primaryMesh () const
 
const Time & time () const
 
const Switch & active () const
 
const Switch & infoOutput () const
 
const word & modelName () const
 
const faMesh & regionMesh () const
 
faMesh & regionMesh ()
 
const dictionary & coeffs () const
 
const IOdictionary & outputProperties () const
 
IOdictionary & outputProperties ()
 
const dictionary & solution () const
 
label patchID () const
 
const volSurfaceMapping & vsm () const
 
virtual void evolve ()
 
virtual void preEvolveRegion ()
 
virtual void evolveRegion ()
 
virtual void postEvolveRegion ()
 
virtual scalar CourantNumber () const
 
virtual void info ()=0
 
- Public Member Functions inherited from IOdictionary
 IOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 
 IOdictionary (const IOobject &io, const dictionary &dict)
 
 IOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr)
 
 IOdictionary (const IOobject &io, Istream &is)
 
virtual ~IOdictionary ()=default
 
virtual bool global () const
 
virtual fileName filePath () const
 
- Public Member Functions inherited from baseIOdictionary
 TypeName ("dictionary")
 
 baseIOdictionary (const baseIOdictionary &)=default
 
 baseIOdictionary (baseIOdictionary &&)=default
 
virtual ~baseIOdictionary ()=default
 
 baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 
 baseIOdictionary (const IOobject &io, const dictionary &dict)
 
 baseIOdictionary (const IOobject &io, Istream &is)
 
const word & name () const
 
virtual bool readData (Istream &)
 
virtual bool writeData (Ostream &) const
 
void operator= (const baseIOdictionary &rhs)
 
void operator= (const dictionary &rhs)
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 
 regIOobject (const regIOobject &rio)
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 
virtual ~regIOobject ()
 
bool checkIn ()
 
bool checkOut ()
 
virtual void addWatch ()
 
bool ownedByRegistry () const
 
bool store ()
 
void release (const bool unregister=false)
 
label eventNo () const
 
label & eventNo ()
 
bool upToDate (const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 
void setUpToDate ()
 
virtual void rename (const word &newName)
 
const dictionary * findMetaData () const noexcept
 
dictionary & getMetaData () noexcept
 
void removeMetaData ()
 
virtual void updateMetaData ()
 
bool headerOk ()
 
Istream & readStream (const word &, const bool valid=true)
 
void close ()
 
virtual bool read ()
 
virtual label addWatch (const fileName &)
 
const labelList & watchIndices () const
 
labelList & watchIndices ()
 
virtual bool modified () const
 
virtual bool readIfModified ()
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 
virtual bool write (const bool valid=true) const
 
void operator= (const IOobject &io)
 
virtual bool writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 
 IOobject (const IOobject &)=default
 
virtual ~IOobject ()=default
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 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)
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 
 IOobject (const IOobject &io, const word &name)
 
 IOobject (const IOobject &io, readOption, writeOption)
 
autoPtr< IOobject > clone () const
 
autoPtr< IOobject > clone (const objectRegistry &registry) const
 
const objectRegistry & db () const noexcept
 
const Time & time () const
 
const word & name () const noexcept
 
const word & headerClassName () const noexcept
 
word & headerClassName () noexcept
 
const string & note () const noexcept
 
string & note () noexcept
 
bool registerObject () const noexcept
 
bool registerObject (bool on) noexcept
 
bool globalObject () const noexcept
 
bool globalObject (bool on) noexcept
 
unsigned labelByteSize () const noexcept
 
unsigned scalarByteSize () const noexcept
 
bool isHeaderClassName (const word &clsName) const
 
template<class Type >
bool isHeaderClassName () const
 
readOption readOpt () const noexcept
 
readOption readOpt (readOption opt) noexcept
 
writeOption writeOpt () const noexcept
 
writeOption writeOpt (writeOption opt) noexcept
 
word group () const
 
word member () const
 
const fileName & rootPath () const
 
const fileName & caseName () const
 
const fileName & instance () const noexcept
 
fileName & instance () noexcept
 
const fileName & local () const noexcept
 
fileName path () const
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 
fileName objectPath () const
 
fileName objectRelPath () const
 
fileName localFilePath (const word &typeName, const bool search=true) const
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 
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)
 
template<class Type >
void warnNoRereading () const
 
bool writeHeader (Ostream &os) const
 
bool writeHeader (Ostream &os, const word &objectType) const
 
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< IOobject > info () const
 
void operator= (const IOobject &io)
 
readOption & readOpt () noexcept
 
writeOption & writeOpt () noexcept
 
bool & registerObject () noexcept
 
bool & globalObject () noexcept
 
template<>
bool isHeaderClassName () const
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 
 dictionary ()
 
 dictionary (const fileName &name)
 
 dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false)
 
 dictionary (Istream &is)
 
 dictionary (Istream &is, bool keepHeader)
 
 dictionary (const dictionary &parentDict, const dictionary &dict)
 
 dictionary (const dictionary &dict)
 
 dictionary (const dictionary *dict)
 
 dictionary (const dictionary &parentDict, dictionary &&dict)
 
 dictionary (dictionary &&dict)
 
autoPtr< dictionary > clone () const
 
virtual ~dictionary ()
 
const fileName & name () const noexcept
 
fileName & name () noexcept
 
word dictName () const
 
fileName relativeName (const bool caseTag=false) const
 
bool isNullDict () const noexcept
 
const dictionary & parent () const noexcept
 
const dictionary & topDict () const
 
label startLineNumber () const
 
label endLineNumber () const
 
SHA1Digest digest () const
 
tokenList tokens () const
 
bool found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
entry * findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
const entry * findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
const entry * findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
dictionary * findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
const dictionary * findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
const entry & lookupEntry (const word &keyword, enum keyType::option matchOpt) const
 
ITstream & lookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T >
bool readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
 
template<class T >
bool readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T , class Predicate >
bool readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
 
template<class T , class Predicate >
bool readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
bool isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
const dictionary & subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
dictionary & subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
dictionary & subDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
dictionary subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const
 
const dictionary & optionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
wordList toc () const
 
wordList sortedToc () const
 
template<class Compare >
wordList sortedToc (const Compare &comp) const
 
List< keyType > keys (bool patterns=false) const
 
bool substituteKeyword (const word &keyword, bool mergeEntry=false)
 
bool substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
 
entry * add (entry *entryPtr, bool mergeEntry=false)
 
entry * add (const entry &e, bool mergeEntry=false)
 
entry * add (const keyType &k, const word &v, bool overwrite=false)
 
entry * add (const keyType &k, const string &v, bool overwrite=false)
 
entry * add (const keyType &k, const label v, bool overwrite=false)
 
entry * add (const keyType &k, const scalar v, bool overwrite=false)
 
entry * add (const keyType &k, const dictionary &d, bool mergeEntry=false)
 
template<class T >
entry * add (const keyType &k, const T &v, bool overwrite=false)
 
entry * set (entry *entryPtr)
 
entry * set (const entry &e)
 
entry * set (const keyType &k, const dictionary &v)
 
template<class T >
entry * set (const keyType &k, const T &v)
 
bool remove (const word &keyword)
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
 
bool merge (const dictionary &dict)
 
void clear ()
 
void transfer (dictionary &dict)
 
void checkITstream (const ITstream &is, const word &keyword) const
 
bool read (Istream &is)
 
bool read (Istream &is, bool keepHeader)
 
void writeEntry (Ostream &os) const
 
void writeEntry (const keyType &keyword, Ostream &os) const
 
void writeEntries (Ostream &os, const bool extraNewLine=false) const
 
void write (Ostream &os, const bool subDict=true) const
 
const_searcher csearch (const word &keyword, enum keyType::option=keyType::REGEX) const
 
const_searcher search (const word &keyword, enum keyType::option=keyType::REGEX) const
 
searcher search (const word &keyword, enum keyType::option=keyType::REGEX)
 
const_searcher csearchScoped (const word &keyword, enum keyType::option) const
 
const_searcher searchScoped (const word &keyword, enum keyType::option) const
 
searcher searchScoped (const word &keyword, enum keyType::option)
 
const dictionary * cfindScopedDict (const fileName &dictPath) const
 
const dictionary * findScopedDict (const fileName &dictPath) const
 
dictionary * findScopedDict (const fileName &dictPath)
 
dictionary * makeScopedDict (const fileName &dictPath)
 
const_searcher csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
bool foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
const entry * findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const
 
const entry & lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const
 
ITstream & lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
template<class T >
T getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
template<class T >
T getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option=keyType::REGEX) const
 
template<class T >
bool readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX, bool mandatory=true) const
 
template<class T >
bool readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX) const
 
void operator= (const dictionary &rhs)
 
void operator+= (const dictionary &rhs)
 
void operator|= (const dictionary &rhs)
 
void operator<<= (const dictionary &rhs)
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T >
T lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
ITstream & operator[] (const word &keyword) const
 
bool found (const word &keyword, bool recursive, bool patternMatch=true) const
 
entry * lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
 
const entry * lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 
const entry * lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 
const dictionary * subDictPtr (const word &keyword) const
 
dictionary * subDictPtr (const word &keyword)
 
const entry & lookupEntry (const word &keyword, bool recursive, bool patternMatch) const
 
ITstream & lookup (const word &keyword, bool recursive, bool patternMatch=true) const
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
 
template<class T >
bool readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
 
template<class T >
T lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
 
bool getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< bool >(const word&, keyType::option) More...
 
label getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< label >(const word&, keyType::option) More...
 
scalar getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< scalar >(const word&, keyType::option) More...
 
string getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< string >(const word&, keyType::option) More...
 
word getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< word >(const word&, keyType::option) More...
 
fileName getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< fileName >(const word&, keyType::option) More...
 
template<class Compare >
Foam::wordList sortedToc (const Compare &comp) const
 
template<class T >
Foam::entry * add (const keyType &k, const T &v, bool overwrite)
 
template<class T >
Foam::entry * set (const keyType &k, const T &v)
 
- Public Member Functions inherited from ILList
 ILList ()=default
 
 ILList (T *item)
 
 ILList (Istream &is)
 
 ILList (const ILList< LListBase, T > &lst)
 
 ILList (ILList< LListBase, T > &&lst)
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 
template<class INew >
 ILList (Istream &is, const INew &inew)
 
 ~ILList ()
 
bool eraseHead ()
 
bool erase (T *item)
 
void clear ()
 
void transfer (ILList< LListBase, T > &lst)
 
void operator= (const ILList< LListBase, T > &lst)
 
void operator= (ILList< LListBase, T > &&lst)
 

Static Public Attributes

static const word regionFaModelName
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes > fileCheckTypesNames
 
static char scopeSeparator
 
static fileCheckTypes fileModificationChecking
 
static float fileModificationSkew
 
static int maxFileModificationPolls
 
- Static Public Attributes inherited from dictionary
static int writeOptionalEntries
 
static const dictionary null
 
static refPtr< OSstream > reportingOutput
 

Protected Attributes

const fvMesh & primaryMesh_
 
const fvPatch & patch_
 
const Time & time_
 
Switch active_
 
Switch infoOutput_
 
const word modelName_
 
autoPtr< faMesh > regionMeshPtr_
 
dictionary coeffs_
 
autoPtr< IOdictionary > outputPropertiesPtr_
 
autoPtr< volSurfaceMapping > vsmPtr_
 
label patchID_
 
word regionName_
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState : char { GOOD, BAD }
 
enum  readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 
enum  writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 
- Public Types inherited from dictionary
typedef Searcher< true > const_searcher
 
typedef Searcher< false > searcher
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 
- Static Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 
static bool bannerEnabled (bool on) noexcept
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 
template<class StringType >
static word groupName (StringType base, const word &group)
 
static word group (const word &name)
 
static word member (const word &name)
 
static word scopedName (const std::string &scope, const word &name)
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 
static Ostream & writeBanner (Ostream &os, const bool noSyntaxHint=false)
 
static Ostream & writeDivider (Ostream &os)
 
static Ostream & writeEndDivider (Ostream &os)
 
- Static Public Member Functions inherited from dictionary
static int reportOptional () noexcept
 
static int reportOptional (const int level) noexcept
 
static autoPtr< dictionary > New (Istream &is)
 
- Public Attributes inherited from dictionary
friend const_searcher
 
friend searcher
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 
- 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
 

Detailed Description

Base class for area region models.

Usage
Example of the model specification: 
<patchName>
{
    // Mandatory entries (runtime modifiable)
    region          <regionName>;
    active          true;

    // Optional entries (runtime modifiable)
    infoOutput      false;
    <model>Coeffs
    {
        // subdictionary entries
    }

    // Mandatory/Optional (derived) entries
    ...
}

where the entries mean:

Property Description Type Reqd Dflt
region Name of operand region word yes -
active Flag to activate the model bool yes -
infoOutput Flag to activate information output bool no false
Source files

Definition at line 109 of file regionFaModel.H.

Constructor & Destructor Documentation

◆ regionFaModel() [1/2]

regionFaModel ( const fvPatch &  patch,
const word &  regionType,
const word &  modelName,
const dictionary &  dict,
bool  readFields = true 
)

Definition at line 112 of file regionFaModel.C.

References dict, init(), and Foam::readFields().

Here is the call graph for this function:

◆ regionFaModel() [2/2]

regionFaModel ( const regionFaModel &  )
delete

◆ ~regionFaModel()

virtual ~regionFaModel ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "regionFaModel"  )

◆ operator=()

void operator= ( const regionFaModel &  )
delete

◆ primaryMesh()

const Foam::fvMesh & primaryMesh ( ) const
inline

Definition at line 26 of file regionFaModelI.H.

References regionFaModel::primaryMesh_.

Referenced by liquidFilmBase::alpha(), thermalShell::Cp(), filmTurbulenceModel::Cw(), filmTurbulenceModel::devRhoReff(), injectionModelList::info(), thermalShell::kappa(), liquidFilmBase::pg(), liquidFilmBase::postEvolveRegion(), liquidFilmModel::preEvolveRegion(), filmTurbulenceModel::rho(), thermalShell::rho(), KirchhoffShell::rho(), KirchhoffShell::solveDisplacement(), liquidFilmBase::Up(), liquidFilmBase::Us(), and liquidFilmBase::Uw().

Here is the caller graph for this function:

◆ time()

const Foam::Time & time ( ) const
inline

Definition at line 32 of file regionFaModelI.H.

Referenced by liquidFilmBase::alpha(), liquidFilmBase::CourantNumber(), thermalShell::Cp(), thermalShell::kappa(), liquidFilmBase::pg(), liquidFilmBase::postEvolveRegion(), thermalShell::rho(), KirchhoffShell::rho(), KirchhoffShell::solveDisplacement(), liquidFilmBase::Up(), liquidFilmBase::Us(), liquidFilmBase::Uw(), and filmSubModelBase::writeTime().

Here is the caller graph for this function:

◆ active()

const Foam::Switch & active ( ) const
inline

Definition at line 38 of file regionFaModelI.H.

Referenced by SurfaceFilmModel< CloudType >::inject().

Here is the caller graph for this function:

◆ infoOutput()

const Foam::Switch & infoOutput ( ) const
inline

Definition at line 44 of file regionFaModelI.H.

◆ modelName()

const Foam::word & modelName ( ) const
inline

Definition at line 50 of file regionFaModelI.H.

◆ regionMesh() [1/2]

Foam::faMesh & regionMesh ( ) const
inline

Definition at line 56 of file regionFaModelI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Referenced by liquidFilmBase::alpha(), contactAngleForce::correct(), curvatureSeparation::correct(), liquidFilmModel::correctThermoFields(), liquidFilmBase::CourantNumber(), thermalShell::Cp(), filmTurbulenceModel::Cw(), kinematicThinFilm::evolveRegion(), liquidFilmModel::info(), thermalShell::kappa(), liquidFilmBase::pg(), liquidFilmModel::postEvolveRegion(), liquidFilmModel::preEvolveRegion(), thermalShell::rho(), KirchhoffShell::rho(), liquidFilmBase::Up(), liquidFilmBase::Us(), and liquidFilmBase::Uw().

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

◆ regionMesh() [2/2]

faMesh& regionMesh ( )
inline

◆ coeffs()

const Foam::dictionary & coeffs ( ) const
inline

Definition at line 92 of file regionFaModelI.H.

◆ outputProperties() [1/2]

Foam::IOdictionary & outputProperties ( ) const
inline

Definition at line 98 of file regionFaModelI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ outputProperties() [2/2]

IOdictionary& outputProperties ( )
inline

◆ solution()

const Foam::dictionary & solution ( ) const
inline

Definition at line 125 of file regionFaModelI.H.

Referenced by thermalShell::evolveRegion(), and KirchhoffShell::evolveRegion().

Here is the caller graph for this function:

◆ patchID()

Foam::label patchID ( ) const
inline

Definition at line 131 of file regionFaModelI.H.

Referenced by injectionModelList::correct(), injectionModelList::info(), liquidFilmModel::info(), SurfaceFilmModel< CloudType >::inject(), and liquidFilmModel::preEvolveRegion().

Here is the caller graph for this function:

◆ vsm()

const Foam::volSurfaceMapping & vsm ( ) const

Definition at line 103 of file regionFaModel.C.

Referenced by ThermoSurfaceFilm< CloudType >::cacheFilmFields(), and liquidFilmModel::preEvolveRegion().

Here is the caller graph for this function:

◆ evolve()

void evolve ( )
virtual

Definition at line 156 of file regionFaModel.C.

References Foam::decrIndent(), Foam::endl(), Foam::incrIndent(), and Foam::Info.

Here is the call graph for this function:

◆ preEvolveRegion()

void preEvolveRegion ( )
virtual

Reimplemented in liquidFilmBase, vibrationShellModel, KirchhoffShell, liquidFilmModel, thermalShellModel, thermalShell, and kinematicThinFilm.

Definition at line 180 of file regionFaModel.C.

Referenced by liquidFilmBase::preEvolveRegion().

Here is the caller graph for this function:

◆ evolveRegion()

void evolveRegion ( )
virtual

Reimplemented in KirchhoffShell, thermalShell, and kinematicThinFilm.

Definition at line 184 of file regionFaModel.C.

◆ postEvolveRegion()

void postEvolveRegion ( )
virtual

Reimplemented in liquidFilmBase, liquidFilmModel, and kinematicThinFilm.

Definition at line 188 of file regionFaModel.C.

Referenced by liquidFilmBase::postEvolveRegion().

Here is the caller graph for this function:

◆ CourantNumber()

Foam::scalar CourantNumber ( ) const
virtual

Reimplemented in liquidFilmBase.

Definition at line 192 of file regionFaModel.C.

◆ info()

virtual void info ( )
pure virtual

Implemented in KirchhoffShell, liquidFilmModel, and thermalShell.

Member Data Documentation

◆ primaryMesh_

const fvMesh& primaryMesh_
protected

Definition at line 130 of file regionFaModel.H.

Referenced by regionFaModel::primaryMesh().

◆ patch_

const fvPatch& patch_
protected

Definition at line 133 of file regionFaModel.H.

Referenced by liquidFilmBase::Up(), and liquidFilmBase::Uw().

◆ time_

const Time& time_
protected

Definition at line 136 of file regionFaModel.H.

◆ active_

Switch active_
protected

Definition at line 139 of file regionFaModel.H.

◆ infoOutput_

Switch infoOutput_
protected

Definition at line 142 of file regionFaModel.H.

◆ modelName_

const word modelName_
protected

Definition at line 145 of file regionFaModel.H.

◆ regionMeshPtr_

autoPtr<faMesh> regionMeshPtr_
protected

Definition at line 148 of file regionFaModel.H.

◆ coeffs_

dictionary coeffs_
protected

Definition at line 151 of file regionFaModel.H.

◆ outputPropertiesPtr_

autoPtr<IOdictionary> outputPropertiesPtr_
protected

Definition at line 154 of file regionFaModel.H.

◆ vsmPtr_

autoPtr<volSurfaceMapping> vsmPtr_
protected

Definition at line 157 of file regionFaModel.H.

Referenced by liquidFilmBase::pg(), liquidFilmBase::Up(), and liquidFilmBase::Uw().

◆ patchID_

label patchID_
protected

Definition at line 163 of file regionFaModel.H.

◆ regionName_

word regionName_
protected

Definition at line 167 of file regionFaModel.H.

◆ regionFaModelName

const Foam::word regionFaModelName
static

Definition at line 177 of file regionFaModel.H.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17