Generates streamline data by sampling a set of user-specified fields along a particle track, transported by a user-specified velocity field. More...

#include <streamLine.H>

Inheritance diagram for streamLine:

[legend]

Collaboration diagram for streamLine:

[legend]

Public Member Functions
	TypeName ("streamLine")
	Runtime type information.
	streamLine (const word &name, const Time &runTime, const dictionary &dict)
	Construct from name, Time and dictionary.
	streamLine (const streamLine &)=delete
	No copy construct.
void	operator= (const streamLine &)=delete
	No copy assignment.
virtual	~streamLine ()=default
	Destructor.
virtual bool	read (const dictionary &dict)
	Read the function-object dictionary.
virtual void	track ()
	Do the actual tracking to fill the track data.
Public Member Functions inherited from streamLineBase
	TypeName ("streamLineBase")
	Runtime type information.
	streamLineBase (const word &name, const Time &runTime, const dictionary &dict)
	Construct for given objectRegistry and dictionary.
	streamLineBase (const word &name, const Time &runTime, const dictionary &dict, const wordList &fieldNames)
	Construct from name, Time, dictionary and list of fields to sample.
virtual	~streamLineBase ()
	Destructor.
virtual bool	execute ()
	Execute the averaging.
virtual bool	write ()
	Track and write.
virtual void	updateMesh (const mapPolyMesh &)
	Update for changes of mesh.
virtual void	movePoints (const polyMesh &)
	Update for mesh point-motion.
Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	Runtime type information.
	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary.
	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary.
virtual	~fvMeshFunctionObject ()=default
	Destructor.
Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	Runtime type information.
	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary.
	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary.
virtual	~regionFunctionObject ()=default
	Destructor.
template<class ObjectType>
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10).
template<class ObjectType>
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10).
Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components.
virtual	~stateFunctionObject ()=default
	Destructor.
dictionary &	propertyDict ()
	Return access to the property dictionary.
bool	foundProperty (const word &entryName) const
	Return true if the property exists.
void	clearTrigger ()
	Remove the trigger index from the properties.
label	getTrigger () const
	Get the current trigger index.
bool	setTrigger (const label triggeri)
	Set new trigger index.
bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set.
bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set.
template<class Type>
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property.
template<class Type>
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set.
template<class Type>
void	setProperty (const word &entryName, const Type &value)
	Add generic property.
template<class Type>
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object.
template<class Type>
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set.
template<class Type>
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object.
bool	getObjectResultDict (const word &objectName, dictionary &dict) const
template<class Type>
void	setResult (const word &entryName, const Type &value)
	Add result.
template<class Type>
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object.
template<class Type>
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result.
template<class Type>
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object.
template<class Type>
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set.
word	resultType (const word &entryName) const
	Retrieve the result type.
word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result.
wordList	objectResultEntries () const
	Retrieve the result entries.
wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object.
void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream.
void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream.
void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream.
Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time.
virtual	~timeFunctionObject ()=default
	Destructor.
const Time &	time () const
	Return time database.
objectRegistry &	storedObjects ()
	Write access to the output objects ("functionObjectObjects") registered on Time.
const objectRegistry &	storedObjects () const
	Const access to the output objects ("functionObjectObjects") registered on Time.
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.
autoPtr< functionObject >	clone () const
	Return clone.
virtual	~functionObject ()=default
	Destructor.
virtual const word &	type () const =0
	Runtime type information.
const word &	name () const noexcept
	Return the name of this functionObject.
bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix.
bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix.
virtual bool	execute (const label subIndex)
	Execute using the specified subIndex.
virtual bool	end ()
	Called when Time::run() determines that the time-loop exits.
virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true.
virtual bool	filesModified () const
	Did any file get changed during execution?

Additional Inherited Members
Public Types inherited from streamLineBase
enum	trackDirType : char { FORWARD , BACKWARD , BIDIRECTIONAL }
	Enumeration defining the track direction. More...
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.
Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info.
Static Public Attributes inherited from streamLineBase
static const Enum< trackDirType >	trackDirTypeNames
	Names for the trackDir.
Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content.
static bool	postProcess
	Global post-processing mode switch.
static bool	defaultUseNamePrefix
	Global default for useNamePrefix.
static word	outputPrefix
	Directory prefix.
Protected Member Functions inherited from streamLineBase
const word &	sampledSetAxis () const
	The axis of the sampledSet. Creates sampledSet if required.
const sampledSet &	sampledSetPoints () const
	Demand driven construction of the sampledSet.
autoPtr< indirectPrimitivePatch >	wallPatch () const
	Construct patch out of all wall patch faces.
refPtr< interpolation< vector > >	initInterpolations (const label nSeeds, PtrList< interpolation< scalar > > &vsInterp, PtrList< interpolation< vector > > &vvInterp)
	Initialise interpolators and track storage.
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.
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.
void	trimToBox (const treeBoundBox &bb)
	Trim tracks to bounding box.
virtual bool	writeToFile ()
	Write tracks to file.
virtual void	resetFieldNames (const word &newUName, const wordList &newFieldNames)
	Reset the field names.
Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct.
void	operator= (const fvMeshFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used.
template<class ObjectType>
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
const ObjectType *	cfindObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
const ObjectType *	findObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
ObjectType *	findObject (const word &fieldName)
	Return non-const pointer to the object of the given Type, (sub) objectRegistry.
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.
template<class ObjectType>
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry.
template<class ObjectType>
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry.
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.
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.
bool	writeObject (const word &fieldName)
	Write field if present in the (sub) objectRegistry.
bool	clearObject (const word &fieldName)
	Clear field from the (sub) objectRegistry if present.
void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present.
	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct.
void	operator= (const regionFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary.
functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary.
	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct.
void	operator= (const stateFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects".
	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct.
void	operator= (const timeFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name.
Protected Attributes inherited from streamLineBase
autoPtr< sampledSet >	sampledSetPtr_
	Seed set engine.
word	sampledSetAxis_
	Axis of the sampled points to output.
dictionary	dict_
	Input dictionary.
wordList	fields_
	List of fields to sample.
word	UName_
	Field to transport particle with.
word	interpolationScheme_
	Interpolation scheme to use.
trackDirType	trackDir_
	Whether to use +U, -U or both.
label	lifeTime_
	Maximum lifetime (= number of cells) of particle.
scalar	trackLength_
	Track length.
boundBox	bounds_
	Optional trimming of tracks.
word	cloudName_
	Optional specified name of particles.
word	seedSet_
	Type of seed.
wordList	scalarNames_
	Names of scalar fields.
wordList	vectorNames_
	Names of vector fields.
autoPtr< coordSetWriter >	trackWriterPtr_
	File writer for tracks data.
DynamicList< List< point > >	allTracks_
	All tracks. Per track the points it passed through.
List< DynamicList< scalarList > >	allScalars_
	Per scalarField, per track, the sampled values.
List< DynamicList< vectorList > >	allVectors_
	Per vectorField, per track, the sampled values.
Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh.
Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry.
const objectRegistry &	obr_
	Reference to the region objectRegistry.
const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry.
Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database.

Detailed Description

Generates streamline data by sampling a set of user-specified fields along a particle track, transported by a user-specified velocity field.

Operands:

Operand	Type	Location
`input`	-	-
`output` file	-	postProcessing/sets/<FO>/<time>/file
`output` field	-	-

Usage

Minimal example by using system/controlDict.functions:

streamLineFO
{
    // Mandatory entries
    type            streamLine;
    libs            (fieldFunctionObjects);

    // Mandatory entries
    fields          (<field1> ... <fieldN>);
    setFormat       vtk;
    lifeTime        10000;
    seedSampleSet
    {
        type        uniform;
        axis        x;
        start       (-0.0205 0.0001 0.00001);
        end         (-0.0205 0.0005 0.00001);
        nPoints     100;
    }

    // Optional entries
    U               <word>;
    direction       forward;
    cloud           particleTracks;
    bounds          (0.2 -10 -10)(0.22 10 10);
    trackLength     1e-3;
    nSubCycle       1;
    interpolationScheme cellPoint;

    // Deprecated
    // trackForward true;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: streamLine	word	yes	-
`libs`	Library name: fieldFunctionObjects	word	yes	-
`U`	Name of tracking velocity field	word	no	U
`fields`	Names of operand fields to sample	wordList	yes	-
`setFormat`	Type of output data	word	yes	-
`direction`	Direction (enum) to track	word	no	forward
`lifetime`	Maximum number of particle tracking steps	label	yes	-
`cloud`	Cloud name to use for streamlines	word	no	typeName
`seedSampleSet`	Seeding description (see below)	dict	yes	-
`bounds`	Bounding box to trim tracks	vector pair	no	-
`trackLength`	Tracking segment length	scalar	no	VGREAT
`nSubCycle`	Number of tracking steps per cell	label	no	1
`interpolationScheme`	Interp. scheme for sample	word	no	cellPoint

Example types for the seedSampleSet sub-dict:

        uniform | uniform particle seeding
        cloud   | cloud of points
        triSurfaceMeshPointSet | points according to a tri-surface mesh

Options for the setFormat entry:

        csv
        ensight
        gnuplot
        nastran
        raw
        vtk
        xmgr

Options for the direction entry:

        forward
        backward
        bidirectional

The inherited entries are elaborated in:

streamLineBase.H

Note: When specifying the track resolution, the trackLength or nSubCycle option should be used.

Source files

Definition at line 255 of file streamLine.H.

Constructor & Destructor Documentation

◆ streamLine() [1/2]

streamLine	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict )

Construct from name, Time and dictionary.

Definition at line 120 of file streamLine.C.

References dict, streamLineBase::dict_, Foam::name(), read(), runTime, and streamLineBase::streamLineBase().

Referenced by operator=(), and streamLine().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ streamLine() [2/2]

streamLine ( const streamLine & )

delete

No copy construct.

References streamLine().

Here is the call graph for this function:

◆ ~streamLine()

virtual ~streamLine ( )

virtualdefault

Destructor.

References dict.

Member Function Documentation

◆ TypeName()

TypeName ( "streamLine" )

Runtime type information.

References dict, Foam::name(), and runTime.

Here is the call graph for this function:

◆ operator=()

void operator= ( const streamLine & )

delete

No copy assignment.

References streamLine().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read the function-object dictionary.

Reimplemented from streamLineBase.

Definition at line 135 of file streamLine.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, Foam::max(), Foam::nl, streamLineBase::read(), and streamLineBase::trackLength_.

Referenced by streamLine().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ track()

void track ( )

virtual

Do the actual tracking to fill the track data.

Implements streamLineBase.

Definition at line 41 of file streamLine.C.

References streamLineBase::allScalars_, streamLineBase::allTracks_, streamLineBase::allVectors_, streamLineBase::BIDIRECTIONAL, streamLineBase::cloudName_, refPtr< T >::cref(), Foam::endl(), forAll, streamLineBase::FORWARD, streamLineBase::initInterpolations(), streamLineBase::lifeTime_, Log, fvMeshFunctionObject::mesh_, Foam::returnReduce(), streamLineBase::sampledSetPoints(), Foam::sqrt(), td(), streamLineBase::trackDir_, and streamLineBase::trackLength_.

Here is the call graph for this function:

The documentation for this class was generated from the following files:

src/functionObjects/field/streamLine/streamLine.H
src/functionObjects/field/streamLine/streamLine.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ streamLine() [1/2]

◆ streamLine() [2/2]

◆ ~streamLine()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ read()

◆ track()