Peclet Class Reference

This function object calculates and outputs the Peclet number as a surfaceScalarField. More...

Collaboration diagram for Peclet:

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

Private Member Functions
	Peclet (const Peclet &)
	Disallow default bitwise copy construct. More...
void	operator= (const Peclet &)
	Disallow default bitwise assignment. More...

Private Attributes
word	name_
	Name of this set of Peclet objects. More...
const objectRegistry &	obr_
	Reference to the database. More...
bool	active_
	On/off switch. More...
word	phiName_
	Name of flux field, default is "phi". More...
word	resultName_
	Result name. More...
Switch	log_
	Switch to send output to Info as well as to file. More...

Detailed Description

This function object calculates and outputs the Peclet number as a surfaceScalarField.

Example of function object specification to calculate the Peclet number:

Peclet1
{
    type        Peclet;
    functionObjectLibs ("libutilityFunctionObjects.so");
    ...
}

Function object usage

Property	Description	Required	Default value
type	type name: Peclet	yes
phiName	Name of flux field	no	phi
resultName	Name of Peclet field	no	<function name>
log	Log to standard output	no	yes

Source files

• Peclet.H
• Peclet.C
• IOPeclet.H

Definition at line 106 of file Peclet.H.

Constructor & Destructor Documentation

Peclet() [1/2]

Peclet ( const Peclet &  )

private

Disallow default bitwise copy construct.

Peclet() [2/2]

Peclet	(	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 45 of file Peclet.C.

References dict, Foam::dimless, Foam::endl(), mesh, Foam::nl, Foam::read(), and WarningInFunction.

Here is the call graph for this function:

~Peclet()

~Peclet ( )

virtual

Destructor.

Definition at line 98 of file Peclet.C.

Member Function Documentation

operator=()

void operator= ( const Peclet &  )

private

Disallow default bitwise assignment.

TypeName()

TypeName

(

"Peclet"

)

Runtime type information.

name()

virtual const word& name ( ) const

inlinevirtual

Return name of the set of Peclet.

Definition at line 164 of file Peclet.H.

References Peclet::name_.

Referenced by Peclet::write().

Here is the caller graph for this function:

read()

void read ( const dictionary &  dict )

virtual

Read the Peclet data.

Definition at line 104 of file Peclet.C.

References dict, and dictionary::readIfPresent().

Here is the call graph for this function:

execute()

void execute ( )

virtual

Execute, currently does nothing.

Definition at line 115 of file Peclet.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, objectRegistry::foundObject(), Foam::fvc::interpolate(), dictionary::lookup(), objectRegistry::lookupObject(), Foam::mag(), fvMesh::magSf(), mesh, IOobject::NO_READ, IOobject::NO_WRITE, phi, turbulenceModel::propertiesName, fvMesh::time(), and Time::timeName().

Here is the call graph for this function:

end()

void end ( )

virtual

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

Definition at line 203 of file Peclet.C.

timeSet()

void timeSet ( )

virtual

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

Definition at line 209 of file Peclet.C.

write()

void write ( )

virtual

Calculate the Peclet and write.

Definition at line 215 of file Peclet.C.

References Foam::endl(), Foam::Info, Peclet::name(), Foam::nl, Foam::type(), and Peclet::write().

Referenced by Peclet::write().

Here is the call graph for this function:

Here is the caller graph for this function:

updateMesh()

virtual void updateMesh ( const mapPolyMesh &  )

inlinevirtual

Update for changes of mesh.

Definition at line 185 of file Peclet.H.

movePoints()

virtual void movePoints ( const polyMesh &  )

inlinevirtual

Update for changes of mesh.

Definition at line 189 of file Peclet.H.

Field Documentation

name_

word name_

private

Name of this set of Peclet objects.

Definition at line 111 of file Peclet.H.

Referenced by Peclet::name().

obr_

const objectRegistry& obr_

private

Reference to the database.

Definition at line 114 of file Peclet.H.

active_

bool active_

private

On/off switch.

Definition at line 117 of file Peclet.H.

phiName_

word phiName_

private

Name of flux field, default is "phi".

Definition at line 120 of file Peclet.H.

resultName_

word resultName_

private

Result name.

Definition at line 123 of file Peclet.H.

log_

Switch log_

private

Switch to send output to Info as well as to file.

Definition at line 126 of file Peclet.H.

---

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

• src/postProcessing/functionObjects/utilities/Peclet/Peclet.H
• src/postProcessing/functionObjects/utilities/Peclet/Peclet.C