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 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 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) | |
| Construct from components. More... | |
| autoPtr< functionObject > | clone () const |
| Return clone. More... | |
| virtual | ~functionObject () |
| Destructor. More... | |
| const word & | name () const |
| Return the name of this functionObject. More... | |
| virtual bool | end () |
| Called when Time::run() determines that the time-loop exits. More... | |
| virtual bool | adjustTimeStep () |
| Called at the end of Time::adjustDeltaT() if adjustTime is true. 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... | |
| Static Public Attributes inherited from functionObject | |
| static int | debug |
| static bool | postProcess |
| Global post-processing mode switch. More... | |
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;
libs ("libfieldFunctionObjects.so");
...
setFormat vtk;
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;
}
}
| Property | Description | Required | Default value |
|---|---|---|---|
type | Type name: streamLine | yes | |
setFormat | Output data type | yes | |
U | 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 |
trackLength OR nSubCycle option should be usedDefinition at line 190 of file streamLine.H.
| streamLine | ( | const word & | name, |
| const Time & | runTime, | ||
| const dictionary & | dict | ||
| ) |
Construct from Time and dictionary.
Definition at line 287 of file streamLine.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::read().
|
virtual |
Destructor.
Definition at line 316 of file streamLine.C.
| TypeName | ( | "streamLine" | ) |
Runtime type information.
|
virtual |
Read the field average data.
Reimplemented from functionObject.
Definition at line 322 of file streamLine.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::FatalIOError, FatalIOErrorInFunction, Foam::findIndex(), dictionary::found(), Foam::Info, IOWarningInFunction, dictionary::lookup(), dictionary::lookupOrDefault(), Foam::name(), writer< Type >::New(), sampledSet::New(), Foam::nl, dictionary::readIfPresent(), primitiveMesh::reset(), dictionary::subDict(), and Foam::type().
|
virtual |
|
virtual |
Calculate and write the steamlines.
Implements functionObject.
Definition at line 432 of file streamLine.C.
References polyMesh::defaultRegion, mapDistributeBase::distribute(), Foam::endl(), forAll, Foam::Info, UPstream::master(), Foam::mkDir(), n, Foam::name(), fvMesh::name(), Foam::nl, UPstream::nProcs(), UPstream::parRun(), fileName::path(), Time::path(), UPstream::scheduled, DynamicList< T, SizeInc, SizeMult, SizeDiv >::setSize(), List< T >::setSize(), List< T >::size(), objectRegistry::time(), fvMesh::time(), Time::timeName(), DynamicList< T, SizeInc, SizeMult, SizeDiv >::transfer(), Foam::type(), Ostream::write(), and List< T >::xfer().
|
virtual |
Update for changes of mesh.
Reimplemented from functionObject.
Definition at line 675 of file streamLine.C.
References mapPolyMesh::mesh(), and Foam::read().
|
virtual |
Update for mesh point-motion.
Reimplemented from functionObject.
Definition at line 686 of file streamLine.C.
References Foam::read().
1.8.11