This function object calculates the flux across selections of faces. More...
Public Types | |
enum | modeType { mdFaceZone, mdFaceZoneAndDirection, mdCellZoneAndDirection, mdSurface, mdSurfaceAndDirection } |
Face mode type. More... | |
Public Member Functions | |
TypeName ("fluxSummary") | |
Runtime type information. More... | |
fluxSummary (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
virtual | ~fluxSummary ()=default |
Destructor. More... | |
virtual bool | read (const dictionary &dict) |
Read the field fluxSummary data. More... | |
virtual bool | execute () |
Execute, currently does nothing. More... | |
virtual bool | write () |
Write the fluxSummary. 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... | |
label | getTrigger () const |
Get the current trigger index. More... | |
bool | setTrigger (const label triggeri) |
Set the current 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... | |
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... | |
List< word > | objectResultEntries () const |
Retrieve the result entries. More... | |
List< word > | 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 () |
const objectRegistry & | storedObjects () const |
Public Member Functions inherited from functionObject | |
virtual const word & | type () const =0 |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict)) | |
functionObject (const word &name) | |
Construct from components. More... | |
autoPtr< functionObject > | clone () const |
Return clone. More... | |
virtual | ~functionObject ()=default |
Destructor. More... | |
const word & | name () const |
Return the name of this functionObject. 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... | |
Public Member Functions inherited from writeFile | |
writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true) | |
Construct from objectRegistry, prefix, fileName. More... | |
writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true) | |
writeFile (const writeFile &wf) | |
Construct copy. More... | |
virtual | ~writeFile ()=default |
Destructor. More... | |
virtual OFstream & | file () |
Return access to the file (if only 1) More... | |
virtual bool | writeToFile () const |
Flag to allow writing to file. More... | |
virtual label | charWidth () const |
Return width of character stream output. More... | |
virtual void | writeCommented (Ostream &os, const string &str) const |
Write a commented string to stream. More... | |
virtual void | writeTabbed (Ostream &os, const string &str) const |
Write a tabbed string to stream. More... | |
virtual void | writeHeader (Ostream &os, const string &str) const |
Write a commented header to stream. More... | |
virtual void | writeCurrentTime (Ostream &os) const |
Write the current time to stream. More... | |
virtual void | writeBreak (Ostream &os) const |
Write a break marker to the stream. More... | |
template<class Type > | |
void | writeHeaderValue (Ostream &os, const string &property, const Type &value) const |
Write a (commented) header property and value pair. More... | |
Static Public Attributes | |
static const Enum< modeType > | modeTypeNames_ |
Face mode names. More... | |
Static Public Attributes inherited from functionObject | |
static int | debug |
static bool | postProcess |
Global post-processing mode switch. More... | |
static word | outputPrefix |
Directory prefix. More... | |
Static Public Attributes inherited from writeFile | |
static label | addChars = 8 |
Additional characters for writing. More... | |
Protected Member Functions | |
bool | isSurfaceMode () const |
Check if surface mode instead of zone mode. More... | |
word | checkFlowType (const dimensionSet &fieldDims, const word &fieldName) const |
Check flowType (mass or volume). More... | |
void | initialiseSurface (const word &surfName, DynamicList< word > &names, DynamicList< vector > &dir, DynamicList< boolList > &faceFlip) const |
Initialise for given surface name. More... | |
void | initialiseSurfaceAndDirection (const word &surfName, const vector &refDir, DynamicList< word > &names, DynamicList< vector > &dir, DynamicList< boolList > &faceFlip) const |
Initialise for given surface name and direction. More... | |
void | initialiseFaceZone (const word &faceZoneName, DynamicList< word > &names, DynamicList< vector > &dir, DynamicList< labelList > &faceID, DynamicList< labelList > &facePatchID, DynamicList< boolList > &faceFlip) const |
Initialise face set from face zone. More... | |
void | initialiseFaceZoneAndDirection (const word &faceZoneName, const vector &refDir, DynamicList< word > &names, DynamicList< vector > &dir, DynamicList< labelList > &faceID, DynamicList< labelList > &facePatchID, DynamicList< boolList > &faceFlip) const |
Initialise face set from face zone and direction. More... | |
void | initialiseCellZoneAndDirection (const word &cellZoneName, const vector &refDir, DynamicList< word > &names, DynamicList< vector > &dir, DynamicList< labelList > &faceID, DynamicList< labelList > &facePatchID, DynamicList< boolList > &faceFlip) const |
Initialise face set from cell zone and direction. More... | |
scalar | totalArea (const label idx) const |
Calculate the total area for the surface or derived faceZone. More... | |
bool | update () |
Initialise - after read(), before write() More... | |
virtual void | writeFileHeader (const word &zoneName, const scalar area, const vector &refDir, Ostream &os) const |
Output file header information. More... | |
bool | surfaceModeWrite () |
Specialized write for surfaces. More... | |
fluxSummary (const fluxSummary &)=delete | |
No copy construct. More... | |
void | operator= (const fluxSummary &)=delete |
No copy assignment. 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 |
template<class ObjectType > | |
const ObjectType * | findObject (const word &fieldName) const |
template<class ObjectType > | |
ObjectType * | findObject (const word &fieldName) |
template<class ObjectType > | |
ObjectType * | getObjectPtr (const word &fieldName) const |
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... | |
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 IOdictionary & | stateDict () const |
Return a const reference to the state dictionary. More... | |
IOdictionary & | 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 name, e.g. used to construct local field names. More... | |
Protected Member Functions inherited from writeFile | |
void | initStream (Ostream &os) const |
Initialise the output stream for writing. More... | |
fileName | baseFileDir () const |
Return the base directory for output. More... | |
fileName | baseTimeDir () const |
Return the base directory for the current time value. More... | |
virtual autoPtr< OFstream > | createFile (const word &name, scalar timeValue) const |
Return autoPtr to a new file for a given time. More... | |
virtual autoPtr< OFstream > | createFile (const word &name) const |
Return autoPtr to a new file using the simulation start time. More... | |
virtual void | resetFile (const word &name) |
Reset internal file pointer to new file with new name. More... | |
Omanip< int > | valueWidth (const label offset=0) const |
Return the value width when writing to stream with optional offset. More... | |
void | operator= (const writeFile &)=delete |
No copy assignment. More... | |
Protected Attributes | |
bool | needsUpdate_ |
Track if the surface needs an update. More... | |
modeType | mode_ |
Mode for face determination. More... | |
scalar | scaleFactor_ |
Scale factor. More... | |
word | phiName_ |
Name of flux field, default = phi. More... | |
List< word > | zoneNames_ |
Region (zone/surface) names. More... | |
List< vector > | zoneDirections_ |
Region (zone/surface) directions. More... | |
List< labelList > | faceID_ |
Face IDs. More... | |
List< labelList > | facePatchID_ |
Face patch IDs. More... | |
List< boolList > | faceFlip_ |
Face flip map signs. More... | |
PtrList< OFstream > | filePtrs_ |
Output file per face zone. More... | |
scalar | tolerance_ |
Tolerance applied when matching face normals. 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... | |
Protected Attributes inherited from writeFile | |
const objectRegistry & | fileObr_ |
Reference to the region objectRegistry. More... | |
const fileName | prefix_ |
Prefix. More... | |
word | fileName_ |
Name of file. More... | |
autoPtr< OFstream > | filePtr_ |
File pointer. More... | |
label | writePrecision_ |
Write precision. More... | |
bool | writeToFile_ |
Flag to enable/disable writing to file. More... | |
bool | writtenHeader_ |
Flag to identify whether the header has been written. More... | |
bool | useUserTime_ |
scalar | startTime_ |
Start time value. 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 |
Switch write log to Info. More... | |
This function object calculates the flux across selections of faces.
Output comprises, per set of faces, the fluxes:
fluxSummary1 { type fluxSummary; libs ("libfieldFunctionObjects.so"); ... write yes; log yes; mode cellZoneAndDirection; cellZoneAndDirection ( (porosity (1 0 0)) ); scaleFactor 1.2; }
Where the entries comprise:
Property | Description | Required | Default |
---|---|---|---|
type | Type name: fluxSummary | yes | |
write | Write flux data to file | no | yes |
log | Write flux data to standard output | no | yes |
mode | Mode to generate faces to test | yes | |
scaleFactor | Optional factor to scale result | no | 1 |
tolerance | Tolerance for the reference direction | no | 0.8 |
phi | Surface flux field | no | phi |
The mode is one of:
Output data is written to files of the form <timeDir>/<faceZoneName>.dat
Definition at line 156 of file fluxSummary.H.
enum modeType |
Face mode type.
Enumerator | |
---|---|
mdFaceZone | Face zone. |
mdFaceZoneAndDirection | Face zone with prescribed direction. |
mdCellZoneAndDirection | Cell zone with prescribed direction. |
mdSurface | A functionObject surface. |
mdSurfaceAndDirection | A surface with prescribed direction. |
Definition at line 166 of file fluxSummary.H.
|
protecteddelete |
No copy construct.
fluxSummary | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict | ||
) |
Construct from Time and dictionary.
Definition at line 937 of file fluxSummary.C.
References dict, and Foam::read().
|
virtualdefault |
Destructor.
|
protected |
Check if surface mode instead of zone mode.
Definition at line 76 of file fluxSummary.C.
References fluxSummary::mdSurface, fluxSummary::mdSurfaceAndDirection, and fluxSummary::mode_.
|
protected |
Check flowType (mass or volume).
Return name on success, fatal error on failure.
Definition at line 83 of file fluxSummary.C.
References Foam::abort(), Foam::dimArea, Foam::dimMass, Foam::dimTime, Foam::dimVolume, Foam::FatalError, FatalErrorInFunction, and word::null.
|
protected |
Initialise for given surface name.
Definition at line 113 of file fluxSummary.C.
References List< T >::append(), DynamicList< T, SizeMin >::append(), objectRegistry::cfindObject(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and Foam::Zero.
|
protected |
Initialise for given surface name and direction.
Definition at line 139 of file fluxSummary.C.
References List< T >::append(), DynamicList< T, SizeMin >::append(), objectRegistry::cfindObject(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::mag(), n, Foam::nl, s, and List< T >::setSize().
|
protected |
Initialise face set from face zone.
Definition at line 187 of file fluxSummary.C.
References List< T >::append(), DynamicList< T, SizeMin >::append(), polyPatch::boundaryMesh(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, faceZone::flipMap(), forAll, Foam::nl, polyPatch::start(), polyPatch::whichFace(), and Foam::Zero.
|
protected |
Initialise face set from face zone and direction.
Definition at line 276 of file fluxSummary.C.
References List< T >::append(), DynamicList< T, SizeMin >::append(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), polyPatch::boundaryMesh(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::mag(), n, Foam::nl, polyPatch::start(), polyPatch::whichFace(), and Foam::Zero.
|
protected |
Initialise face set from cell zone and direction.
Definition at line 383 of file fluxSummary.C.
References List< T >::append(), DynamicList< T, SizeMin >::append(), polyPatch::coupled(), Foam::expressions::patchExpr::debug, DebugInfo, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::identity(), Foam::Info, Foam::labelMax, Foam::log(), Foam::mag(), n, Foam::name(), Foam::nl, Foam::foamVersion::patch, Foam::reduce(), Foam::returnReduce(), Foam::search(), polyPatch::start(), syncTools::swapBoundaryFaceList(), Foam::type(), and WarningInFunction.
|
protected |
Calculate the total area for the surface or derived faceZone.
Definition at line 659 of file fluxSummary.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), forAll, Foam::returnReduce(), s, and Foam::sum().
|
protected |
Initialise - after read(), before write()
Definition at line 782 of file fluxSummary.C.
References Foam::endl(), forAll, Foam::Info, Foam::name(), Foam::nl, and Foam::type().
|
protectedvirtual |
Output file header information.
Definition at line 1043 of file fluxSummary.C.
References Foam::fieldTypes::area, Foam::endl(), Foam::tab, and Foam::writeHeader().
|
protected |
Specialized write for surfaces.
Definition at line 699 of file fluxSummary.C.
References Foam::endl(), forAll, Log, Foam::name(), Foam::nl, phi, phis(), Foam::reduce(), s, token::TAB, and Foam::type().
|
protecteddelete |
No copy assignment.
TypeName | ( | "fluxSummary" | ) |
Runtime type information.
|
virtual |
Read the field fluxSummary data.
Reimplemented from writeFile.
Definition at line 963 of file fluxSummary.C.
References Foam::abort(), dict, Foam::endl(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::flatOutput(), Foam::Info, Foam::name(), writeFile::read(), regionFunctionObject::read(), and Foam::type().
|
virtual |
Execute, currently does nothing.
Implements functionObject.
Definition at line 1085 of file fluxSummary.C.
|
virtual |
Write the fluxSummary.
Implements functionObject.
Definition at line 1091 of file fluxSummary.C.
References Foam::endl(), forAll, Log, Foam::name(), Foam::nl, phi, Foam::reduce(), token::TAB, Foam::type(), and update().
|
static |
Face mode names.
Definition at line 176 of file fluxSummary.H.
|
protected |
Track if the surface needs an update.
Definition at line 184 of file fluxSummary.H.
|
protected |
Mode for face determination.
Definition at line 187 of file fluxSummary.H.
Referenced by fluxSummary::isSurfaceMode().
|
protected |
Scale factor.
Definition at line 190 of file fluxSummary.H.
|
protected |
Name of flux field, default = phi.
Definition at line 193 of file fluxSummary.H.
Region (zone/surface) names.
Definition at line 199 of file fluxSummary.H.
Region (zone/surface) directions.
Definition at line 202 of file fluxSummary.H.
Face IDs.
Definition at line 205 of file fluxSummary.H.
Face patch IDs.
Definition at line 208 of file fluxSummary.H.
Face flip map signs.
Definition at line 211 of file fluxSummary.H.
Output file per face zone.
Definition at line 214 of file fluxSummary.H.
|
protected |
Tolerance applied when matching face normals.
Definition at line 218 of file fluxSummary.H.