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

Inheritance diagram for streamLine:

[legend]

Collaboration diagram for streamLine:

[legend]

Public Member Functions
	TypeName ("streamLine")

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

	streamLine (const streamLine &)=delete

void	operator= (const streamLine &)=delete

virtual	~streamLine ()=default

virtual bool	read (const dictionary &)

virtual void	track ()

Public Member Functions inherited from streamLineBase
	TypeName ("streamLineBase")

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

	streamLineBase (const word &name, const Time &runTime, const dictionary &dict, const wordList &fieldNames)

virtual	~streamLineBase ()

virtual bool	execute ()

virtual bool	write ()

virtual void	updateMesh (const mapPolyMesh &)

virtual void	movePoints (const polyMesh &)

Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")

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

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)

virtual	~fvMeshFunctionObject ()=default

Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")

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

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)

virtual	~regionFunctionObject ()=default

template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const

template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)

virtual	~stateFunctionObject ()=default

dictionary &	propertyDict ()

bool	foundProperty (const word &entryName) const

void	clearTrigger ()

label	getTrigger () const

bool	setTrigger (const label triggeri, bool increaseOnly=true)

bool	getDict (const word &entryName, dictionary &dict) const

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
bool	getProperty (const word &entryName, Type &value) const

template<class Type >
void	setProperty (const word &entryName, const Type &value)

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)

template<class Type >
void	setResult (const word &entryName, const Type &value)

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const

word	resultType (const word &entryName) const

word	objectResultType (const word &objectName, const word &entryName) const

wordList	objectResultEntries () const

wordList	objectResultEntries (const word &objectName) const

void	writeResultEntries (Ostream &os) const

void	writeResultEntries (const word &objectName, Ostream &os) const

void	writeAllResultEntries (Ostream &os) const

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)

virtual	~timeFunctionObject ()=default

const Time &	time () const

objectRegistry &	storedObjects ()

const objectRegistry &	storedObjects () const

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)

autoPtr< functionObject >	clone () const

virtual	~functionObject ()=default

virtual const word &	type () const =0

const word &	name () const noexcept

bool	useNamePrefix () const noexcept

bool	useNamePrefix (bool on) noexcept

virtual bool	execute (const label subIndex)

virtual bool	end ()

virtual bool	adjustTimeStep ()

virtual bool	filesModified () const

Additional Inherited Members
Public Types inherited from streamLineBase
enum	trackDirType : char { FORWARD, BACKWARD, BIDIRECTIONAL }

Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)

Public Attributes inherited from functionObject
bool	log

Static Public Attributes inherited from streamLineBase
static const Enum< trackDirType >	trackDirTypeNames

Static Public Attributes inherited from functionObject
static int	debug

static bool	postProcess

static bool	defaultUseNamePrefix

static word	outputPrefix

Protected Member Functions inherited from streamLineBase
const word &	sampledSetAxis () const

const sampledSet &	sampledSetPoints () const

autoPtr< indirectPrimitivePatch >	wallPatch () const

void	initInterpolations (const label nSeeds, label &UIndex, PtrList< volScalarField > &vsFlds, PtrList< interpolation< scalar >> &vsInterp, PtrList< volVectorField > &vvFlds, PtrList< interpolation< vector >> &vvInterp)

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

void	trimToBox (const treeBoundBox &bb, const label tracki, PtrList< DynamicList< point >> &newTracks, PtrList< DynamicList< scalarList >> &newScalars, PtrList< DynamicList< vectorList >> &newVectors) const

void	trimToBox (const treeBoundBox &bb)

virtual bool	writeToFile ()

virtual void	resetFieldNames (const word &newUName, const wordList &newFieldNames)

Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete

void	operator= (const fvMeshFunctionObject &)=delete

Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const

template<class ObjectType >
bool	foundObject (const word &fieldName) const

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

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const

template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)

template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)

bool	writeObject (const word &fieldName)

bool	clearObject (const word &fieldName)

void	clearObjects (const wordList &objNames)

	regionFunctionObject (const regionFunctionObject &)=delete

void	operator= (const regionFunctionObject &)=delete

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const

functionObjects::properties &	stateDict ()

	stateFunctionObject (const stateFunctionObject &)=delete

void	operator= (const stateFunctionObject &)=delete

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)

	timeFunctionObject (const timeFunctionObject &)=delete

void	operator= (const timeFunctionObject &)=delete

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const

Protected Attributes inherited from streamLineBase
autoPtr< sampledSet >	sampledSetPtr_

word	sampledSetAxis_

dictionary	dict_

wordList	fields_

word	UName_

word	interpolationScheme_

trackDirType	trackDir_

label	lifeTime_

scalar	trackLength_

boundBox	bounds_

word	cloudName_

word	seedSet_

wordList	scalarNames_

wordList	vectorNames_

autoPtr< writer< scalar > >	scalarFormatterPtr_

autoPtr< writer< vector > >	vectorFormatterPtr_

DynamicList< List< point > >	allTracks_

List< DynamicList< scalarList > >	allScalars_

List< DynamicList< vectorList > >	allVectors_

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_

Protected Attributes inherited from regionFunctionObject
word	subRegistryName_

const objectRegistry &	obr_

const objectRegistry *	obrPtr_

Protected Attributes inherited from timeFunctionObject
const Time &	time_

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	-	$FOAM_CASE/postProcessing/sets/<FO>/<time>/<file>
`output` field	-	-

Usage

Minimal example by using system/controlDict.functions:

streamLine1
{
    // Mandatory entries (unmodifiable)
    type            streamLine;
    libs            (fieldFunctionObjects);

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

    // Optional entries (runtime modifiable)
    bounds          (0.2 -10 -10)(0.22 10 10);
    trackLength     1e-3;
    nSubCycle       1;
    interpolationScheme cellPoint;

    // Deprecated
    // trackForward true;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
`type`	Type name: streamLine	word	yes	-
`libs`	Library name: fieldFunctionObjects	word	yes	-
`U`	Name of tracking velocity field	word	yes	-
`fields`	Names of operand fields to sample	wordList	yes	-
`setFormat`	Type of output data	word	yes	-
`direction`	Direction to track	vector	yes	-
`lifetime`	Maximum number of particle tracking steps	label	yes	-
`cloud`	Name of cloud	word	yes	-
`seedSampleSet`	Name of seeding method (see below)	word	yes	-
`bounds`	Bounding box to trim tracks	vector	no	invertedBox
`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

Options for the seedSampleSet entry:

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

Options for the setFormat entry:

        csv
        ensight
        gnuplot
        jplot
        nastran
        raw
        vtk
        xmgr

Options for the direction entry:

        bidirectional
        forward
        backward

The inherited entries are elaborated in:

functionObject.H

Usage by the postProcess utility is not available.

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

See also

Foam::functionObject
Foam::functionObjects::fvMeshFunctionObject
Foam::sampledSet
Foam::wallBoundedStreamLine
Foam::streamLineBase
ExtendedCodeGuide::functionObjects::field::streamLine

Source files

Definition at line 268 of file streamLine.H.

Constructor & Destructor Documentation

◆ streamLine() [1/2]

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

Definition at line 134 of file streamLine.C.

References Foam::read().

Here is the call graph for this function:

◆ streamLine() [2/2]

streamLine ( const streamLine & )

delete

◆ ~streamLine()

virtual ~streamLine ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "streamLine" )

◆ operator=()

void operator= ( const streamLine & )

delete

◆ read()

bool read ( const dictionary & dict )

virtual

Reimplemented from streamLineBase.

Definition at line 148 of file streamLine.C.

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

Here is the call graph for this function:

◆ track()

void track ( )

virtual

Implements streamLineBase.

Definition at line 41 of file streamLine.C.

References Cloud::addParticle(), streamLineBase::allScalars_, streamLineBase::allTracks_, streamLineBase::allVectors_, sampledSet::cells(), streamLineBase::cloudName_, Foam::endl(), forAll, streamLineBase::initInterpolations(), streamLineBase::lifeTime_, Log, fvMeshFunctionObject::mesh_, Cloud::move(), Foam::returnReduce(), streamLineBase::sampledSetPoints(), Foam::sqrt(), 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()