Public Member Functions | Static Public Attributes | List of all members
IntegralScaleBox< Type > Class Template Reference

Class to describe the integral-scale container being used in the turbulentDigitalFilterInletFvPatchField boundary condition. More...

Public Member Functions

 IntegralScaleBox (const fvPatch &p)
 Construct from patch. More...
 
 IntegralScaleBox (const fvPatch &p, const IntegralScaleBox &b)
 Copy construct with patch. More...
 
 IntegralScaleBox (const fvPatch &p, const dictionary &dict)
 Construct from patch and dictionary. More...
 
 IntegralScaleBox (const IntegralScaleBox &b)
 Copy construct. More...
 
const primitivePatch & patch ()
 Return const reference to integral-scale box inlet patch. More...
 
bool fsm () const noexcept
 Return the object: fsm. More...
 
void initialise ()
 Initialise integral-scale box properties. More...
 
void shift ()
 
void refill ()
 Add a new integral-scale box slice to the rear of the box. More...
 
Field< Type > convolve () const
 Embed two-point correlations, i.e. L. More...
 
void correlate (scalarField &fld)
 Apply forward-stepwise correlation for scalar fields. More...
 
void correlate (vectorField &fld)
 Apply forward-stepwise correlation for vector fields. More...
 
void write (Ostream &) const
 Write integral-scale box settings. More...
 

Static Public Attributes

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

Detailed Description

template<class Type>
class Foam::turbulence::IntegralScaleBox< Type >

Class to describe the integral-scale container being used in the turbulentDigitalFilterInletFvPatchField boundary condition.

Source files

Definition at line 57 of file IntegralScaleBox.H.

Constructor & Destructor Documentation

◆ IntegralScaleBox() [1/4]

IntegralScaleBox ( const fvPatch &  p)
explicit

Construct from patch.

Definition at line 491 of file IntegralScaleBox.C.

◆ IntegralScaleBox() [2/4]

IntegralScaleBox ( const fvPatch &  p,
const IntegralScaleBox< Type > &  b 
)

Copy construct with patch.

Definition at line 519 of file IntegralScaleBox.C.

◆ IntegralScaleBox() [3/4]

IntegralScaleBox ( const fvPatch &  p,
const dictionary &  dict 
)

Construct from patch and dictionary.

Definition at line 548 of file IntegralScaleBox.C.

References Foam::cmptMin(), dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::min(), Foam::nl, Vector2D< Cmpt >::x(), and Vector2D< Cmpt >::y().

Here is the call graph for this function:

◆ IntegralScaleBox() [4/4]

IntegralScaleBox ( const IntegralScaleBox< Type > &  b)

Copy construct.

Definition at line 601 of file IntegralScaleBox.C.

Member Function Documentation

◆ patch()

const primitivePatch & patch ( )
inline

Return const reference to integral-scale box inlet patch.

Definition at line 239 of file IntegralScaleBox.H.

◆ fsm()

bool fsm ( ) const
inlinenoexcept

Return the object: fsm.

Definition at line 250 of file IntegralScaleBox.H.

◆ initialise()

void initialise

Initialise integral-scale box properties.

Avoid constructor level evaluations

Definition at line 631 of file IntegralScaleBox.C.

References Foam::endl(), Foam::Info, Foam::nl, Vector2D< Cmpt >::x(), Vector2D< Cmpt >::y(), and Foam::Zero.

Here is the call graph for this function:

◆ shift()

void shift

Discard current time-step integral-scale box slice (the closest to the patch) by shifting from the back to the front

Definition at line 681 of file IntegralScaleBox.C.

References Foam::inplaceRotateList().

Here is the call graph for this function:

◆ refill()

void refill

Add a new integral-scale box slice to the rear of the box.

Definition at line 700 of file IntegralScaleBox.C.

◆ convolve()

Foam::Field< Type > convolve

Embed two-point correlations, i.e. L.

Apply three-dimensional "valid"-type separable convolution summation algorithm

Definition at line 721 of file IntegralScaleBox.C.

References k, p, Field< Type >::replace(), UList< T >::size(), Foam::sum(), and Foam::Zero.

Here is the call graph for this function:

◆ correlate() [1/2]

void correlate ( scalarField &  fld)

Apply forward-stepwise correlation for scalar fields.

Definition at line 848 of file IntegralScaleBox.C.

References fld().

Here is the call graph for this function:

◆ correlate() [2/2]

void correlate ( vectorField &  fld)

Apply forward-stepwise correlation for vector fields.

Definition at line 864 of file IntegralScaleBox.C.

References fld().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const

Write integral-scale box settings.

Definition at line 886 of file IntegralScaleBox.C.

References os().

Here is the call graph for this function:

Member Data Documentation

◆ debug

int debug = 0
static

Flag to activate debug statements.

Definition at line 231 of file IntegralScaleBox.H.

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