Calculates and outputs the pressure fields p_rgh and ph_rgh. More...
Public Member Functions | |
TypeName ("hydrostaticPressure") | |
Runtime type information. More... | |
hydrostaticPressure (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
virtual | ~hydrostaticPressure ()=default |
Destructor. More... | |
virtual bool | read (const dictionary &dict) |
Read the hydrostaticPressure data. More... | |
virtual bool | execute () |
Calculate the p_rgh field. More... | |
virtual bool | write () |
Write the p_rgh and derived fields. More... | |
Public Member Functions inherited from fvMeshFunctionObject | |
TypeName ("fvMeshFunctionObject") | |
Runtime type information. More... | |
fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
Construct from the region objectRegistry and dictionary. More... | |
virtual | ~fvMeshFunctionObject ()=default |
Destructor. More... | |
Public Member Functions inherited from regionFunctionObject | |
TypeName ("regionFunctionObject") | |
Runtime type information. More... | |
regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
Construct from the region objectRegistry and dictionary. More... | |
virtual | ~regionFunctionObject ()=default |
Destructor. More... | |
template<class ObjectType > | |
const ObjectType * | lookupObjectPtr (const word &fieldName) const |
Deprecated(2018-10) More... | |
template<class ObjectType > | |
ObjectType * | lookupObjectRefPtr (const word &fieldName) const |
Deprecated(2018-10) More... | |
Public Member Functions inherited from stateFunctionObject | |
stateFunctionObject (const word &name, const Time &runTime) | |
Construct from components. More... | |
virtual | ~stateFunctionObject ()=default |
Destructor. More... | |
dictionary & | propertyDict () |
Return access to the property dictionary. More... | |
bool | foundProperty (const word &entryName) const |
Return true if the property exists. More... | |
void | clearTrigger () |
Remove the trigger index from the properties. More... | |
label | getTrigger () const |
Get the current trigger index. More... | |
bool | setTrigger (const label triggeri) |
Set new trigger index. More... | |
bool | getDict (const word &entryName, dictionary &dict) const |
Set dictionary, return true if set. More... | |
bool | getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const |
Set dictionary from named object, return true if set. More... | |
template<class Type > | |
Type | getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const |
Retrieve generic property. More... | |
template<class Type > | |
bool | getProperty (const word &entryName, Type &value) const |
Set generic property, return true if set. More... | |
template<class Type > | |
void | setProperty (const word &entryName, const Type &value) |
Add generic property. More... | |
template<class Type > | |
Type | getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const |
Retrieve generic property from named object. More... | |
template<class Type > | |
bool | getObjectProperty (const word &objectName, const word &entryName, Type &value) const |
Set generic property from named object, return true if set. More... | |
template<class Type > | |
void | setObjectProperty (const word &objectName, const word &entryName, const Type &value) |
Add generic property from named object. More... | |
bool | getObjectResultDict (const word &objectName, dictionary &dict) const |
template<class Type > | |
void | setResult (const word &entryName, const Type &value) |
Add result. More... | |
template<class Type > | |
void | setObjectResult (const word &objectName, const word &entryName, const Type &value) |
Add result from named object. More... | |
template<class Type > | |
Type | getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const |
Retrieve result. More... | |
template<class Type > | |
Type | getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const |
Retrieve result from named object. More... | |
template<class Type > | |
bool | getObjectResult (const word &objectName, const word &entryName, Type &value) const |
Set result from named object, return true if set. More... | |
word | resultType (const word &entryName) const |
Retrieve the result type. More... | |
word | objectResultType (const word &objectName, const word &entryName) const |
Return the type of result. More... | |
wordList | objectResultEntries () const |
Retrieve the result entries. More... | |
wordList | objectResultEntries (const word &objectName) const |
Return result entries for named object. More... | |
void | writeResultEntries (Ostream &os) const |
Write the results entries for all objects to stream. More... | |
void | writeResultEntries (const word &objectName, Ostream &os) const |
Write the results entries for named object to stream. More... | |
void | writeAllResultEntries (Ostream &os) const |
Write the results entries for all objects to stream. More... | |
Public Member Functions inherited from timeFunctionObject | |
timeFunctionObject (const word &name, const Time &runTime) | |
Construct from Time. More... | |
virtual | ~timeFunctionObject ()=default |
Destructor. More... | |
const Time & | time () const |
Return time database. More... | |
objectRegistry & | storedObjects () |
Write access to the output objects ("functionObjectObjects") registered on Time. More... | |
const objectRegistry & | storedObjects () const |
Const access to the output objects ("functionObjectObjects") registered on Time. More... | |
Public Member Functions inherited from functionObject | |
declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict)) | |
functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix) | |
Construct from components. More... | |
autoPtr< functionObject > | clone () const |
Return clone. More... | |
virtual | ~functionObject ()=default |
Destructor. More... | |
virtual const word & | type () const =0 |
Runtime type information. More... | |
const word & | name () const noexcept |
Return the name of this functionObject. More... | |
bool | useNamePrefix () const noexcept |
Return the flag for adding a scoping name prefix. More... | |
bool | useNamePrefix (bool on) noexcept |
Modify the flag for adding a scoping name prefix. More... | |
virtual bool | execute (const label subIndex) |
Execute using the specified subIndex. More... | |
virtual bool | end () |
Called when Time::run() determines that the time-loop exits. More... | |
virtual bool | adjustTimeStep () |
Called at the end of Time::adjustDeltaT() if adjustTime is true. More... | |
virtual bool | filesModified () const |
Did any file get changed during execution? More... | |
virtual void | updateMesh (const mapPolyMesh &mpm) |
Update for changes of mesh. More... | |
virtual void | movePoints (const polyMesh &mesh) |
Update for changes of mesh. More... | |
Protected Member Functions | |
dimensionedScalar | pRef () const |
Helper function to return the reference pressure. More... | |
void | calculateAndWrite () |
Calculate the fields and write. More... | |
Protected Member Functions inherited from fvMeshFunctionObject | |
fvMeshFunctionObject (const fvMeshFunctionObject &)=delete | |
No copy construct. More... | |
void | operator= (const fvMeshFunctionObject &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from regionFunctionObject | |
virtual const objectRegistry & | obr () const |
The region or sub-region registry being used. More... | |
template<class ObjectType > | |
bool | foundObject (const word &fieldName) const |
Find object (eg, a field) in the (sub) objectRegistry. More... | |
template<class ObjectType > | |
const ObjectType * | cfindObject (const word &fieldName) const |
Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More... | |
template<class ObjectType > | |
const ObjectType * | findObject (const word &fieldName) const |
Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More... | |
template<class ObjectType > | |
ObjectType * | findObject (const word &fieldName) |
Return non-const pointer to the object of the given Type, (sub) objectRegistry. More... | |
template<class ObjectType > | |
ObjectType * | getObjectPtr (const word &fieldName) const |
Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable. More... | |
template<class ObjectType > | |
const ObjectType & | lookupObject (const word &fieldName) const |
Lookup and return object (eg, a field) from the (sub) objectRegistry. More... | |
template<class ObjectType > | |
ObjectType & | lookupObjectRef (const word &fieldName) const |
Lookup and return object (eg, a field) from the (sub) objectRegistry. More... | |
template<class ObjectType > | |
bool | store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false) |
Store the field in the (sub) objectRegistry under the given name. More... | |
template<class ObjectType > | |
bool | storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr) |
Store the field in an optional objectRegistry under the given name. More... | |
bool | writeObject (const word &fieldName) |
Write field if present in the (sub) objectRegistry. More... | |
bool | clearObject (const word &fieldName) |
Clear field from the (sub) objectRegistry if present. More... | |
void | clearObjects (const wordList &objNames) |
Clear fields from the (sub) objectRegistry if present. More... | |
regionFunctionObject (const regionFunctionObject &)=delete | |
No copy construct. More... | |
void | operator= (const regionFunctionObject &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from stateFunctionObject | |
const functionObjects::properties & | stateDict () const |
Return a const reference to the state dictionary. More... | |
functionObjects::properties & | stateDict () |
Return non-const access to the state dictionary. More... | |
stateFunctionObject (const stateFunctionObject &)=delete | |
No copy construct. More... | |
void | operator= (const stateFunctionObject &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from timeFunctionObject | |
void | clearOutputObjects (const wordList &objNames) |
Remove specified items from "functionObjectObjects". More... | |
timeFunctionObject (const timeFunctionObject &)=delete | |
No copy construct. More... | |
void | operator= (const timeFunctionObject &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from functionObject | |
word | scopedName (const word &name) const |
Return a scoped (prefixed) name. More... | |
Protected Attributes | |
word | p_rghName_ |
Name of p - rho*g*h field, default is "p_rgh". More... | |
word | ph_rghName_ |
Name of p_hydrostatic - rho*g*h field, default is "ph_rgh". More... | |
word | pRefName_ |
Name of uniform pressure reference field, default is "pRef". More... | |
scalar | pRefValue_ |
Reference pressure if pRefName is set to "pInf". More... | |
word | rhoName_ |
Name of density field, default is "rho". More... | |
word | UName_ |
Name of velocity field, default is "ph_rgh". More... | |
word | ghName_ |
Name of g*h volume field, default is "gh". More... | |
word | ghfName_ |
Name of g*h surface field, default is "ghf". More... | |
label | nCorrectors_ |
Number of correctors when solving for ph_rgh. More... | |
Protected Attributes inherited from fvMeshFunctionObject | |
const fvMesh & | mesh_ |
Reference to the fvMesh. More... | |
Protected Attributes inherited from regionFunctionObject | |
word | subRegistryName_ |
Name for alternative object registry. More... | |
const objectRegistry & | obr_ |
Reference to the region objectRegistry. More... | |
const objectRegistry * | obrPtr_ |
Pointer to alternative (eg, sub-region) objectRegistry. More... | |
Protected Attributes inherited from timeFunctionObject | |
const Time & | time_ |
Reference to the time database. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from functionObject | |
static autoPtr< functionObject > | New (const word &name, const Time &runTime, const dictionary &dict) |
Select from dictionary, based on its "type" entry. More... | |
Public Attributes inherited from functionObject | |
bool | log |
Flag to write log into Info. More... | |
Static Public Attributes inherited from functionObject | |
static int | debug |
Flag to execute debug content. More... | |
static bool | postProcess |
Global post-processing mode switch. More... | |
static bool | defaultUseNamePrefix |
Global default for useNamePrefix. More... | |
static word | outputPrefix |
Directory prefix. More... | |
Calculates and outputs the pressure fields p_rgh and ph_rgh.
hydrostaticPressure1 { type hydrostaticPressure; libs (initialisationFunctionObjects); ... }
Where the entries comprise:
Property | Description | Required | Default value |
---|---|---|---|
log | Log to standard output | no | yes |
p_rgh | Name of p_rgh field | no | p_rgh |
ph_rgh | Name of ph_rgh field | no | ph_rgh |
pRef | Name of pressure ref field | no | pRef |
pRefValue | Value of pressure ref | when pRef set to pInf | 0 |
rho | Name of density field | no | rho |
U | Name of velocity field | no | U |
gh | Name of gravity*height volume field | no | gh |
ghf | Name of gravity*height surface field | no | ghf |
nCorrectors | Number of correctors when solving ph_rgh | no | 5 |
Definition at line 138 of file hydrostaticPressure.H.
hydrostaticPressure | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict | ||
) |
Construct from Time and dictionary.
Definition at line 158 of file hydrostaticPressure.C.
References IOobjectOption::AUTO_WRITE, dict, IOobjectOption::MUST_READ, Foam::read(), IOobjectOption::REGISTER, runTime, and regIOobject::store().
|
virtualdefault |
Destructor.
|
protected |
Helper function to return the reference pressure.
Returns zero if pRefName = none; otherwise returns the value from the mesh database
Definition at line 52 of file hydrostaticPressure.C.
References Foam::dimPressure, objectRegistry::lookupObject(), fvMeshFunctionObject::mesh_, hydrostaticPressure::pRefName_, hydrostaticPressure::pRefValue_, and Foam::Zero.
|
protected |
Calculate the fields and write.
Definition at line 69 of file hydrostaticPressure.C.
References Foam::constrainPressure(), dictionary::dictName(), Foam::fvc::div(), Foam::endl(), gh, ghf, Foam::Info, Foam::fvc::interpolate(), Foam::fvm::laplacian(), Log, Foam::max(), Foam::min(), IOobject::name(), Foam::nl, p, p_rgh, phig(), fvMatrix< Type >::relax(), rho, rhof(), Foam::fvc::snGrad(), fvMatrix< Type >::solve(), U, and regIOobject::write().
TypeName | ( | "hydrostaticPressure" | ) |
Runtime type information.
|
virtual |
Read the hydrostaticPressure data.
Reimplemented from regionFunctionObject.
Definition at line 207 of file hydrostaticPressure.C.
References dict, and regionFunctionObject::read().
|
virtual |
Calculate the p_rgh field.
Implements functionObject.
Definition at line 233 of file hydrostaticPressure.C.
|
virtual |
Write the p_rgh and derived fields.
Implements functionObject.
Definition at line 239 of file hydrostaticPressure.C.
|
protected |
Name of p - rho*g*h field, default is "p_rgh".
Definition at line 149 of file hydrostaticPressure.H.
|
protected |
Name of p_hydrostatic - rho*g*h field, default is "ph_rgh".
Definition at line 154 of file hydrostaticPressure.H.
|
protected |
Name of uniform pressure reference field, default is "pRef".
Set to "none" to set to zero or pInf to set according to pRefValue
Definition at line 161 of file hydrostaticPressure.H.
Referenced by hydrostaticPressure::pRef().
|
protected |
Reference pressure if pRefName is set to "pInf".
Definition at line 166 of file hydrostaticPressure.H.
Referenced by hydrostaticPressure::pRef().
|
protected |
Name of density field, default is "rho".
Definition at line 171 of file hydrostaticPressure.H.
|
protected |
Name of velocity field, default is "ph_rgh".
Definition at line 176 of file hydrostaticPressure.H.
|
protected |
Name of g*h volume field, default is "gh".
Definition at line 181 of file hydrostaticPressure.H.
|
protected |
Name of g*h surface field, default is "ghf".
Definition at line 186 of file hydrostaticPressure.H.
|
protected |
Number of correctors when solving for ph_rgh.
Definition at line 191 of file hydrostaticPressure.H.