Public Member Functions | List of all members

Evaluates and outputs turbulence y+ for models. Values written to time directories as field 'yPlus'. More...

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

Public Member Functions

 TypeName ("yPlus")
 Runtime type information. More...
 
 yPlus (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~yPlus ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the set of yPlus. More...
 
virtual void read (const dictionary &)
 Read the yPlus 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 ()
 Calculate the yPlus and 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...
 

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...
 
- 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...
 

Detailed Description

Evaluates and outputs turbulence y+ for models. Values written to time directories as field 'yPlus'.

Source files

Definition at line 63 of file yPlus.H.

Constructor & Destructor Documentation

yPlus ( 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 57 of file yPlus.C.

References Foam::dimless, Foam::endl(), mesh, Foam::nl, IOobject::NO_READ, IOobject::NO_WRITE, fvMesh::time(), Time::timeName(), Foam::type(), and WarningIn.

Here is the call graph for this function:

~yPlus ( )
virtual

Destructor.

Definition at line 116 of file yPlus.C.

Member Function Documentation

TypeName ( "yPlus"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual

Return name of the set of yPlus.

Definition at line 131 of file yPlus.H.

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

Here is the call graph for this function:

void read ( const dictionary dict)
virtual

Read the yPlus data.

Definition at line 122 of file yPlus.C.

References dictionary::lookupOrDefault().

Referenced by yPlus::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 132 of file yPlus.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, objectRegistry::foundObject(), Foam::Info, objectRegistry::lookupObject(), mesh, Foam::nl, turbulenceModel::propertiesName, Foam::type(), and functionObjectFile::write().

Referenced by yPlus::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void end ( )
virtual

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

Definition at line 176 of file yPlus.C.

Referenced by yPlus::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 185 of file yPlus.C.

Referenced by yPlus::name().

Here is the caller graph for this function:

void write ( )
virtual

Calculate the yPlus and write.

Reimplemented from functionObjectFile.

Definition at line 191 of file yPlus.C.

References Foam::endl(), Foam::Info, IOobject::name(), Foam::nl, Foam::type(), functionObjectFile::write(), and regIOobject::write().

Referenced by yPlus::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 152 of file yPlus.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 156 of file yPlus.H.


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