Lambda2 Class Reference

This function object calculates and outputs the second largest eigenvalue of the sum of the square of the symmetrical and anti-symmetrical parts of the velocity gradient tensor. More...

Collaboration diagram for Lambda2:

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

Private Attributes
word	name_
	Name of this set of Lambda2 objects. More...
const objectRegistry &	obr_
	Reference to the database. More...
bool	active_
	On/off switch. More...
word	UName_
	Name of velocity field, default is "U". 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 second largest eigenvalue of the sum of the square of the symmetrical and anti-symmetrical parts of the velocity gradient tensor.

Example of function object specification to calculate Lambda2:

Lambda2_1
{
    type        Lambda2;
    functionObjectLibs ("libutilityFunctionObjects.so");
    ...
}

Function object usage

Property	Description	Required	Default value
type	Type name: Lambda2	yes
UName	Name of velocity field	no	U
resultName	Name of Lambda2 field	no	<function name>
log	Log to standard output	no	yes

Source files

• Lambda2.H
• Lambda2.C
• IOLambda2.H

Definition at line 107 of file Lambda2.H.

Constructor & Destructor Documentation

Lambda2() [1/2]

Lambda2 ( const Lambda2 &  )

private

Disallow default bitwise copy construct.

Lambda2() [2/2]

Lambda2	(	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 43 of file Lambda2.C.

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

Here is the call graph for this function:

~Lambda2()

~Lambda2 ( )

virtual

Destructor.

Definition at line 96 of file Lambda2.C.

Member Function Documentation

operator=()

void operator= ( const Lambda2 &  )

private

Disallow default bitwise assignment.

TypeName()

TypeName

(

"Lambda2"

)

Runtime type information.

name()

virtual const word& name ( ) const

inlinevirtual

Return name of the set of Lambda2.

Definition at line 165 of file Lambda2.H.

References Lambda2::name_.

Referenced by Lambda2::write().

Here is the caller graph for this function:

read()

void read ( const dictionary &  dict )

virtual

Read the Lambda2 data.

Definition at line 102 of file Lambda2.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 121 of file Lambda2.C.

References Foam::component(), Foam::eigenValues(), Foam::fvc::grad(), objectRegistry::lookupObject(), mesh, Foam::skew(), Foam::symm(), U, and Vector< scalar >::Y.

Here is the call graph for this function:

end()

void end ( )

virtual

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

Definition at line 149 of file Lambda2.C.

timeSet()

void timeSet ( )

virtual

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

Definition at line 155 of file Lambda2.C.

write()

void write ( )

virtual

Calculate the Lambda2 and write.

Definition at line 161 of file Lambda2.C.

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

Referenced by Foam::calc(), and Lambda2::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 186 of file Lambda2.H.

movePoints()

virtual void movePoints ( const polyMesh &  )

inlinevirtual

Update for changes of mesh.

Definition at line 190 of file Lambda2.H.

Field Documentation

name_

word name_

private

Name of this set of Lambda2 objects.

Definition at line 112 of file Lambda2.H.

Referenced by Lambda2::name().

obr_

const objectRegistry& obr_

private

Reference to the database.

Definition at line 115 of file Lambda2.H.

active_

bool active_

private

On/off switch.

Definition at line 118 of file Lambda2.H.

UName_

word UName_

private

Name of velocity field, default is "U".

Definition at line 121 of file Lambda2.H.

resultName_

word resultName_

private

Result name.

Definition at line 124 of file Lambda2.H.

log_

Switch log_

private

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

Definition at line 127 of file Lambda2.H.

---

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

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