Public Types | |
enum | trackDirType : char { FORWARD, BACKWARD, BIDIRECTIONAL } |
Enumeration defining the track direction. More... | |
Public Member Functions | |
TypeName ("streamLineBase") | |
Runtime type information. More... | |
streamLineBase (const word &name, const Time &runTime, const dictionary &dict) | |
Construct for given objectRegistry and dictionary. More... | |
streamLineBase (const word &name, const Time &runTime, const dictionary &dict, const wordList &fieldNames) | |
Construct from Time and dictionary and list of fields to sample. More... | |
virtual | ~streamLineBase () |
Destructor. More... | |
virtual bool | read (const dictionary &) |
Read the field average data. More... | |
virtual bool | execute () |
Execute the averaging. More... | |
virtual bool | write () |
Track and write. More... | |
virtual void | updateMesh (const mapPolyMesh &) |
Update for changes of mesh. More... | |
virtual void | movePoints (const polyMesh &) |
Update for mesh point-motion. More... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
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, bool increaseOnly=true) |
Set the trigger index. Normally only if greater than current. 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... | |
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... | |
![]() | |
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 |
![]() | |
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... | |
Static Public Attributes | |
static const Enum< trackDirType > | trackDirTypeNames |
Names for the trackDir. More... | |
![]() | |
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... | |
Protected Member Functions | |
const word & | sampledSetAxis () const |
The axis of the sampledSet. Creates sampledSet if required. More... | |
const sampledSet & | sampledSetPoints () const |
Demand driven construction of the sampledSet. More... | |
autoPtr< indirectPrimitivePatch > | wallPatch () const |
Construct patch out of all wall patch faces. More... | |
void | initInterpolations (const label nSeeds, label &UIndex, PtrList< volScalarField > &vsFlds, PtrList< interpolation< scalar >> &vsInterp, PtrList< volVectorField > &vvFlds, PtrList< interpolation< vector >> &vvInterp) |
Initialise fields, interpolators and track storage. More... | |
void | storePoint (const label tracki, const scalar w, const label lefti, const label righti, DynamicList< point > &newTrack, DynamicList< List< scalar >> &newScalars, DynamicList< List< vector >> &newVectors) const |
Generate point and values by interpolating from existing values. More... | |
void | trimToBox (const treeBoundBox &bb, const label tracki, PtrList< DynamicList< point >> &newTracks, PtrList< DynamicList< scalarList >> &newScalars, PtrList< DynamicList< vectorList >> &newVectors) const |
Trim and possibly split a track. More... | |
void | trimToBox (const treeBoundBox &bb) |
Trim tracks to bounding box. More... | |
virtual void | track ()=0 |
Do the actual tracking to fill the track data. More... | |
virtual bool | writeToFile () |
Write tracks to file. More... | |
virtual void | resetFieldNames (const word &newUName, const wordList &newFieldNames) |
Reset the field names. More... | |
![]() | |
fvMeshFunctionObject (const fvMeshFunctionObject &)=delete | |
No copy construct. More... | |
void | operator= (const fvMeshFunctionObject &)=delete |
No copy assignment. More... | |
![]() | |
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... | |
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... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
word | scopedName (const word &name) const |
Return a scoped (prefixed) name. More... | |
Protected Attributes | |
autoPtr< sampledSet > | sampledSetPtr_ |
Seed set engine. More... | |
word | sampledSetAxis_ |
Axis of the sampled points to output. More... | |
dictionary | dict_ |
Input dictionary. More... | |
wordList | fields_ |
List of fields to sample. More... | |
word | UName_ |
Field to transport particle with. More... | |
word | interpolationScheme_ |
Interpolation scheme to use. More... | |
trackDirType | trackDir_ |
Whether to use +u or -u or both. More... | |
label | lifeTime_ |
Maximum lifetime (= number of cells) of particle. More... | |
scalar | trackLength_ |
Track length. More... | |
boundBox | bounds_ |
Optional trimming of tracks. More... | |
word | cloudName_ |
Optional specified name of particles. More... | |
word | seedSet_ |
Type of seed. More... | |
wordList | scalarNames_ |
Names of scalar fields. More... | |
wordList | vectorNames_ |
Names of vector fields. More... | |
autoPtr< writer< scalar > > | scalarFormatterPtr_ |
File writer for scalar data. More... | |
autoPtr< writer< vector > > | vectorFormatterPtr_ |
File writer for vector data. More... | |
DynamicList< List< point > > | allTracks_ |
All tracks. Per track the points it passed through. More... | |
List< DynamicList< scalarList > > | allScalars_ |
Per scalarField, per track, the sampled values. More... | |
List< DynamicList< vectorList > > | allVectors_ |
Per vectorField, per track, the sampled values. More... | |
![]() | |
const fvMesh & | mesh_ |
Reference to the fvMesh. More... | |
![]() | |
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... | |
![]() | |
const Time & | time_ |
Reference to the time database. More... | |
Additional Inherited Members | |
![]() | |
static autoPtr< functionObject > | New (const word &name, const Time &runTime, const dictionary &dict) |
Select from dictionary, based on its "type" entry. More... | |
![]() | |
bool | log |
Flag to write log into Info. More... | |
Definition at line 65 of file streamLineBase.H.
enum trackDirType : char |
Enumeration defining the track direction.
Enumerator | |
---|---|
FORWARD | |
BACKWARD | |
BIDIRECTIONAL |
Definition at line 74 of file streamLineBase.H.
streamLineBase | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict | ||
) |
Construct for given objectRegistry and dictionary.
Allow the possibility to load fields from files
Definition at line 841 of file streamLineBase.C.
streamLineBase | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict, | ||
const wordList & | fieldNames | ||
) |
Construct from Time and dictionary and list of fields to sample.
Definition at line 854 of file streamLineBase.C.
|
virtual |
Destructor.
Definition at line 869 of file streamLineBase.C.
|
protected |
The axis of the sampledSet. Creates sampledSet if required.
Definition at line 66 of file streamLineBase.C.
References streamLineBase::sampledSetAxis_, streamLineBase::sampledSetPoints(), and streamLineBase::sampledSetPtr_.
|
protected |
Demand driven construction of the sampledSet.
Also updates sampledSetAxis_
Definition at line 78 of file streamLineBase.C.
References MeshObject< polyMesh, GeometricMeshObject, meshSearchMeshObject >::New(), and sampledSet::New().
Referenced by streamLineBase::sampledSetAxis(), streamLine::track(), and wallBoundedStreamLine::track().
|
protected |
Construct patch out of all wall patch faces.
Definition at line 98 of file streamLineBase.C.
References forAll, autoPtr< T >::New(), and patches.
Referenced by wallBoundedStreamLine::track().
|
protected |
Initialise fields, interpolators and track storage.
Definition at line 142 of file streamLineBase.C.
References Foam::exit(), f(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), forAll, and Foam::nl.
Referenced by streamLine::track(), and wallBoundedStreamLine::track().
|
protected |
Generate point and values by interpolating from existing values.
Definition at line 262 of file streamLineBase.C.
References DynamicList< T, SizeMin >::append(), and forAll.
|
protected |
Trim and possibly split a track.
Definition at line 308 of file streamLineBase.C.
References DynamicList< T, SizeMin >::append(), treeBoundBox::contains(), treeBoundBox::intersects(), Foam::mag(), and DynamicList< T, SizeMin >::shrink().
|
protected |
Trim tracks to bounding box.
Definition at line 463 of file streamLineBase.C.
References PtrList< T >::append(), forAll, List< T >::setSize(), and DynamicList< T, SizeMin >::setSize().
|
protectedpure virtual |
Do the actual tracking to fill the track data.
Implemented in wallBoundedStreamLine, and streamLine.
|
protectedvirtual |
Write tracks to file.
Definition at line 527 of file streamLineBase.C.
References polyMesh::defaultRegion, mapDistributeBase::distribute(), Foam::endl(), forAll, Log, Foam::mag(), UPstream::master(), Foam::mkDir(), n, Foam::name(), fileName::name(), Foam::nl, UPstream::nProcs(), functionObject::outputPrefix, UPstream::parRun(), fileName::path(), points, propsDict(), Pstream::scatter(), UPstream::scheduled, PtrList< T >::set(), List< T >::setSize(), DynamicList< T, SizeMin >::setSize(), DynamicList< T, SizeMin >::transfer(), and Ostream::write().
Reset the field names.
Definition at line 828 of file streamLineBase.C.
TypeName | ( | "streamLineBase" | ) |
Runtime type information.
|
virtual |
Read the field average data.
Reimplemented from regionFunctionObject.
Reimplemented in wallBoundedStreamLine, and streamLine.
Definition at line 875 of file streamLineBase.C.
References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, boundBox::invertedBox, Foam::name(), writer< Type >::New(), Foam::nl, regionFunctionObject::read(), and Foam::type().
Referenced by streamLine::read(), and wallBoundedStreamLine::read().
|
virtual |
|
virtual |
Track and write.
Implements functionObject.
Definition at line 975 of file streamLineBase.C.
References Log, Foam::name(), Foam::nl, and Foam::type().
|
virtual |
Update for changes of mesh.
Reimplemented from functionObject.
Definition at line 988 of file streamLineBase.C.
References mapPolyMesh::mesh(), and Foam::read().
|
virtual |
Update for mesh point-motion.
Reimplemented from functionObject.
Definition at line 997 of file streamLineBase.C.
References Foam::read().
|
static |
Names for the trackDir.
Definition at line 82 of file streamLineBase.H.
|
mutableprotected |
Seed set engine.
Definition at line 88 of file streamLineBase.H.
Referenced by streamLineBase::sampledSetAxis().
|
mutableprotected |
Axis of the sampled points to output.
Definition at line 91 of file streamLineBase.H.
Referenced by streamLineBase::sampledSetAxis().
|
protected |
Input dictionary.
Definition at line 94 of file streamLineBase.H.
|
protected |
List of fields to sample.
Definition at line 97 of file streamLineBase.H.
|
protected |
Field to transport particle with.
Definition at line 100 of file streamLineBase.H.
|
protected |
Interpolation scheme to use.
Definition at line 103 of file streamLineBase.H.
|
protected |
Whether to use +u or -u or both.
Definition at line 106 of file streamLineBase.H.
Referenced by streamLine::track(), and wallBoundedStreamLine::track().
|
protected |
Maximum lifetime (= number of cells) of particle.
Definition at line 109 of file streamLineBase.H.
Referenced by streamLine::track(), and wallBoundedStreamLine::track().
|
protected |
Track length.
Definition at line 112 of file streamLineBase.H.
Referenced by streamLine::track(), and wallBoundedStreamLine::track().
|
protected |
Optional trimming of tracks.
Definition at line 115 of file streamLineBase.H.
|
protected |
Optional specified name of particles.
Definition at line 118 of file streamLineBase.H.
Referenced by streamLine::track(), and wallBoundedStreamLine::track().
|
protected |
Type of seed.
Definition at line 121 of file streamLineBase.H.
|
protected |
Names of scalar fields.
Definition at line 124 of file streamLineBase.H.
|
protected |
Names of vector fields.
Definition at line 127 of file streamLineBase.H.
File writer for scalar data.
Definition at line 133 of file streamLineBase.H.
File writer for vector data.
Definition at line 136 of file streamLineBase.H.
|
protected |
All tracks. Per track the points it passed through.
Definition at line 142 of file streamLineBase.H.
Referenced by streamLine::track(), and wallBoundedStreamLine::track().
|
protected |
Per scalarField, per track, the sampled values.
Definition at line 145 of file streamLineBase.H.
Referenced by streamLine::track(), and wallBoundedStreamLine::track().
|
protected |
Per vectorField, per track, the sampled values.
Definition at line 148 of file streamLineBase.H.
Referenced by streamLine::track(), and wallBoundedStreamLine::track().