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 streamlines:

[legend]

Collaboration diagram for streamlines:

[legend]

Public Types
enum class	trackDirection { forward , backward , both }
	Track direction enumerations. More...

Public Member Functions
	TypeName ("streamlines")
	Runtime type information. More...

	streamlines (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	streamlines (const streamlines &)=delete
	Disallow default bitwise copy construction. More...

virtual	~streamlines ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read the field average data. More...

virtual wordList	fields () const
	Return the list of fields required. More...

virtual bool	execute ()
	Do nothing. More...

virtual bool	write ()
	Calculate and write the streamlines. More...

virtual void	movePoints (const polyMesh &)
	Update for mesh point-motion. More...

virtual void	topoChange (const polyTopoChangeMap &)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

void	operator= (const streamlines &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	Runtime type information. More...

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	fvMeshFunctionObject (const word &name, const objectRegistry &obr)
	Construct from the region objectRegistry. More...

	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fvMeshFunctionObject ()
	Destructor. More...

const fvMesh &	mesh () const
	Return a reference to the mesh. More...

void	operator= (const fvMeshFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	Runtime type information. More...

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	regionFunctionObject (const word &name, const objectRegistry &obr)
	Construct from the region objectRegistry. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~regionFunctionObject ()
	Destructor. More...

void	operator= (const regionFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from objectRegistryFunctionObject
	TypeName ("objectRegistryFunctionObject")
	Runtime type information. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from an objectRegistry and dictionary. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr)
	Construct from an objectRegistry. More...

	objectRegistryFunctionObject (const objectRegistryFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~objectRegistryFunctionObject ()
	Destructor. More...

void	operator= (const objectRegistryFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from functionObject
	ClassName ("functionObject")

virtual const word &	type () const =0
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const Time &runTime)
	Construct from components. More...

	functionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from dictionary. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. More...

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual scalar	timeToNextAction ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

void	operator= (const functionObject &)=delete
	Disallow default bitwise assignment. More...

Static Public Attributes
static const NamedEnum< trackDirection, 3 >	trackDirectionNames_
	Track direction enumeration names. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &, const dictionary &)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Switch	executeAtStart_
	Switch execute at start time. More...

Protected Member Functions inherited from objectRegistryFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObjects (const wordList &fieldNames)
	Prints a warning message that fieldNames cannot be found. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
ObjectType &	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
ObjectType &	store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the given field in the objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the objectRegistry if present. More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from objectRegistryFunctionObject
const objectRegistry &	obr_
	Reference to the objectRegistry. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. More...

Detailed Description

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

Example of function object specification:

streamlines1
{
    type            streamlines;
    libs            ("libfieldFunctionObjects.so");

    writeControl    writeTime;

    setFormat       vtk;
    U               U;
    direction       both;

    fields
    (
        U
        p
    );

    lifeTime        10000;
    trackLength     1e-3;
    nSubCycle       5;

    seedSampleSet
    {
        type        lineUniform;
        axis        xyz;
        start       (-0.0205 0.0001 0.00001);
        end         (-0.0205 0.0005 0.00001);
        nPoints     100;
    }
}

Usage

Property	Description	Required	Default value
`type`	Type name: streamlines	yes
`setFormat`	Output data type	yes
`U`	Tracking velocity field name	no	U
`direction`	Direction in which to track	yes
`outside`	Track outside of periodic meshes	no	no
`fields`	Fields to sample	yes
`writeTime`	Write the flow time along the streamlines	no	no
`lifetime`	Maximum number of particle tracking steps	yes
`trackLength`	Tracking segment length	no
`nSubCycle`	Number of tracking steps per cell	no
`cloudName`	Cloud name to use	no
`seedSampleSet`	Seeding method (see below)	yes

Where the seedSampleSet type is typically one of

lineUniform	:	uniform particle seeding along a line
sphereRandom	:	random particle seeding within a sphere
boundaryRandom	:	random particle seeding on a number of patches
points	:	a specified set of locations

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

See also: Foam::functionObject Foam::functionObjects::timeControl Foam::sampledSet

Source files

Definition at line 206 of file streamlines.H.

Member Enumeration Documentation

◆ trackDirection

enum trackDirection

strong

Track direction enumerations.

Enumerator
forward
backward
both

Definition at line 215 of file streamlines.H.

Constructor & Destructor Documentation

◆ streamlines() [1/2]

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

Construct from Time and dictionary.

Definition at line 85 of file streamlines.C.

References dict, and streamlines::read().

Here is the call graph for this function:

◆ streamlines() [2/2]

streamlines ( const streamlines & )

delete

Disallow default bitwise copy construction.

◆ ~streamlines()

~streamlines ( )

virtual

Destructor.

Definition at line 102 of file streamlines.C.

Member Function Documentation

◆ TypeName()

TypeName ( "streamlines" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the field average data.

Reimplemented from objectRegistryFunctionObject.

Definition at line 108 of file streamlines.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, Foam::max(), Foam::name(), sampledSet::New(), setWriter::New(), Foam::nl, and Foam::type().

Referenced by streamlines::streamlines().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fields()

Foam::wordList fields ( ) const

virtual

Return the list of fields required.

Implements functionObject.

Definition at line 179 of file streamlines.C.

References List< T >::append().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Do nothing.

Implements functionObject.

Definition at line 188 of file streamlines.C.

◆ write()

bool write ( )

virtual

Calculate and write the streamlines.

Implements functionObject.

Definition at line 194 of file streamlines.C.

References Foam::all, AllTypesParameter, List< T >::append(), cells, ConstructTypeInterpolator, DeclareAllTypes, DeclareTypeInterpolator, DeclareTypeValueSets, polyMesh::defaultRegion, Foam::endl(), fieldNames, Foam::findIndex(), Foam::FOR_ALL_FIELD_TYPES(), forAll, FoundTypeField, Foam::gatherAndFlatten(), GatherAndFlattenAllTypes, Foam::Info, UPstream::master(), Foam::max(), Foam::min(), Foam::mkDir(), Foam::name(), interpolation< Type >::New(), Foam::nl, word::null, Foam::offset(), Foam::order(), writeFile::outputPrefix, UPstream::parRun(), DynamicField< T, SizeInc, SizeMult, SizeDiv >::resize(), ResizeAllTypes, Foam::returnReduce(), Field< Type >::rmap(), RMapAllTypes, s(), SetTypeValueSetPtr, ShuffleUpAllTypes, List< T >::size(), globalIndex::toGlobal(), streamlinesParticle::trackingData::trackForward_, Foam::type(), TypeInterpolatorParameter, and TypeValueSetsParameter.

Here is the call graph for this function:

◆ movePoints()

void movePoints ( const polyMesh & mesh )

virtual

Update for mesh point-motion.

Reimplemented from functionObject.

Definition at line 581 of file streamlines.C.

References mesh.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Reimplemented from functionObject.

Definition at line 591 of file streamlines.C.

References polyTopoChangeMap::mesh().

Here is the call graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Reimplemented from functionObject.

Definition at line 605 of file streamlines.C.

References polyMeshMap::mesh().

Here is the call graph for this function:

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Reimplemented from functionObject.

Definition at line 619 of file streamlines.C.

References polyDistributionMap::mesh().

Here is the call graph for this function:

◆ operator=()

void operator= ( const streamlines & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ trackDirectionNames_

const Foam::NamedEnum< Foam::functionObjects::streamlines::trackDirection, 3 > trackDirectionNames_

static

Initial value:

{
    "forward",
    "backward",
    "both"
}

Track direction enumeration names.

Definition at line 223 of file streamlines.H.

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

src/functionObjects/field/streamlines/streamlines.H
src/functionObjects/field/streamlines/streamlines.C

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ trackDirection

Constructor & Destructor Documentation

◆ streamlines() [1/2]

◆ streamlines() [2/2]

◆ ~streamlines()

Member Function Documentation

◆ TypeName()

◆ read()

◆ fields()

◆ execute()

◆ write()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ operator=()

Member Data Documentation

◆ trackDirectionNames_