FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

sampledSets Class Reference

Set of sets to sample. Call sampledSets.write() to sample&write files. More...

#include <sampling/sampledSets.H>


Detailed Description

Set of sets to sample. Call sampledSets.write() to sample&write files.

Source files

Definition at line 59 of file sampledSets.H.

Inheritance diagram for sampledSets:
Collaboration diagram for sampledSets:

List of all members.

Classes

class  fieldGroup
 Class used for grouping field types.
class  volFieldSampler
 Class used for sampling volFields.

Public Member Functions

 TypeName ("sets")
 Runtime type information.
 sampledSets (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary.
virtual  ~sampledSets ()
virtual const word &  name () const
 Return name of the set of probes.
void  verbose (const bool verbosity=true)
 set verbosity level
virtual void  execute ()
 Execute, currently does nothing.
virtual void  end ()
 Execute at the final time-loop, currently does nothing.
virtual void  write ()
 Sample and write.
virtual void  read (const dictionary &)
 Read the sampledSets.
void  correct ()
 Correct for mesh changes.
virtual void  updateMesh (const mapPolyMesh &)
 Update for changes of mesh.
virtual void  movePoints (const pointField &)
 Update for mesh point-motion.
virtual void  readUpdate (const polyMesh::readUpdateState state)
 Update for changes of mesh due to readUpdate.

Constructor & Destructor Documentation

sampledSets ( 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 234 of file sampledSets.C.

References polyMesh::defaultRegion, and Pstream::parRun().

~sampledSets (  ) [virtual]

Definition at line 270 of file sampledSets.C.


Member Function Documentation

TypeName ( "sets"    )

Runtime type information.

virtual const word& name (  ) const [inline, virtual]

Return name of the set of probes.

Definition at line 264 of file sampledSets.H.

void verbose ( const bool   verbosity = true  )

set verbosity level

Definition at line 276 of file sampledSets.C.

void execute (  ) [virtual]

Execute, currently does nothing.

Definition at line 282 of file sampledSets.C.

void end (  ) [virtual]

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

Reimplemented from PtrList< sampledSet >.

Definition at line 288 of file sampledSets.C.

void write (  ) [virtual]

Sample and write.

Definition at line 294 of file sampledSets.C.

void read ( const dictionary &   dict  ) [virtual]

Read the sampledSets.

Definition at line 307 of file sampledSets.C.

References List< T >::clear(), Foam::endl(), forAll, Pstream::master(), Foam::nl, and Foam::Pout.

void correct (  )

Correct for mesh changes.

Definition at line 346 of file sampledSets.C.

References MeshObject< fvMesh, volPointInterpolation >::Delete(), and MeshObject< polyMesh, pointMesh >::Delete().

void updateMesh ( const mapPolyMesh &    ) [virtual]

Update for changes of mesh.

Definition at line 364 of file sampledSets.C.

References correct().

void movePoints ( const pointField &    ) [virtual]

Update for mesh point-motion.

Definition at line 370 of file sampledSets.C.

References correct().

void readUpdate ( const polyMesh::readUpdateState   state  ) [virtual]

Update for changes of mesh due to readUpdate.

Definition at line 376 of file sampledSets.C.

References correct(), and polyMesh::UNCHANGED.


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