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

Inheritance diagram for yPlus:

[legend]

Collaboration diagram for yPlus:

[legend]

Public Member Functions
	TypeName ("yPlus")
	Runtime type information. More...

	yPlus (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	yPlus (const yPlus &)=delete
	Disallow default bitwise copy construction. More...

virtual	~yPlus ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read the yPlus data. More...

virtual bool	execute ()
	Calculate the yPlus field. More...

virtual bool	write ()
	Write the yPlus field. More...

void	operator= (const yPlus &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	Runtime type information. More...

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fvMeshFunctionObject ()
	Destructor. More...

void	operator= (const fvMeshFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	Runtime type information. More...

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~regionFunctionObject ()
	Destructor. More...

void	operator= (const regionFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from functionObject
	ClassName ("functionObject")

virtual const word &	type () 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< functionObject >	clone () const
	Return clone. More...

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. More...

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual scalar	timeToNextWrite ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh. More...

virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh. More...

void	operator= (const functionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from logFiles
	logFiles (const objectRegistry &obr, const word &prefix)
	Construct from objectRegistry and prefix. More...

	logFiles (const logFiles &)=delete
	Disallow default bitwise copy construction. More...

virtual	~logFiles ()
	Destructor. More...

const wordList &	names () const
	Return const access to the names. More...

PtrList< OFstream > &	files ()
	Return access to the files. More...

OFstream &	file ()
	Return access to the file (if only 1) More...

OFstream &	file (const label i)
	Return file 'i'. More...

void	operator= (const logFiles &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const word &prefix)
	Construct from objectRegistry and prefix. More...

	writeFile (const writeFile &)=delete
	Disallow default bitwise copy construction. More...

	~writeFile ()
	Destructor. More...

void	initStream (Ostream &os) const
	Initialise the output stream for writing. More...

fileName	baseFileDir () const
	Return the base directory for output. More...

fileName	baseTimeDir () const
	Return the base directory for the current time value. More...

Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset. 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...

void	writeTime (Ostream &os) const
	Write the current time 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...

void	operator= (const writeFile &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from writeLocalObjects
	writeLocalObjects (const objectRegistry &obr, const Switch &logRef)
	Construct from objectRegistry and inheriting function object. More...

	writeLocalObjects (const writeLocalObjects &)=delete
	Disallow default bitwise copy construction. More...

virtual	~writeLocalObjects ()
	Destructor. More...

const wordList &	localObjectNames () const
	Return const access to the local object names. More...

void	operator= (const writeLocalObjects &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from writeObjectsBase
	writeObjectsBase (const objectRegistry &obr, const Switch &logRef)
	Construct from objectRegistry and inheriting function object. More...

	writeObjectsBase (const writeObjectsBase &)=delete
	Disallow default bitwise copy construction. More...

virtual	~writeObjectsBase ()
	Destructor. More...

const wordReList &	writeObjectNames () const
	Return const access to the object names requested to be written. More...

void	operator= (const writeObjectsBase &)=delete
	Disallow default bitwise assignment. More...

Protected Attributes
word	phaseName_
	Optional phase name. More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
const Time &	time_
	Reference to the Time. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

Protected Attributes inherited from logFiles
wordList	names_
	File names. More...

PtrList< OFstream >	filePtrs_
	File pointer. More...

Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry. More...

const word	prefix_
	Prefix. More...

Protected Attributes inherited from writeLocalObjects
wordList	localObjectNames_
	Object names that are handled on behalf of the inheritor. More...

Protected Attributes inherited from writeObjectsBase
const objectRegistry &	writeObr_
	Reference to the region objectRegistry. More...

const Switch &	log_
	Reference to the inheriting function object's log variable. More...

Switch	regExp_
	Optional switch for regular expression support. More...

wordReList	writeObjectNames_
	Object names requested by the user to be written. More...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (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...

Switch	executeAtStart_
	Switch write log to Info. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Static Public Attributes inherited from writeFile
static const word	outputPrefix
	Directory prefix. More...

static label	addChars = 8
	Additional characters for writing. More...

Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
bool	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
bool	store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the given field in the objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the objectRegistry if present. More...

Protected Member Functions inherited from logFiles
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...

Protected Member Functions inherited from writeLocalObjects
void	resetLocalObjectName (const word &name)
	Reset the list of local object names from a single word. More...

void	resetLocalObjectNames (const wordList &names)
	Reset the list of local object names from a wordList. More...

virtual wordList	objectNames ()
	Get the list of field names to be written. More...

Protected Member Functions inherited from writeObjectsBase
void	resetWriteObjectName (const wordRe &name)
	Reset the list of object names to be written to a single regular. More...

void	resetWriteObjectNames (const wordReList &names)
	Reset the list of object names to be written. More...

virtual void	writeObject (const regIOobject &obj)
	Write the requested registered IO object. More...

Detailed Description

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

Example of function object specification:

yPlus1
{
    type        yPlus;
    libs        ("libfieldFunctionObjects.so");
    ...
}

Usage

Property	Description	Required	Default value
`type`	type name: yPlus	yes
`phase`	phase name	no

Note: Writing field 'yPlus' is done by default, but it can be overridden by defining an empty objects list. For details see writeLocalObjects.

See also: Foam::functionObject Foam::functionObjects::fvMeshFunctionObject Foam::functionObjects::logFiles Foam::functionObjects::writeLocalObjects Foam::functionObjects::timeControl

Source files

Definition at line 101 of file yPlus.H.

Constructor & Destructor Documentation

◆ yPlus() [1/2]

yPlus	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Construct from Time and dictionary.

Definition at line 129 of file yPlus.C.

References Foam::read().

Here is the call graph for this function:

◆ yPlus() [2/2]

yPlus ( const yPlus & )

delete

Disallow default bitwise copy construction.

◆ ~yPlus()

~yPlus ( )

virtual

Destructor.

Definition at line 146 of file yPlus.C.

Member Function Documentation

◆ TypeName()

TypeName ( "yPlus" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the yPlus data.

Reimplemented from writeLocalObjects.

Definition at line 152 of file yPlus.C.

References IOobject::groupName(), writeLocalObjects::read(), and regionFunctionObject::read().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Calculate the yPlus field.

Implements functionObject.

Definition at line 164 of file yPlus.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOobject::groupName(), Foam::name(), and Foam::type().

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Write the yPlus field.

Reimplemented from logFiles.

Definition at line 196 of file yPlus.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), Foam::endl(), Foam::file, forAll, Foam::gAverage(), Foam::gMax(), Foam::gMin(), IOobject::groupName(), Log, regionFunctionObject::lookupObject(), UPstream::master(), fvPatch::name(), Foam::name(), Foam::nl, patchi, Foam::tab, Foam::type(), logFiles::write(), and writeObjectsBase::write().

Here is the call graph for this function:

◆ operator=()

void operator= ( const yPlus & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ phaseName_

word phaseName_

protected

Optional phase name.

Definition at line 112 of file yPlus.H.

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

src/functionObjects/field/yPlus/yPlus.H
src/functionObjects/field/yPlus/yPlus.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ yPlus() [1/2]

◆ yPlus() [2/2]

◆ ~yPlus()

Member Function Documentation

◆ TypeName()

◆ read()

◆ execute()

◆ write()

◆ operator=()

Member Data Documentation

◆ phaseName_