Classes | Public Member Functions | List of all members
sampledSurfaces Class Reference

Set of surfaces to sample. More...

Inheritance diagram for sampledSurfaces:
Inheritance graph
[legend]
Collaboration diagram for sampledSurfaces:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("surfaces")
 Runtime type information. More...
 
 sampledSurfaces (const word &name, const Time &time, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 sampledSurfaces (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~sampledSurfaces ()
 Destructor. More...
 
virtual bool needsUpdate () const
 Does any of the surfaces need an update? More...
 
virtual bool expire ()
 Mark the surfaces as needing an update. More...
 
virtual bool update ()
 Update the surfaces as required and merge surface points (parallel). More...
 
void verbose (const bool verbosity=true)
 Set verbosity level. More...
 
virtual bool read (const dictionary &)
 Read the sampledSurfaces dictionary. More...
 
virtual bool execute ()
 Execute, currently does nothing. More...
 
virtual bool write ()
 Sample and write. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for changes of mesh - expires the surfaces. More...
 
virtual void movePoints (const polyMesh &)
 Update for mesh point-motion - expires the surfaces. More...
 
virtual void readUpdate (const polyMesh::readUpdateState state)
 Update for changes of mesh due to readUpdate - expires the surfaces. More...
 
- Public Member Functions inherited from functionObject
virtual const wordtype () 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< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () 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...
 
- Public Member Functions inherited from PtrList< sampledSurface >
 PtrList ()
 Null Constructor. More...
 
 PtrList (const label)
 Construct with size specified. More...
 
 PtrList (const PtrList< sampledSurface > &)
 Copy constructor. More...
 
 PtrList (const PtrList< sampledSurface > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (const Xfer< PtrList< sampledSurface >> &)
 Construct by transferring the parameter contents. More...
 
 PtrList (PtrList< sampledSurface > &, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< sampledSurface > &)
 Construct as copy of SLPtrList<T> More...
 
 PtrList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 PtrList (Istream &)
 Construct from Istream using default Istream constructor class. More...
 
 ~PtrList ()
 Destructor. More...
 
void setSize (const label)
 Reset size of PtrList. If extending the PtrList, new entries are. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void clear ()
 Clear the PtrList, i.e. set size to zero deleting all the. More...
 
void append (sampledSurface *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< sampledSurface > &)
 
void append (const tmp< sampledSurface > &)
 
void transfer (PtrList< sampledSurface > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
Xfer< PtrList< sampledSurface > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< sampledSurfaceset (const label, sampledSurface *)
 Set element to given T* and return old element (can be NULL) More...
 
autoPtr< sampledSurfaceset (const label, const autoPtr< sampledSurface > &)
 Set element to given autoPtr<T> and return old element. More...
 
autoPtr< sampledSurfaceset (const label, const tmp< sampledSurface > &)
 Set element to given tmp<T> and return old element. More...
 
void reorder (const labelUList &)
 Reorders elements. Ordering does not have to be done in. More...
 
void operator= (const PtrList< sampledSurface > &)
 Assignment. More...
 
- Public Member Functions inherited from UPtrList< T >
 UPtrList ()
 Null Constructor. More...
 
 UPtrList (const label)
 Construct with size specified. More...
 
 UPtrList (const Xfer< UPtrList< T >> &)
 Construct by transferring the parameter contents. More...
 
 UPtrList (UPtrList< T > &, bool reuse)
 Construct as copy or re-use as specified. More...
 
label size () const
 Return the number of elements in the UPtrList. More...
 
bool empty () const
 Return true if the UPtrList is empty (ie, size() is zero) More...
 
Tfirst ()
 Return reference to the first element of the list. More...
 
const Tfirst () const
 Return reference to first element of the list. More...
 
Tlast ()
 Return reference to the last element of the list. More...
 
const Tlast () const
 Return reference to the last element of the list. More...
 
void setSize (const label)
 Reset size of UPtrList. This can only be used to set the size. More...
 
void resize (const label)
 Reset size of UPtrList. This can only be used to set the size. More...
 
void clear ()
 Clear the UPtrList, i.e. set size to zero. More...
 
void transfer (UPtrList< T > &)
 Transfer the contents of the argument UPtrList into this. More...
 
Xfer< UPtrList< T > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool set (const label) const
 Is element set. More...
 
Tset (const label, T *)
 Set element. Return old element (can be NULL). More...
 
void reorder (const labelUList &)
 Reorders elements. Ordering does not have to be done in. More...
 
const Toperator[] (const label) const
 Return element const reference. More...
 
Toperator[] (const label)
 Return element reference. More...
 
const Toperator() (const label) const
 Return element const pointer. More...
 
iterator begin ()
 Return an iterator to begin traversing the UPtrList. More...
 
iterator end ()
 Return an iterator to end traversing the UPtrList. More...
 
const_iterator cbegin () const
 Return an const_iterator to begin traversing the UPtrList. More...
 
const_iterator cend () const
 Return an const_iterator to end traversing the UPtrList. More...
 
const_iterator begin () const
 Return an const_iterator to begin traversing the UPtrList. More...
 
const_iterator end () const
 Return an const_iterator to end traversing the UPtrList. More...
 

Additional Inherited Members

- Public Types inherited from UPtrList< T >
typedef T value_type
 Type of values the UPtrList contains. More...
 
typedef Treference
 Type that can be used for storing into UPtrList::value_type objects. More...
 
typedef const Tconst_reference
 Type that can be used for storing into constant UPtrList::value_type. More...
 
- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (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...
 
- Protected Member Functions inherited from PtrList< sampledSurface >
void read (Istream &, const INew &inewt)
 Read from Istream using given Istream constructor class. More...
 

Detailed Description

Set of surfaces to sample.

The write() method is used to sample and write files.

Source files

Definition at line 61 of file sampledSurfaces.H.

Constructor & Destructor Documentation

sampledSurfaces ( const word name,
const Time time,
const dictionary dict 
)

Construct from Time and dictionary.

Definition at line 97 of file sampledSurfaces.C.

References Foam::name(), UPstream::parRun(), and Foam::read().

Here is the call graph for this function:

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 136 of file sampledSurfaces.C.

References Foam::name(), UPstream::parRun(), and Foam::read().

Here is the call graph for this function:

~sampledSurfaces ( )
virtual

Destructor.

Definition at line 168 of file sampledSurfaces.C.

Member Function Documentation

TypeName ( "surfaces"  )

Runtime type information.

bool needsUpdate ( ) const
virtual

Does any of the surfaces need an update?

Definition at line 323 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 337 of file sampledSurfaces.C.

References forAll, and UPstream::parRun().

Here is the call graph for this function:

bool update ( )
virtual

Update the surfaces as required and merge surface points (parallel).

Return false if no surfaces required an update.

Definition at line 360 of file sampledSurfaces.C.

References Foam::endl(), sampledSurface::faces(), forAll, PatchTools::gatherAndMerge(), UPstream::master(), Foam::nl, UPstream::parRun(), points, sampledSurface::points(), Foam::Pout, List< T >::size(), and sampledSurface::update().

Here is the call graph for this function:

void verbose ( const bool  verbosity = true)

Set verbosity level.

Definition at line 174 of file sampledSurfaces.C.

bool read ( const dictionary dict)
virtual

Read the sampledSurfaces dictionary.

Reimplemented from functionObject.

Definition at line 233 of file sampledSurfaces.C.

References Foam::endl(), forAll, dictionary::found(), Foam::Info, dictionary::lookup(), UPstream::master(), surfaceWriter::New(), Foam::nl, UPstream::parRun(), Foam::Pout, and dictionary::subOrEmptyDict().

Here is the call graph for this function:

bool execute ( )
virtual

Execute, currently does nothing.

Implements functionObject.

Definition at line 180 of file sampledSurfaces.C.

bool write ( )
virtual

Sample and write.

Implements functionObject.

Definition at line 186 of file sampledSurfaces.C.

References Foam::endl(), UPstream::master(), Foam::mkDir(), Foam::nl, and Foam::Pout.

Here is the call graph for this function:

void updateMesh ( const mapPolyMesh mpm)
virtual

Update for changes of mesh - expires the surfaces.

Reimplemented from functionObject.

Definition at line 294 of file sampledSurfaces.C.

References mapPolyMesh::mesh().

Here is the call graph for this function:

void movePoints ( const polyMesh mesh)
virtual

Update for mesh point-motion - expires the surfaces.

Reimplemented from functionObject.

Definition at line 305 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 314 of file sampledSurfaces.C.

References polyMesh::UNCHANGED.


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