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

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

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

Public Member Functions

 TypeName ("sets")
 Runtime type information. More...
 
 sampledSets (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~sampledSets ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the set of probes. 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 sampledSets. More...
 
void correct ()
 Correct for mesh changes. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &)
 Update for mesh point-motion. More...
 
virtual void readUpdate (const polyMesh::readUpdateState state)
 Update for changes of mesh due to readUpdate. More...
 
- Public Member Functions inherited from PtrList< sampledSet >
 PtrList ()
 Null Constructor. More...
 
 PtrList (const label)
 Construct with size specified. More...
 
 PtrList (const PtrList< sampledSet > &)
 Copy constructor. More...
 
 PtrList (const PtrList< sampledSet > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (const Xfer< PtrList< sampledSet > > &)
 Construct by transferring the parameter contents. More...
 
 PtrList (PtrList< sampledSet > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< sampledSet > &)
 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...
 
sampledSetfirst ()
 Return reference to the first element of the list. More...
 
const sampledSetfirst () const
 Return reference to first element of the list. More...
 
sampledSetlast ()
 Return reference to the last element of the list. More...
 
const sampledSetlast () 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 (sampledSet *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< sampledSet > &)
 
void append (const tmp< sampledSet > &)
 
void transfer (PtrList< sampledSet > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
Xfer< PtrList< sampledSet > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< sampledSetset (const label, sampledSet *)
 Set element. Return old element (can be NULL). More...
 
autoPtr< sampledSetset (const label, const autoPtr< sampledSet > &)
 
autoPtr< sampledSetset (const label, const tmp< sampledSet > &)
 
void reorder (const labelUList &)
 Reorders elements. Ordering does not have to be done in. More...
 
const sampledSetoperator[] (const label) const
 Return element const reference. More...
 
sampledSetoperator[] (const label)
 Return element reference. More...
 
const sampledSetoperator() (const label) const
 Return element const pointer. More...
 
PtrList< sampledSet > & operator= (const PtrList< sampledSet > &)
 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< sampledSet >
typedef sampledSet value_type
 Type of values the PtrList contains. More...
 
typedef sampledSetreference
 Type that can be used for storing into PtrList::value_type objects. More...
 
typedef const sampledSetconst_reference
 Type that can be used for storing into constant PtrList::value_type. More...
 
- Protected Member Functions inherited from PtrList< sampledSet >
void read (Istream &, const INew &inewt)
 Read from Istream using given Istream constructor class. More...
 

Detailed Description

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

Source files

Definition at line 59 of file sampledSets.H.

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

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

Here is the call graph for this function:

~sampledSets ( )
virtual

Destructor.

Definition at line 167 of file sampledSets.C.

Member Function Documentation

TypeName ( "sets"  )

Runtime type information.

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

Set verbosity level.

Definition at line 173 of file sampledSets.C.

Referenced by sampledSets::name().

Here is the caller graph for this function:

void execute ( )
virtual

Execute, currently does nothing.

Definition at line 179 of file sampledSets.C.

Referenced by sampledSets::name().

Here is the caller graph for this function:

void end ( )
virtual

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

Definition at line 185 of file sampledSets.C.

Referenced by sampledSets::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 191 of file sampledSets.C.

Referenced by sampledSets::name().

Here is the caller graph for this function:

void write ( )
virtual

Sample and write.

Definition at line 197 of file sampledSets.C.

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

Referenced by sampledSets::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 sampledSets.

Definition at line 240 of file sampledSets.C.

References dict, Foam::endl(), forAll, dictionary::found(), Foam::Info, dictionary::lookup(), UPstream::master(), Foam::nl, and Foam::Pout.

Referenced by sampledSets::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void correct ( )

Correct for mesh changes.

Definition at line 286 of file sampledSets.C.

Referenced by sampledSets::name().

Here is the caller graph for this function:

void updateMesh ( const mapPolyMesh )
virtual

Update for changes of mesh.

Definition at line 304 of file sampledSets.C.

References correct.

Referenced by sampledSets::name().

Here is the caller graph for this function:

void movePoints ( const polyMesh )
virtual

Update for mesh point-motion.

Definition at line 310 of file sampledSets.C.

References correct.

Referenced by sampledSets::name().

Here is the caller graph for this function:

void readUpdate ( const polyMesh::readUpdateState  state)
virtual

Update for changes of mesh due to readUpdate.

Definition at line 316 of file sampledSets.C.

References correct, and polyMesh::UNCHANGED.

Referenced by sampledSets::name().

Here is the caller graph for this function:


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