Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
cloudInfo Class Reference

This function object outputs Lagrangian cloud information to a file. The current outputs include: More...

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

Public Member Functions

 TypeName ("cloudInfo")
 Runtime type information. More...
 
 cloudInfo (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~cloudInfo ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the cloudInfo object. More...
 
virtual void read (const dictionary &)
 Read the field min/max data. 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 ()
 Write. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &)
 Update for changes of mesh. More...
 
- Public Member Functions inherited from functionObjectFile
 functionObjectFile (const objectRegistry &obr, const word &prefix)
 Construct null. More...
 
 functionObjectFile (const objectRegistry &obr, const word &prefix, const word &name)
 Construct from components. More...
 
 functionObjectFile (const objectRegistry &obr, const word &prefix, const wordList &names)
 Construct from components. More...
 
virtual ~functionObjectFile ()
 Destructor. More...
 
const wordListnames () const
 Return const access to the names. More...
 
OFstreamfile ()
 Return access to the file (if only 1) More...
 
PtrList< OFstream > & files ()
 Return access to the files. More...
 
OFstreamfile (const label i)
 Return file 'i'. More...
 
void writeCommented (Ostream &os, const string &str) const
 Write a commented string to stream. More...
 
void writeTabbed (Ostream &os, const string &str) const
 Write a tabbed string to stream. More...
 
void writeHeader (Ostream &os, const string &str) const
 Write a commented header to stream. More...
 
template<class Type >
void writeHeaderValue (Ostream &os, const string &property, const Type &value) const
 Write a (commented) header property and value pair. More...
 
label charWidth () const
 Return width of character stream output. More...
 

Protected Member Functions

virtual void writeFileHeader (const label i)
 File header information. More...
 
 cloudInfo (const cloudInfo &)
 Disallow default bitwise copy construct. More...
 
void operator= (const cloudInfo &)
 Disallow default bitwise assignment. More...
 
- Protected Member Functions inherited from functionObjectFile
virtual void initStream (Ostream &os) const
 Initialise the output stream for writing. More...
 
virtual fileName baseFileDir () const
 Return the base directory for output. More...
 
virtual fileName baseTimeDir () const
 Return the base directory for the current time value. More...
 
virtual void createFiles ()
 Create the output file. More...
 
virtual void resetNames (const wordList &names)
 Reset the list of names from a wordList. More...
 
virtual void resetName (const word &name)
 Reset the list of names to a single name entry. More...
 
virtual Omanip< int > valueWidth (const label offset=0) const
 Return the value width when writing to stream with optional offset. More...
 
 functionObjectFile (const functionObjectFile &)
 Disallow default bitwise copy construct. More...
 
void operator= (const functionObjectFile &)
 Disallow default bitwise assignment. More...
 

Protected Attributes

word name_
 Name of this set of cloudInfo object. More...
 
const objectRegistryobr_
 Reference to the database. More...
 
bool active_
 on/off switch More...
 

Additional Inherited Members

- Static Public Attributes inherited from functionObjectFile
static const word outputPrefix = "postProcessing"
 Directory prefix. More...
 
static label addChars = 7
 Additional characters for writing. More...
 

Detailed Description

This function object outputs Lagrangian cloud information to a file. The current outputs include:

- total current number of parcels

Example of function object specification:

cloudInfo1
{
    type        cloudInfo;
    functionObjectLibs ("libcloudFunctionObjects.so");
    ...
    clouds
    (
        kinematicCloud1
        thermoCloud1
    );
}


Function object usage

Property Description Required Default value
type type name: cloudInfo yes
clouds list of clouds names to process yes

The output data of each cloud is written to a file named <cloudName>.dat

See also
Foam::functionObject Foam::OutputFilterFunctionObject
Source files

Definition at line 109 of file cloudInfo.H.

Constructor & Destructor Documentation

cloudInfo ( const cloudInfo )
protected

Disallow default bitwise copy construct.

Referenced by cloudInfo::writeFileHeader().

Here is the caller graph for this function:

cloudInfo ( 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 53 of file cloudInfo.C.

References Foam::read().

Here is the call graph for this function:

~cloudInfo ( )
virtual

Destructor.

Definition at line 71 of file cloudInfo.C.

Member Function Documentation

void writeFileHeader ( const label  i)
protectedvirtual

File header information.

Reimplemented from functionObjectFile.

Definition at line 40 of file cloudInfo.C.

References cloudInfo::cloudInfo(), and Foam::endl().

Here is the call graph for this function:

void operator= ( const cloudInfo )
protected

Disallow default bitwise assignment.

TypeName ( "cloudInfo"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual

Return name of the cloudInfo object.

Definition at line 165 of file cloudInfo.H.

References cloudInfo::end(), cloudInfo::execute(), cloudInfo::name_, cloudInfo::read(), cloudInfo::timeSet(), and cloudInfo::write().

Here is the call graph for this function:

void read ( const dictionary dict)
virtual

Read the field min/max data.

Definition at line 77 of file cloudInfo.C.

References Foam::endl(), forAll, Foam::Info, dictionary::lookup(), Foam::nl, functionObjectFile::resetNames(), and Foam::type().

Referenced by cloudInfo::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void execute ( )
virtual

Execute, currently does nothing.

Definition at line 101 of file cloudInfo.C.

Referenced by cloudInfo::name().

Here is the caller graph for this function:

void end ( )
virtual

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

Definition at line 105 of file cloudInfo.C.

Referenced by cloudInfo::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 109 of file cloudInfo.C.

Referenced by cloudInfo::name().

Here is the caller graph for this function:

void write ( )
virtual

Write.

Reimplemented from functionObjectFile.

Definition at line 113 of file cloudInfo.C.

References cloudName(), Foam::endl(), forAll, objectRegistry::lookupObject(), kinematicCloud::massInSystem(), UPstream::master(), kinematicCloud::nParcels(), Foam::returnReduce(), token::TAB, and functionObjectFile::write().

Referenced by cloudInfo::name().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void updateMesh ( const mapPolyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 186 of file cloudInfo.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 190 of file cloudInfo.H.

Member Data Documentation

word name_
protected

Name of this set of cloudInfo object.

Definition at line 118 of file cloudInfo.H.

Referenced by cloudInfo::name().

const objectRegistry& obr_
protected

Reference to the database.

Definition at line 121 of file cloudInfo.H.

bool active_
protected

on/off switch

Definition at line 124 of file cloudInfo.H.


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