Generates streamline data by sampling a set of user-specified fields along a particle track, transported by a user-specified velocity field. More...
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, const dictionary &dict) | |
Construct from the region objectRegistry and dictionary. More... | |
fvMeshFunctionObject (const fvMeshFunctionObject &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~fvMeshFunctionObject () |
Destructor. 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, const dictionary &dict) | |
Construct from the region objectRegistry and dictionary. 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 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... | |
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 write log to Info. More... | |
Protected Member Functions inherited from fvMeshFunctionObject | |
labelHashSet | patchSet (const dictionary &, const bool optional=false) const |
Return the patch set corresponding to the patch selection entries. 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 > | |
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 > | |
bool | store (const tmp< ObjectType > &tfield) |
Store the given field in the objectRegistry. More... | |
template<class ObjectType > | |
bool | 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 regionFunctionObject | |
const objectRegistry & | obr_ |
Reference to the region objectRegistry. More... | |
Protected Attributes inherited from functionObject | |
const Time & | time_ |
Reference to time. More... | |
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; } }
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
Definition at line 213 of file streamlines.H.
|
strong |
Track direction enumerations.
Enumerator | |
---|---|
forward | |
backward | |
both |
Definition at line 222 of file streamlines.H.
streamlines | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict | ||
) |
Construct from Time and dictionary.
Definition at line 89 of file streamlines.C.
References streamlines::read().
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Destructor.
Definition at line 106 of file streamlines.C.
TypeName | ( | "streamlines" | ) |
Runtime type information.
|
virtual |
Read the field average data.
Reimplemented from regionFunctionObject.
Definition at line 112 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().
|
virtual |
Return the list of fields required.
Implements functionObject.
Definition at line 190 of file streamlines.C.
References List< T >::append().
|
virtual |
|
virtual |
Calculate and write the streamlines.
Implements functionObject.
Definition at line 205 of file streamlines.C.
References 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.
|
virtual |
Update for mesh point-motion.
Reimplemented from functionObject.
Definition at line 590 of file streamlines.C.
References Foam::read().
|
virtual |
Update topology using the given map.
Reimplemented from functionObject.
Definition at line 600 of file streamlines.C.
References polyTopoChangeMap::mesh(), and Foam::read().
|
virtual |
Update from another mesh using the given map.
Reimplemented from functionObject.
Definition at line 612 of file streamlines.C.
References polyMeshMap::mesh(), and Foam::read().
|
virtual |
Redistribute or update using the given distribution map.
Reimplemented from functionObject.
Definition at line 624 of file streamlines.C.
References polyDistributionMap::mesh(), and Foam::read().
|
delete |
Disallow default bitwise assignment.
|
static |
Track direction enumeration names.
Definition at line 230 of file streamlines.H.