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 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...
 
virtual const wordname () const
 Return name of the set of surfaces. More...
 
void verbose (const bool verbosity=true)
 Set verbosity level. More...
 
virtual void execute ()
 Execute, currently does nothing. More...
 
virtual void end ()
 Execute at the final time-loop, currently does nothing. More...
 
virtual void timeSet ()
 Called when time was set at the end of the Time::operator++. More...
 
virtual void write ()
 Sample and write. More...
 
virtual void read (const dictionary &)
 Read the sampledSurfaces dictionary. 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 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...
 
label size () const
 Return the number of elements in the PtrList. More...
 
bool empty () const
 Return true if the PtrList is empty (ie, size() is zero). More...
 
sampledSurfacefirst ()
 Return reference to the first element of the list. More...
 
const sampledSurfacefirst () const
 Return reference to first element of the list. More...
 
sampledSurfacelast ()
 Return reference to the last element of the list. More...
 
const sampledSurfacelast () const
 Return reference to the last element of the list. 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. Return old element (can be NULL). More...
 
autoPtr< sampledSurfaceset (const label, const autoPtr< sampledSurface > &)
 
autoPtr< sampledSurfaceset (const label, const tmp< sampledSurface > &)
 
void reorder (const labelUList &)
 Reorders elements. Ordering does not have to be done in. More...
 
const sampledSurfaceoperator[] (const label) const
 Return element const reference. More...
 
sampledSurfaceoperator[] (const label)
 Return element reference. More...
 
const sampledSurfaceoperator() (const label) const
 Return element const pointer. More...
 
PtrList< sampledSurface > & operator= (const PtrList< sampledSurface > &)
 Assignment. More...
 
iterator begin ()
 Return an iterator to begin traversing the PtrList. More...
 
const_iterator begin () const
 Return an const_iterator to begin traversing the PtrList. More...
 
iterator end ()
 Return an iterator to end traversing the PtrList. More...
 
const_iterator end () const
 Return an const_iterator to end traversing the PtrList. More...
 
const_iterator cbegin () const
 Return an const_iterator to begin traversing the PtrList. More...
 
const_iterator cend () const
 Return an const_iterator to end traversing the PtrList. More...
 

Additional Inherited Members

- Public Types inherited from PtrList< sampledSurface >
typedef sampledSurface value_type
 Type of values the PtrList contains. More...
 
typedef sampledSurfacereference
 Type that can be used for storing into PtrList::value_type objects. More...
 
typedef const sampledSurfaceconst_reference
 Type that can be used for storing into constant PtrList::value_type. 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 58 of file sampledSurfaces.H.

Constructor & Destructor Documentation

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

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

Here is the call graph for this function:

~sampledSurfaces ( )
virtual

Destructor.

Definition at line 120 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 277 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 291 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 314 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:

virtual const word& name ( ) const
inlinevirtual
void verbose ( const bool  verbosity = true)

Set verbosity level.

Definition at line 126 of file sampledSurfaces.C.

Referenced by sampledSurfaces::name().

Here is the caller graph for this function:

void execute ( )
virtual

Execute, currently does nothing.

Definition at line 132 of file sampledSurfaces.C.

Referenced by sampledSurfaces::name().

Here is the caller graph for this function:

void end ( )
virtual

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

Definition at line 138 of file sampledSurfaces.C.

Referenced by sampledSurfaces::name().

Here is the caller graph for this function:

void timeSet ( )
virtual

Called when time was set at the end of the Time::operator++.

Definition at line 144 of file sampledSurfaces.C.

Referenced by sampledSurfaces::name().

Here is the caller graph for this function:

void write ( )
virtual

Sample and write.

Definition at line 150 of file sampledSurfaces.C.

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

Referenced by sampledSurfaces::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void read ( const dictionary dict)
virtual

Read the sampledSurfaces dictionary.

Definition at line 195 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().

Referenced by sampledSurfaces::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void updateMesh ( const mapPolyMesh )
virtual

Update for changes of mesh - expires the surfaces.

Definition at line 254 of file sampledSurfaces.C.

Referenced by sampledSurfaces::name().

Here is the caller graph for this function:

void movePoints ( const polyMesh )
virtual

Update for mesh point-motion - expires the surfaces.

Definition at line 262 of file sampledSurfaces.C.

Referenced by sampledSurfaces::name().

Here is the caller graph for this function:

void readUpdate ( const polyMesh::readUpdateState  state)
virtual

Update for changes of mesh due to readUpdate - expires the surfaces.

Definition at line 268 of file sampledSurfaces.C.

References polyMesh::UNCHANGED.

Referenced by sampledSurfaces::name().

Here is the caller graph for this function:


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