Loading...
Searching...
No Matches
IntegralScaleBox< Type > Class Template Reference

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

#include <IntegralScaleBox.H>

Public Member Functions

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

Static Public Attributes

static int debug = 0
 Flag to activate debug statements.

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 53 of file IntegralScaleBox.H.

Constructor & Destructor Documentation

◆ IntegralScaleBox() [1/4]

template<class Type>
IntegralScaleBox ( const fvPatch & p)
explicit

Construct from patch.

Definition at line 474 of file IntegralScaleBox.C.

References p, and Foam::Zero.

Referenced by IntegralScaleBox(), and IntegralScaleBox().

Here is the caller graph for this function:

◆ IntegralScaleBox() [2/4]

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

Copy construct with patch.

Definition at line 502 of file IntegralScaleBox.C.

References b, IntegralScaleBox(), and p.

Here is the call graph for this function:

◆ IntegralScaleBox() [3/4]

template<class Type>
IntegralScaleBox ( const fvPatch & p,
const dictionary & dict )

Construct from patch and dictionary.

Definition at line 531 of file IntegralScaleBox.C.

References Foam::cmptMin(), dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::min(), Foam::nl, p, and Foam::Zero.

Here is the call graph for this function:

◆ IntegralScaleBox() [4/4]

template<class Type>
IntegralScaleBox ( const IntegralScaleBox< Type > & b)

Copy construct.

Definition at line 584 of file IntegralScaleBox.C.

References b, and IntegralScaleBox().

Here is the call graph for this function:

Member Function Documentation

◆ patch()

template<class Type>
const primitivePatch & patch ( )
inline

Return const reference to integral-scale box inlet patch.

Definition at line 327 of file IntegralScaleBox.H.

◆ fsm()

template<class Type>
bool fsm ( ) const
inlinenoexcept

Return the object: fsm.

Definition at line 340 of file IntegralScaleBox.H.

References Foam::noexcept.

◆ initialise()

template<class Type>
void initialise ( )

Initialise integral-scale box properties.

Avoid constructor level evaluations

Definition at line 614 of file IntegralScaleBox.C.

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

Here is the call graph for this function:

◆ shift()

template<class Type>
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 664 of file IntegralScaleBox.C.

References Foam::inplaceRotateList().

Here is the call graph for this function:

◆ refill()

template<class Type>
void refill ( )

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

Definition at line 683 of file IntegralScaleBox.C.

◆ convolve()

template<class Type>
Foam::Field< Type > convolve ( ) const

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

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

Definition at line 704 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]

template<class Type>
void correlate ( scalarField & fld)

Apply forward-stepwise correlation for scalar fields.

Definition at line 831 of file IntegralScaleBox.C.

References fld().

Here is the call graph for this function:

◆ correlate() [2/2]

template<class Type>
void correlate ( vectorField & fld)

Apply forward-stepwise correlation for vector fields.

Definition at line 847 of file IntegralScaleBox.C.

References fld().

Here is the call graph for this function:

◆ write()

template<class Type>
void write ( Ostream & os) const

Write integral-scale box settings.

Definition at line 869 of file IntegralScaleBox.C.

References os().

Here is the call graph for this function:

Member Data Documentation

◆ debug

template<class Type>
int debug = 0
static

Flag to activate debug statements.

Definition at line 317 of file IntegralScaleBox.H.

Referenced by initialise(), and turbulentDigitalFilterInletFvPatchField< Type >::turbulentDigitalFilterInletFvPatchField().

The documentation for this class was generated from the following files:
  • src/finiteVolume/fields/fvPatchFields/derived/turbulentDigitalFilterInlet/IntegralScaleBox/IntegralScaleBox.H
  • src/finiteVolume/fields/fvPatchFields/derived/turbulentDigitalFilterInlet/IntegralScaleBox/IntegralScaleBox.C