Class to describe eddies for the turbulentDFSEMInletFvPatchVectorField boundary condition. More...

#include <eddy.H>

Public Member Functions
	eddy ()
	Construct null.
	eddy (Istream &is)
	Construct from Istream.
	eddy (const label patchFaceI, const point &position0, const scalar x, const scalar sigmaX, const symmTensor &R, Random &rndGen)
	Construct from components.
	eddy (const eddy &e)
	Copy construct.
label	patchFaceI () const noexcept
	Return the patch face index that spawned the eddy.
const point &	position0 () const noexcept
	Return the reference position.
scalar	x () const noexcept
	Return the distance from the reference position.
const vector &	sigma () const noexcept
	Return the length scales in 3-D space.
const vector &	alpha () const noexcept
	Return the time-averaged intensity.
const tensor &	Rpg () const noexcept
	Return the coordinate system transformation from local principal to global axes.
scalar	c1 () const noexcept
	Return the model coefficient c1.
point	position (const vector &n) const
	Return the eddy position.
label	dir1 () const noexcept
	Return the index of the streamwise direction (0,1,2).
vector	epsilon (Random &rndGen) const
	Return random vector of -1 and 1's.
scalar	volume () const
	Volume.
void	move (const scalar dx)
	Move the eddy.
boundBox	bounds (const bool global=true) const
	Eddy bounds.
vector	uPrime (const point &xp, const vector &n) const
	Return the fluctuating velocity contribution at local point xp.
void	writeCentreOBJ (const vector &n, Ostream &os) const
	Write the eddy centre in OBJ format.
label	writeSurfaceOBJ (const label pointOffset, const vector &n, Ostream &os) const
	Write the eddy surface in OBJ format.
void	operator= (const eddy &e)

Static Public Attributes
static int	debug = 0
	Flag to activate debug statements.

Friends
bool	operator== (const eddy &a, const eddy &b)
bool	operator!= (const eddy &a, const eddy &b)
Istream &	operator>> (Istream &is, eddy &e)
Ostream &	operator<< (Ostream &os, const eddy &e)

Detailed Description

Class to describe eddies for the turbulentDFSEMInletFvPatchVectorField boundary condition.

Source files

Definition at line 63 of file eddy.H.

Constructor & Destructor Documentation

◆ eddy() [1/4]

eddy ( )

Construct null.

Definition at line 110 of file eddy.C.

References Foam::I, and Foam::Zero.

Referenced by eddy(), operator!=, operator<<, operator=(), operator==, and operator>>.

Here is the caller graph for this function:

◆ eddy() [2/4]

eddy ( Istream & is )

Construct from Istream.

Definition at line 27 of file eddyIO.C.

References IOstream::check(), FUNCTION_NAME, and Foam::readLabel().

Here is the call graph for this function:

◆ eddy() [3/4]

eddy	(	const label	patchFaceI,
		const point &	position0,
		const scalar	x,
		const scalar	sigmaX,
		const symmTensor &	R,
		Random &	rndGen )

Construct from components.

Definition at line 123 of file eddy.C.

References Foam::cmptAv(), Foam::cmptMin(), Foam::cmptProduct(), debug, e, Foam::eigenValues(), Foam::eigenVectors(), Foam::endl(), epsilon, forAll, found, Foam::I, lambda(), patchFaceI(), position0(), Foam::Pout, R, rndGen, dimensioned< Type >::T(), WarningInFunction, x(), and Foam::Zero.

Here is the call graph for this function:

◆ eddy() [4/4]

eddy ( const eddy & e )

Copy construct.

Definition at line 209 of file eddy.C.

References e, and eddy().

Here is the call graph for this function:

Member Function Documentation

◆ patchFaceI()

Foam::label patchFaceI ( ) const

inlinenoexcept

Return the patch face index that spawned the eddy.

Definition at line 35 of file eddyI.H.

References Foam::noexcept.

Referenced by eddy().

Here is the caller graph for this function:

◆ position0()

const Foam::point & position0 ( ) const

inlinenoexcept

Return the reference position.

Definition at line 41 of file eddyI.H.

References Foam::noexcept.

Referenced by eddy().

Here is the caller graph for this function:

◆ x()

Foam::scalar x ( ) const

inlinenoexcept

Return the distance from the reference position.

Definition at line 47 of file eddyI.H.

References Foam::noexcept.

Referenced by eddy(), and writeSurfaceOBJ().

Here is the caller graph for this function:

◆ sigma()

const Foam::vector & sigma ( ) const

inlinenoexcept

Return the length scales in 3-D space.

Definition at line 53 of file eddyI.H.

References Foam::noexcept.

◆ alpha()

const Foam::vector & alpha ( ) const

inlinenoexcept

Return the time-averaged intensity.

Definition at line 59 of file eddyI.H.

References Foam::noexcept.

◆ Rpg()

const Foam::tensor & Rpg ( ) const

inlinenoexcept

Return the coordinate system transformation from local principal to global axes.

Definition at line 65 of file eddyI.H.

References Foam::noexcept.

◆ c1()

Foam::scalar c1 ( ) const

inlinenoexcept

Return the model coefficient c1.

Definition at line 71 of file eddyI.H.

References Foam::noexcept.

◆ position()

Foam::point position ( const vector & n ) const

inline

Return the eddy position.

Definition at line 77 of file eddyI.H.

References n.

Referenced by uPrime(), writeCentreOBJ(), and writeSurfaceOBJ().

Here is the caller graph for this function:

◆ dir1()

label dir1 ( ) const

inlinenoexcept

Return the index of the streamwise direction (0,1,2).

Definition at line 223 of file eddy.H.

References dir1(), and Foam::noexcept.

Referenced by dir1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ epsilon()

Foam::vector epsilon ( Random & rndGen ) const

inline

Return random vector of -1 and 1's.

Definition at line 83 of file eddyI.H.

References rndGen.

◆ volume()

Foam::scalar volume ( ) const

inline

Volume.

Definition at line 89 of file eddyI.H.

References Foam::cmptProduct(), and Foam::constant::mathematical::pi().

Here is the call graph for this function:

◆ move()

void move ( const scalar dx )

inline

Move the eddy.

Definition at line 95 of file eddyI.H.

◆ bounds()

Foam::boundBox bounds ( const bool global = true ) const

inline

Eddy bounds.

Definition at line 101 of file eddyI.H.

References boundBox::max(), and boundBox::min().

Here is the call graph for this function:

◆ uPrime()

Foam::vector uPrime	(	const point &	xp,
		const vector &	n ) const

Return the fluctuating velocity contribution at local point xp.

Definition at line 224 of file eddy.C.

References Foam::cmptDivide(), Foam::cmptMultiply(), Foam::mag(), n, VectorSpace< Form, Cmpt, Ncmpts >::one, position(), rp(), and VectorSpace< Form, Cmpt, Ncmpts >::zero.

Here is the call graph for this function:

◆ writeCentreOBJ()

void writeCentreOBJ	(	const vector &	n,
		Ostream &	os ) const

Write the eddy centre in OBJ format.

Definition at line 248 of file eddy.C.

References n, Foam::nl, os(), p, and position().

Here is the call graph for this function:

◆ writeSurfaceOBJ()

Foam::label writeSurfaceOBJ	(	const label	pointOffset,
		const vector &	n,
		Ostream &	os ) const

Write the eddy surface in OBJ format.

Returns the number of points used to describe the eddy surface

Definition at line 259 of file eddy.C.

References Foam::cos(), forAll, n, Foam::nl, os(), p, Foam::constant::mathematical::pi(), position(), s(), Foam::sin(), Foam::sqr(), Foam::sqrt(), Foam::constant::mathematical::twoPi(), x(), and Foam::Zero.

Here is the call graph for this function:

◆ operator=()

void operator= ( const eddy & e )

Definition at line 44 of file eddyIO.C.

References e, and eddy().

Here is the call graph for this function:

◆ operator==

bool operator==	(	const eddy &	a,
		const eddy &	b )

friend

Definition at line 284 of file eddy.H.

References b, and eddy().

◆ operator!=

bool operator!=	(	const eddy &	a,
		const eddy &	b )

friend

Definition at line 297 of file eddy.H.

References b, and eddy().

◆ operator>>

Istream & operator>>	(	Istream &	is,
		eddy &	e )

friend

References e, and eddy().

◆ operator<<

Ostream & operator<<	(	Ostream &	os,
		const eddy &	e )

friend

References e, eddy(), and os().

Member Data Documentation

◆ debug

int debug = 0

static

Flag to activate debug statements.

Definition at line 172 of file eddy.H.

Referenced by eddy(), and turbulentDFSEMInletFvPatchVectorField::turbulentDFSEMInletFvPatchVectorField().

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

src/finiteVolume/fields/fvPatchFields/derived/turbulentDFSEMInlet/eddy/eddy.H
src/finiteVolume/fields/fvPatchFields/derived/turbulentDFSEMInlet/eddy/eddy.C
src/finiteVolume/fields/fvPatchFields/derived/turbulentDFSEMInlet/eddy/eddyI.H
src/finiteVolume/fields/fvPatchFields/derived/turbulentDFSEMInlet/eddy/eddyIO.C

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ eddy() [1/4]

◆ eddy() [2/4]

◆ eddy() [3/4]

◆ eddy() [4/4]

Member Function Documentation

◆ patchFaceI()

◆ position0()

◆ x()

◆ sigma()

◆ alpha()

◆ Rpg()

◆ c1()

◆ position()

◆ dir1()

◆ epsilon()

◆ volume()

◆ move()

◆ bounds()

◆ uPrime()

◆ writeCentreOBJ()

◆ writeSurfaceOBJ()

◆ operator=()

Friends And Related Symbol Documentation

◆ operator==

◆ operator!=

◆ operator>>

◆ operator<<

Member Data Documentation

◆ debug