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 ()
 
 eddy (Istream &is)
 
 eddy (const label patchFaceI, const point &position0, const scalar x, const scalar sigmaX, const symmTensor &R, Random &rndGen)
 
 eddy (const eddy &e)
 
label patchFaceI () const noexcept
 
const pointposition0 () const noexcept
 
scalar x () const noexcept
 
const vectorsigma () const noexcept
 
const vectoralpha () const noexcept
 
const tensorRpg () const noexcept
 
scalar c1 () const noexcept
 
point position (const vector &n) const
 
label dir1 () const
 
vector epsilon (Random &rndGen) const
 
scalar volume () const
 
void move (const scalar dx)
 
boundBox bounds (const bool global=true) const
 
vector uPrime (const point &xp, const vector &n) const
 
void writeCentreOBJ (const vector &n, Ostream &os) const
 
label writeSurfaceOBJ (const label pointOffset, const vector &n, Ostream &os) const
 
void operator= (const eddy &e)
 

Static Public Attributes

static int debug = 0
 

Friends

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

Detailed Description

Class to describe eddies for the turbulentDFSEMInletFvPatchVectorField boundary condition.

Source files

Definition at line 65 of file eddy.H.

Constructor & Destructor Documentation

◆ eddy() [1/4]

eddy ( )

Definition at line 109 of file eddy.C.

◆ eddy() [2/4]

eddy ( Istream is)

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 
)

◆ eddy() [4/4]

eddy ( const eddy e)

Definition at line 208 of file eddy.C.

Member Function Documentation

◆ patchFaceI()

Foam::label patchFaceI ( ) const
inlinenoexcept

Definition at line 35 of file eddyI.H.

◆ position0()

const Foam::point & position0 ( ) const
inlinenoexcept

Definition at line 41 of file eddyI.H.

◆ x()

Foam::scalar x ( ) const
inlinenoexcept

Definition at line 47 of file eddyI.H.

◆ sigma()

const Foam::vector & sigma ( ) const
inlinenoexcept

Definition at line 53 of file eddyI.H.

◆ alpha()

const Foam::vector & alpha ( ) const
inlinenoexcept

Definition at line 59 of file eddyI.H.

◆ Rpg()

const Foam::tensor & Rpg ( ) const
inlinenoexcept

Definition at line 65 of file eddyI.H.

◆ c1()

Foam::scalar c1 ( ) const
inlinenoexcept

Definition at line 71 of file eddyI.H.

◆ position()

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

Definition at line 77 of file eddyI.H.

References n.

◆ dir1()

label dir1 ( ) const
inline

◆ epsilon()

Foam::vector epsilon ( Random rndGen) const
inline

Definition at line 83 of file eddyI.H.

References rndGen.

◆ volume()

Foam::scalar volume ( ) const
inline

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

Definition at line 95 of file eddyI.H.

◆ bounds()

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

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

◆ writeCentreOBJ()

void writeCentreOBJ ( const vector n,
Ostream os 
) const

Definition at line 248 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

◆ 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 222 of file eddy.H.

◆ operator!=

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

Definition at line 235 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

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