Inheritance diagram for streamLineBase:

[legend]

Collaboration diagram for streamLineBase:

[legend]

Public Types
enum	trackDirType : char { FORWARD, BACKWARD, BIDIRECTIONAL }

Public Member Functions
	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	read (const dictionary &)

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

Static Public Attributes
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
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 void	track ()=0

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
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_

Additional Inherited Members
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

Detailed Description

See also: Foam::functionObjects::streamLine Foam::functionObjects::wallBoundedStreamLine

Source files

Definition at line 60 of file streamLineBase.H.

Member Enumeration Documentation

◆ trackDirType

enum trackDirType : char

Enumerator
FORWARD
BACKWARD
BIDIRECTIONAL

Definition at line 69 of file streamLineBase.H.

Constructor & Destructor Documentation

◆ streamLineBase() [1/2]

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

Definition at line 834 of file streamLineBase.C.

◆ streamLineBase() [2/2]

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

Definition at line 847 of file streamLineBase.C.

◆ ~streamLineBase()

~streamLineBase ( )

virtual

Definition at line 862 of file streamLineBase.C.

Member Function Documentation

◆ sampledSetAxis()

const Foam::word & sampledSetAxis ( ) const

protected

Definition at line 59 of file streamLineBase.C.

References streamLineBase::sampledSetAxis_, streamLineBase::sampledSetPoints(), and streamLineBase::sampledSetPtr_.

Here is the call graph for this function:

◆ sampledSetPoints()

const Foam::sampledSet & sampledSetPoints ( ) const

protected

Definition at line 71 of file streamLineBase.C.

References MeshObject< polyMesh, GeometricMeshObject, meshSearchMeshObject >::New(), and sampledSet::New().

Referenced by streamLineBase::sampledSetAxis(), streamLine::track(), and wallBoundedStreamLine::track().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wallPatch()

Foam::autoPtr< Foam::indirectPrimitivePatch > wallPatch ( ) const

protected

Definition at line 91 of file streamLineBase.C.

References forAll, autoPtr::New(), and patches.

Referenced by wallBoundedStreamLine::track().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initInterpolations()

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

protected

Definition at line 135 of file streamLineBase.C.

References Foam::exit(), f(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), forAll, and Foam::nl.

Referenced by streamLine::track(), and wallBoundedStreamLine::track().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storePoint()

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

protected

Definition at line 255 of file streamLineBase.C.

References DynamicList::append(), and forAll.

Here is the call graph for this function:

◆ trimToBox() [1/2]

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