Public Types | Public Member Functions | Static Public Attributes | List of all members
streamLine Class Reference

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:
Inheritance graph
[legend]
Collaboration diagram for streamLine:
Collaboration graph
[legend]

Public Types

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

Public Member Functions

 TypeName ("streamLine")
 Runtime type information. More...
 
 streamLine (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
virtual ~streamLine ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read the field average data. More...
 
virtual bool execute ()
 Do nothing. More...
 
virtual bool write ()
 Calculate and write the steamlines. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &)
 Update for mesh point-motion. 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, const dictionary &dict)
 Construct from the region objectRegistry and dictionary. More...
 
virtual ~fvMeshFunctionObject ()
 Destructor. 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, const dictionary &dict)
 Construct from the region objectRegistry and dictionary. More...
 
virtual ~regionFunctionObject ()
 Destructor. More...
 
- Public Member Functions inherited from functionObject
virtual const wordtype () 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)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual bool setTimeStep ()
 Called by Time::setDeltaT(). Allows the function object to override. More...
 
virtual scalar timeToNextWrite ()
 Called by Time::adjustTimeStep(). Allows the function object to. More...
 

Static Public Attributes

static const NamedEnum< trackDirection, 3 > trackDirectionNames_
 Track direction enumeration names. More...
 
- Static Public Attributes inherited from functionObject
static int debug
 
static bool postProcess
 Global post-processing mode switch. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (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...
 
- Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool foundObject (const word &fieldName) const
 Find field in the objectRegistry. 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 >
bool store (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 fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
const Timetime_
 Reference to the Time. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. 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:

streamLine1
{
    type            streamLine;
    libs            ("libfieldFunctionObjects.so");

    writeControl    writeTime;

    setFormat       vtk;
    U               U;
    trackForward    yes;

    fields
    (
        U
        p
    );

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

    seedSampleSet
    {
        type        uniform;
        axis        x;  // distance;
        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: streamLine yes
setFormat Output data type yes
U Tracking velocity field name no U
fields Fields to sample yes
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 yes
seedSampleSet Seeding method (see below) yes

Where seedSampleSet type is typically one of

uniform : uniform particle seeding
cloud : cloud of points
triSurfaceMeshPointSet : points according to a tri-surface mesh
Note
When specifying the track resolution, the trackLength OR nSubCycle option should be used
See also
Foam::functionObject Foam::functionObjects::timeControl Foam::sampledSet Foam::wallBoundedStreamLine
Source files

Definition at line 191 of file streamLine.H.

Member Enumeration Documentation

◆ trackDirection

enum trackDirection
strong

Track direction enumerations.

Enumerator
forward 
backward 
both 

Definition at line 200 of file streamLine.H.

Constructor & Destructor Documentation

◆ streamLine()

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

Construct from Time and dictionary.

Definition at line 303 of file streamLine.C.

References Foam::read().

Here is the call graph for this function:

◆ ~streamLine()

~streamLine ( )
virtual

Destructor.

Definition at line 319 of file streamLine.C.

Member Function Documentation

◆ TypeName()

TypeName ( "streamLine"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

◆ execute()

bool execute ( )
virtual

Do nothing.

Implements functionObject.

Definition at line 426 of file streamLine.C.

◆ write()

bool write ( )
virtual

◆ updateMesh()

void updateMesh ( const mapPolyMesh mpm)
virtual

Update for changes of mesh.

Reimplemented from functionObject.

Definition at line 673 of file streamLine.C.

References mapPolyMesh::mesh(), and Foam::read().

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 682 of file streamLine.C.

References Foam::read().

Here is the call graph for this function:

Member Data Documentation

◆ trackDirectionNames_

const NamedEnum< streamLine::trackDirection, 3 > trackDirectionNames_
static

Track direction enumeration names.

Definition at line 208 of file streamLine.H.

Referenced by NamedEnum< directionType, 3 >::names().


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