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... | |
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... | |
Static Public Attributes | |
static const Enum< trackDirType > | trackDirTypeNames |
Names for the trackDir. 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... | |
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... | |
refPtr< interpolation< vector > > | initInterpolations (const label nSeeds, PtrList< interpolation< scalar >> &vsInterp, PtrList< interpolation< vector >> &vvInterp) |
Initialise 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... | |
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 | |
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, -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< coordSetWriter > | trackWriterPtr_ |
File writer for tracks 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... | |
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... | |
Definition at line 61 of file streamLineBase.H.
enum trackDirType : char |
Enumeration defining the track direction.
Enumerator | |
---|---|
FORWARD | Use "forward" tracking. |
BACKWARD | Use "backward" tracking. |
BIDIRECTIONAL | Use "bidirectional" tracking. |
Definition at line 72 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 811 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 824 of file streamLineBase.C.
|
virtual |
Destructor.
Definition at line 839 of file streamLineBase.C.
|
protected |
The axis of the sampledSet. Creates sampledSet if required.
Definition at line 60 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 72 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 92 of file streamLineBase.C.
References forAll, autoPtr< T >::New(), patches, and pp().
Referenced by wallBoundedStreamLine::track().
|
protected |
Initialise interpolators and track storage.
Return velocity interpolator: standalone or part of vector interpolators
Definition at line 137 of file streamLineBase.C.
References refPtr< T >::cref(), Foam::exit(), f(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), forAll, Foam::nl, and refPtr< T >::reset().
Referenced by streamLine::track(), and wallBoundedStreamLine::track().
|
protected |
Generate point and values by interpolating from existing values.
Definition at line 256 of file streamLineBase.C.
References DynamicList< T, SizeMin >::emplace_back(), forAll, Foam::lerp(), and DynamicList< T, SizeMin >::push_back().
|
protected |
Trim and possibly split a track.
Definition at line 298 of file streamLineBase.C.
References UList< T >::back(), treeBoundBox::contains(), DynamicList< T, SizeMin >::emplace_back(), treeBoundBox::intersects(), Foam::mag(), and UList< T >::size().
|
protected |
Trim tracks to bounding box.
Definition at line 442 of file streamLineBase.C.
References PtrList< T >::emplace_back(), forAll, DynamicList< T, SizeMin >::setSize(), List< T >::setSize(), UList< T >::size(), and UPtrList< T >::size().
|
protectedpure virtual |
Do the actual tracking to fill the track data.
Implemented in wallBoundedStreamLine, and streamLine.
|
protectedvirtual |
Write tracks to file.
Definition at line 506 of file streamLineBase.C.
References Pstream::broadcast(), mapDistributeBase::distribute(), UPtrList< T >::empty(), Foam::endl(), forAll, forAllConstIters(), HashTable< T, Key, Hash >::insert(), Log, Foam::mag(), UPstream::master(), Foam::mkDir(), n, Foam::name(), Foam::nl, UPstream::nProcs(), outputName(), functionObject::outputPrefix, UPstream::parRun(), points, propsDict(), UPstream::scheduled, PtrList< T >::set(), List< T >::setSize(), UList< T >::size(), List< T >::transfer(), and writer().
Reset the field names.
Definition at line 798 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 845 of file streamLineBase.C.
References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, Foam::name(), coordSetWriter::New(), Foam::nl, regionFunctionObject::read(), setFormat(), and Foam::type().
Referenced by streamLine::read(), and wallBoundedStreamLine::read().
|
virtual |
|
virtual |
Track and write.
Implements functionObject.
Definition at line 946 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 959 of file streamLineBase.C.
References mapPolyMesh::mesh(), and Foam::read().
|
virtual |
Update for mesh point-motion.
Reimplemented from functionObject.
Definition at line 968 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 90 of file streamLineBase.H.
Referenced by streamLineBase::sampledSetAxis().
|
mutableprotected |
Axis of the sampled points to output.
Definition at line 95 of file streamLineBase.H.
Referenced by streamLineBase::sampledSetAxis().
|
protected |
Input dictionary.
Definition at line 100 of file streamLineBase.H.
|
protected |
List of fields to sample.
Definition at line 105 of file streamLineBase.H.
|
protected |
Field to transport particle with.
Definition at line 110 of file streamLineBase.H.
|
protected |
Interpolation scheme to use.
Definition at line 115 of file streamLineBase.H.
|
protected |
Whether to use +U, -U or both.
Definition at line 120 of file streamLineBase.H.
Referenced by streamLine::track(), and wallBoundedStreamLine::track().
|
protected |
Maximum lifetime (= number of cells) of particle.
Definition at line 125 of file streamLineBase.H.
Referenced by streamLine::track(), and wallBoundedStreamLine::track().
|
protected |
Track length.
Definition at line 130 of file streamLineBase.H.
Referenced by streamLine::track(), and wallBoundedStreamLine::track().
|
protected |
Optional trimming of tracks.
Definition at line 135 of file streamLineBase.H.
|
protected |
Optional specified name of particles.
Definition at line 140 of file streamLineBase.H.
Referenced by streamLine::track(), and wallBoundedStreamLine::track().
|
protected |
Type of seed.
Definition at line 145 of file streamLineBase.H.
|
protected |
Names of scalar fields.
Definition at line 150 of file streamLineBase.H.
|
protected |
Names of vector fields.
Definition at line 155 of file streamLineBase.H.
|
mutableprotected |
File writer for tracks data.
Definition at line 163 of file streamLineBase.H.
|
protected |
All tracks. Per track the points it passed through.
Definition at line 171 of file streamLineBase.H.
Referenced by streamLine::track(), and wallBoundedStreamLine::track().
|
protected |
Per scalarField, per track, the sampled values.
Definition at line 176 of file streamLineBase.H.
Referenced by streamLine::track(), and wallBoundedStreamLine::track().
|
protected |
Per vectorField, per track, the sampled values.
Definition at line 181 of file streamLineBase.H.
Referenced by streamLine::track(), and wallBoundedStreamLine::track().