Go to the documentation of this file.
39 #ifndef streamLineBase_H
40 #define streamLineBase_H
59 namespace functionObjects
203 virtual void track() = 0;
211 const word& newUName,
256 virtual bool write();
Holds list of sampling points which is filled at construction time. Various implementations of this b...
scalar trackLength_
Track length.
trackDirType
Enumeration defining the track direction.
List< DynamicList< scalarList > > allScalars_
Per scalarField, per track, the sampled values.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
A class for handling words, derived from Foam::string.
virtual void track()=0
Do the actual tracking to fill the track data.
virtual ~streamLineBase()
Destructor.
A 1D vector of objects of type <T> that resizes itself as necessary to accept the new objects.
virtual bool write()
Track and write.
Standard boundBox with extra functionality for use in octree.
const sampledSet & sampledSetPoints() const
Demand driven construction of the sampledSet.
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.
autoPtr< writer< scalar > > scalarFormatterPtr_
File writer for scalar data.
autoPtr< indirectPrimitivePatch > wallPatch() const
Construct patch out of all wall patch faces.
boundBox bounds_
Optional trimming of tracks.
virtual void movePoints(const polyMesh &)
Update for mesh point-motion.
Specialization of Foam::functionObject for an Foam::fvMesh, providing a reference to the Foam::fvMesh...
word seedSet_
Type of seed.
Mesh consisting of general polyhedral cells.
virtual bool read(const dictionary &)
Read the field average data.
virtual bool writeToFile()
Write tracks to file.
dictionary dict_
Input dictionary.
autoPtr< sampledSet > sampledSetPtr_
Seed set engine.
virtual void updateMesh(const mapPolyMesh &)
Update for changes of mesh.
wordList fields_
List of fields to sample.
virtual bool execute()
Execute the averaging.
wordList scalarNames_
Names of scalar fields.
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers....
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.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
const wordRes fieldNames(propsDict.getOrDefault< wordRes >("fields", wordRes()))
List< DynamicList< vectorList > > allVectors_
Per vectorField, per track, the sampled values.
wordList vectorNames_
Names of vector fields.
static const Enum< trackDirType > trackDirTypeNames
Names for the trackDir.
trackDirType trackDir_
Whether to use +u or -u or both.
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
const word & name() const noexcept
Return the name of this functionObject.
word cloudName_
Optional specified name of particles.
autoPtr< writer< vector > > vectorFormatterPtr_
File writer for vector data.
word UName_
Field to transport particle with.
word interpolationScheme_
Interpolation scheme to use.
label lifeTime_
Maximum lifetime (= number of cells) of particle.
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.
word sampledSetAxis_
Axis of the sampled points to output.
A bounding box defined in terms of min/max extrema points.
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
streamLineBase(const word &name, const Time &runTime, const dictionary &dict)
Construct for given objectRegistry and dictionary.
TypeName("streamLineBase")
Runtime type information.
DynamicList< List< point > > allTracks_
All tracks. Per track the points it passed through.
virtual void resetFieldNames(const word &newUName, const wordList &newFieldNames)
Reset the field names.
const word & sampledSetAxis() const
The axis of the sampledSet. Creates sampledSet if required.