Public Member Functions | List of all members
streamLine Class Reference

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

Public Member Functions

 TypeName ("streamLine")
 Runtime type information. More...
 
 streamLine (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~streamLine ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the set of field averages. More...
 
virtual void read (const dictionary &)
 Read the field average data. More...
 
virtual void execute ()
 Execute the averaging. More...
 
virtual void end ()
 Execute the averaging at the final time-loop, currently does nothing. More...
 
virtual void timeSet ()
 Called when time was set at the end of the Time::operator++. More...
 
virtual void write ()
 Calculate the field average data and write. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &)
 Update for mesh point-motion. More...
 

Detailed Description

This function object 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;
    functionObjectLibs ("libfieldFunctionObjects.so");
    ...
    setFormat       vtk;
    UName           U;
    trackForward    yes;
    fields
    (
        U
        p
    );
    lifeTime        10000;
    trackLength     1e-3;
    nSubCycle       5;
    cloudName       particleTracks;
    seedSampleSet   uniform;
    uniformCoeffs
    {
        type        uniform;
        axis        x;  //distance;
        start       (-0.0205 0.0001 0.00001);
        end         (-0.0205 0.0005 0.00001);
        nPoints     100;
    }
}


Function object usage

Property Description Required Default value
type type name: streamLine yes
setFormat output data type yes
UName tracking velocity field name yes
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 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::OutputFilterFunctionObject Foam::sampledSet Foam::wallBoundedStreamLine
Source files

Definition at line 193 of file streamLine.H.

Constructor & Destructor Documentation

streamLine ( const word name,
const objectRegistry obr,
const dictionary dict,
const bool  loadFromFiles = false 
)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 326 of file streamLine.C.

References Foam::endl(), Foam::nl, Foam::read(), and WarningIn.

Here is the call graph for this function:

~streamLine ( )
virtual

Destructor.

Definition at line 365 of file streamLine.C.

Member Function Documentation

TypeName ( "streamLine"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual

Return name of the set of field averages.

Definition at line 316 of file streamLine.H.

References streamLine::end(), streamLine::execute(), streamLine::movePoints(), streamLine::read(), streamLine::timeSet(), streamLine::updateMesh(), and streamLine::write().

Here is the call graph for this function:

void read ( const dictionary dict)
virtual
void execute ( )
virtual

Execute the averaging.

Definition at line 480 of file streamLine.C.

Referenced by streamLine::name().

Here is the caller graph for this function:

void end ( )
virtual

Execute the averaging at the final time-loop, currently does nothing.

Definition at line 516 of file streamLine.C.

Referenced by streamLine::name().

Here is the caller graph for this function:

void timeSet ( )
virtual

Called when time was set at the end of the Time::operator++.

Definition at line 520 of file streamLine.C.

Referenced by streamLine::name().

Here is the caller graph for this function:

void write ( )
virtual
void updateMesh ( const mapPolyMesh )
virtual

Update for changes of mesh.

Definition at line 757 of file streamLine.C.

References Foam::read().

Referenced by streamLine::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void movePoints ( const polyMesh )
virtual

Update for mesh point-motion.

Definition at line 763 of file streamLine.C.

References Foam::read().

Referenced by streamLine::name().

Here is the call graph for this function:

Here is the caller graph for this function:


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