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.
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. | |
![]() | |
PtrList () | |
Null Constructor. | |
PtrList (const label) | |
Construct with length specified. | |
PtrList (const PtrList< sampledSurface > &) | |
Copy constructor. | |
PtrList (const PtrList< sampledSurface > &, const CloneArg &) | |
Copy constructor with additional argument for clone. | |
PtrList (const Xfer< PtrList< sampledSurface > > &) | |
Construct by transferring the parameter contents. | |
PtrList (PtrList< sampledSurface > &, bool reUse) | |
Construct as copy or re-use as specified. | |
PtrList (const SLPtrList< sampledSurface > &) | |
Construct as copy of SLPtrList<T> | |
PtrList (Istream &, const INew &) | |
Construct from Istream using given Istream constructor class. | |
PtrList (Istream &) | |
Construct from Istream using default Istream constructor class. | |
~PtrList () | |
label | size () const |
Return the number of elements in the PtrList. | |
bool | empty () const |
Return true if the PtrList is empty (ie, size() is zero). | |
void | setSize (const label) |
Reset size of PtrList. This can only be used to set the size. | |
void | resize (const label) |
Reset size of PtrList. This can only be used to set the size. | |
void | clear () |
Clear the PtrList, i.e. set size to zero deleting all the. | |
void | transfer (PtrList< sampledSurface > &) |
Transfer the contents of the argument PtrList into this PtrList. | |
Xfer< PtrList< sampledSurface > > | xfer () |
Transfer contents to the Xfer container. | |
bool | set (const label) const |
Is element set. | |
autoPtr< sampledSurface > | set (const label, sampledSurface *) |
Set element. Return old element (can be NULL). | |
autoPtr< sampledSurface > | set (const label, const autoPtr< sampledSurface > &) |
autoPtr< sampledSurface > | set (const label, const tmp< sampledSurface > &) |
void | reorder (const UList< label > &) |
Reorders elements. Ordering does not have to be done in. | |
const sampledSurface & | operator[] (const label) const |
Return element const reference. | |
sampledSurface & | operator[] (const label) |
Return element reference. | |
const sampledSurface * | operator() (const label) const |
Return element const pointer. | |
PtrList< sampledSurface > & | operator= (const PtrList< sampledSurface > &) |
Assignment. | |
iterator | begin () |
Return an iterator to begin traversing the PtrList. |
Additional Inherited Members | |
![]() | |
typedef sampledSurface | value_type |
Type of values the PtrList contains. | |
typedef sampledSurface & | reference |
Type that can be used for storing into PtrList::value_type objects. | |
typedef const sampledSurface & | const_reference |
Type that can be used for storing into constant PtrList::value_type. | |
![]() | |
void | read (Istream &, const INew &inewt) |
Read from Istream using given Istream constructor class. |
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().
|
virtual |
Definition at line 236 of file sampledSurfaces.C.
TypeName | ( | "surfaces" | ) |
Runtime type information.
|
virtual |
Does any of the surfaces need an update?
Definition at line 385 of file sampledSurfaces.C.
References forAll.
|
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().
|
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().
|
inlinevirtual |
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.
|
virtual |
Execute, currently does nothing.
Definition at line 248 of file sampledSurfaces.C.
|
virtual |
Execute at the final time-loop, currently does nothing.
Reimplemented from PtrList< sampledSurface >.
Definition at line 254 of file sampledSurfaces.C.
|
virtual |
Sample and write.
Definition at line 260 of file sampledSurfaces.C.
References Foam::endl(), Pstream::master(), Foam::mkDir(), Foam::nl, and Foam::Pout.
|
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().
|
virtual |
Update for changes of mesh - expires the surfaces.
Definition at line 362 of file sampledSurfaces.C.
|
virtual |
Update for mesh point-motion - expires the surfaces.
Definition at line 370 of file sampledSurfaces.C.
|
virtual |
Update for changes of mesh due to readUpdate - expires the surfaces.
Definition at line 376 of file sampledSurfaces.C.
References polyMesh::UNCHANGED.