Public Member Functions | Static Public Attributes | Friends | List of all members
eddy Class Reference

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

Public Member Functions

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

Static Public Attributes

static int debug = 0
 Flag to activate debug statements. More...
 

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.

◆ eddy() [2/4]

eddy ( Istream &  is)

Construct from Istream.

Definition at line 27 of file eddyIO.C.

References IOstream::check(), and FUNCTION_NAME.

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 124 of file eddy.C.

References Foam::cmptAv(), Foam::cmptMin(), Foam::cmptProduct(), Foam::ensightOutput::debug, Foam::constant::electromagnetic::e, Foam::eigenValues(), Foam::eigenVectors(), Foam::endl(), epsilon, forAll, found, lambda(), Foam::Pout, R, rndGen, Random::shuffle(), dimensioned< Type >::T(), and WarningInFunction.

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.

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.

◆ position0()

const Foam::point & position0 ( ) const
inlinenoexcept

Return the reference position.

Definition at line 41 of file eddyI.H.

◆ x()

Foam::scalar x ( ) const
inlinenoexcept

Return the distance from the reference position.

Definition at line 47 of file eddyI.H.

◆ sigma()

const Foam::vector & sigma ( ) const
inlinenoexcept

Return the length scales in 3-D space.

Definition at line 53 of file eddyI.H.

◆ alpha()

const Foam::vector & alpha ( ) const
inlinenoexcept

Return the time-averaged intensity.

Definition at line 59 of file eddyI.H.

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

◆ c1()

Foam::scalar c1 ( ) const
inlinenoexcept

Return the model coefficient c1.

Definition at line 71 of file eddyI.H.

◆ position()

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

Return the eddy position.

Definition at line 77 of file eddyI.H.

References n.

◆ dir1()

label dir1 ( ) const
inlinenoexcept

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

Definition at line 223 of file eddy.H.

◆ 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, and rp().

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 249 of file eddy.C.

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

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 260 of file eddy.C.

References Foam::cos(), forAll, n, Foam::nl, os(), p, Foam::constant::mathematical::pi(), 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 Foam::constant::electromagnetic::e.

Friends And Related Function Documentation

◆ operator==

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

Definition at line 284 of file eddy.H.

◆ operator!=

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

Definition at line 297 of file eddy.H.

◆ operator>>

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

◆ operator<<

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

Member Data Documentation

◆ debug

int debug = 0
static

Flag to activate debug statements.

Definition at line 172 of file eddy.H.

Referenced by turbulentDFSEMInletFvPatchVectorField::turbulentDFSEMInletFvPatchVectorField().

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