Set of surfaces to sample. More...
#include <sampling/sampledSurfaces.H>
Set of surfaces to sample.
The write() method is used to sample and write files.
Definition at line 56 of file sampledSurfaces.H.
Inheritance diagram for sampledSurfaces: Collaboration diagram for sampledSurfaces:Classes | |
| class | fieldGroup |
| Class used for grouping field types.
| |
| class | mergeInfo |
| Class used for surface merging information.
| |
Public Member Functions | |
| TypeName ("surfaces") | |
| Runtime type information.
| |
| sampledSurfaces (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false) | |
| Construct for given objectRegistry and dictionary.
| |
| virtual | ~sampledSurfaces () |
| virtual bool | needsUpdate () const |
| Does any of the surfaces need an update?
| |
| virtual bool | expire () |
| Mark the surfaces as needing an update.
| |
| virtual bool | update () |
| Update the surfaces as required and merge surface points (parallel).
| |
| virtual const word & | name () const |
| Return name of the set of surfaces.
| |
| 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 sampledSurfaces dictionary.
| |
| virtual void | updateMesh (const mapPolyMesh &) |
| Update for changes of mesh - expires the surfaces.
| |
| virtual void | movePoints (const pointField &) |
| Update for mesh point-motion - expires the surfaces.
| |
| virtual void | readUpdate (const polyMesh::readUpdateState state) |
| Update for changes of mesh due to readUpdate - expires the surfaces.
| |
| sampledSurfaces | ( | 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 198 of file sampledSurfaces.C.
References Pstream::parRun().
| ~sampledSurfaces | ( | ) | [virtual]
|
Definition at line 236 of file sampledSurfaces.C.
| TypeName | ( | "surfaces" | ) |
Runtime type information.
| bool needsUpdate | ( | ) | const [virtual]
|
Does any of the surfaces need an update?
Definition at line 385 of file sampledSurfaces.C.
References forAll.
| bool expire | ( | ) | [virtual]
|
Mark the surfaces as needing an update.
May also free up unneeded data. Return false if all surfaces were already marked as expired.
Definition at line 399 of file sampledSurfaces.C.
References forAll, and Pstream::parRun().
| bool update | ( | ) | [virtual]
|
Update the surfaces as required and merge surface points (parallel).
Return false if no surfaces required an update.
Definition at line 422 of file sampledSurfaces.C.
References Foam::endl(), sampledSurface::faces(), forAll, Pstream::gatherList(), Foam::inplaceRenumber(), Pstream::master(), Foam::mergePoints(), Pstream::myProcNo(), Foam::nl, Pstream::nProcs(), Pstream::parRun(), points, sampledSurface::points(), Foam::Pout, Foam::ListListOps::subSizes(), and sampledSurface::update().
| virtual const word& name | ( | ) | const [inline, virtual]
|
Return name of the set of surfaces.
Definition at line 256 of file sampledSurfaces.H.
| void verbose | ( | const bool | verbosity = true
) |
set verbosity level
Definition at line 242 of file sampledSurfaces.C.
| void execute | ( | ) | [virtual]
|
Execute, currently does nothing.
Definition at line 248 of file sampledSurfaces.C.
| void end | ( | ) | [virtual]
|
Execute at the final time-loop, currently does nothing.
Reimplemented from PtrList< sampledSurface >.
Definition at line 254 of file sampledSurfaces.C.
| void write | ( | ) | [virtual]
|
Sample and write.
Definition at line 260 of file sampledSurfaces.C.
References Foam::endl(), Pstream::master(), Foam::mkDir(), Foam::nl, and Foam::Pout.
| void read | ( | const dictionary & | dict ) | [virtual]
|
Read the sampledSurfaces dictionary.
Definition at line 304 of file sampledSurfaces.C.
References Foam::endl(), forAll, dictionary::lookup(), dictionary::lookupOrDefault(), Pstream::master(), surfaceWriter< Type >::New(), Foam::nl, Pstream::parRun(), Foam::Pout, and List< T >::size().
| void updateMesh | ( | const mapPolyMesh & | ) | [virtual]
|
Update for changes of mesh - expires the surfaces.
Definition at line 362 of file sampledSurfaces.C.
| void movePoints | ( | const pointField & | ) | [virtual]
|
Update for mesh point-motion - expires the surfaces.
Definition at line 370 of file sampledSurfaces.C.
| void readUpdate | ( | const polyMesh::readUpdateState | state ) | [virtual]
|
Update for changes of mesh due to readUpdate - expires the surfaces.
Definition at line 376 of file sampledSurfaces.C.
References polyMesh::UNCHANGED.
