#include <streamLineBase.H>

Inheritance diagram for streamLineBase:

[legend]

Collaboration diagram for streamLineBase:

[legend]

Public Types
enum	trackDirType : char { FORWARD , BACKWARD , BIDIRECTIONAL }
	Enumeration defining the track direction. More...

Public Member Functions
	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	read (const dictionary &dict)
	Read the field average data.
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?

Static Public Attributes
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
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 void	track ()=0
	Do the actual tracking to fill the track data.
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
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.

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.
Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info.

Detailed Description

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

Source files

Definition at line 61 of file streamLineBase.H.

Member Enumeration Documentation

◆ trackDirType

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.

Constructor & Destructor Documentation

◆ streamLineBase() [1/2]

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 810 of file streamLineBase.C.

References dict, dict_, fields_, fvMeshFunctionObject::fvMeshFunctionObject(), Foam::name(), and runTime.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ streamLineBase() [2/2]

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

Construct from name, Time, dictionary and list of fields to sample.

Definition at line 823 of file streamLineBase.C.

References dict, dict_, fields_, fvMeshFunctionObject::fvMeshFunctionObject(), Foam::name(), and runTime.

Here is the call graph for this function:

◆ ~streamLineBase()

~streamLineBase ( )

virtual

Destructor.

Definition at line 839 of file streamLineBase.C.

Member Function Documentation

◆ sampledSetAxis()

const Foam::word & sampledSetAxis ( ) const

protected

The axis of the sampledSet. Creates sampledSet if required.

Definition at line 60 of file streamLineBase.C.

References sampledSetAxis_, sampledSetPoints(), and sampledSetPtr_.

Referenced by writeToFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sampledSetPoints()

const Foam::sampledSet & sampledSetPoints ( ) const

protected

Demand driven construction of the sampledSet.

Also updates sampledSetAxis_

Definition at line 72 of file streamLineBase.C.

References dict_, fvMeshFunctionObject::mesh_, MeshObject< polyMesh, GeometricMeshObject, meshSearchMeshObject >::New(), sampledSet::New(), sampledSetAxis_, and sampledSetPtr_.

Referenced by 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

Construct patch out of all wall patch faces.

Definition at line 92 of file streamLineBase.C.

References forAll, Foam::isA(), fvMeshFunctionObject::mesh_, autoPtr< T >::New(), patches, and pp().

Referenced by wallBoundedStreamLine::track().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initInterpolations()

Foam::refPtr< Foam::interpolation< Foam::vector > > initInterpolations	(	const label	nSeeds,
		PtrList< interpolation< scalar > > &	vsInterp,
		PtrList< interpolation< vector > > &	vvInterp )

protected

Initialise interpolators and track storage.

Return velocity interpolator: standalone or part of vector interpolators

Definition at line 136 of file streamLineBase.C.

References allScalars_, allTracks_, allVectors_, refPtr< T >::cref(), Foam::exit(), f(), Foam::FatalError, FatalErrorInFunction, fields_, Foam::flatOutput(), forAll, regionFunctionObject::foundObject(), interpolationScheme_, regionFunctionObject::lookupObject(), fvMeshFunctionObject::mesh_, interpolation< Type >::New(), Foam::nl, refPtr< T >::reset(), scalarNames_, UName_, and vectorNames_.

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

Generate point and values by interpolating from existing values.

Definition at line 255 of file streamLineBase.C.

References allScalars_, allTracks_, allVectors_, DynamicList< T, SizeMin >::emplace_back(), forAll, Foam::lerp(), DynamicList< T, SizeMin >::push_back(), and track().

Referenced by trimToBox().

Here is the call graph for this function:

Here is the caller 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