Public Member Functions | List of all members
turbulentBL Class Reference

Turbulent boundary-layer function pow(yHat, exponent) More...

Inheritance diagram for turbulentBL:
Inheritance graph
[legend]
Collaboration diagram for turbulentBL:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("turbulentBL")
 
 turbulentBL (const word &name, const dictionary &dict)
 Construct from name and dictionary. More...
 
virtual ~turbulentBL ()
 Destructor. More...
 
virtual scalar value (const scalar t) const
 Return value for time t. More...
 
virtual scalar integral (const scalar t1, const scalar t2) const
 Return the integral between times t1 and t2. More...
 
virtual void write (Ostream &os) const
 Write data to dictionary stream. More...
 
void operator= (const turbulentBL &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from FieldFunction1< scalar, turbulentBL >
 FieldFunction1 (const word &name)
 Construct from name. More...
 
virtual tmp< Function1< scalar > > clone () const
 Construct and return a clone. More...
 
virtual ~FieldFunction1 ()
 Destructor. More...
 
virtual tmp< Field< scalar > > value (const scalarField &x) const
 Return value as a function of one scalar field. More...
 
virtual tmp< Field< scalar > > integral (const scalarField &x1, const scalarField &x2) const
 Integrate between two scalar fields. More...
 
- Public Member Functions inherited from Function1< Type >
 TypeName ("Function1")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, Function1, dictionary,(const word &name, const dictionary &dict),(name, dict))
 Declare runtime constructor selection table. More...
 
 Function1 (const word &name)
 Construct from name. More...
 
 Function1 (const Function1< Type > &f1)
 Copy constructor. More...
 
virtual ~Function1 ()
 Destructor. More...
 
const word & name () const
 Return the name of the entry. More...
 
void operator= (const Function1< Type > &)
 Assignment. More...
 
- Public Member Functions inherited from refCount
int count () const
 Return the current reference count. More...
 
bool unique () const
 Return true if the reference count is zero. More...
 
void operator++ ()
 Increment the reference count. More...
 
void operator++ (int)
 Increment the reference count. More...
 
void operator-- ()
 Decrement the reference count. More...
 
void operator-- (int)
 Decrement the reference count. More...
 

Additional Inherited Members

- Public Types inherited from Function1< Type >
typedef Type returnType
 
- Static Public Member Functions inherited from Function1< Type >
static autoPtr< Function1< Type > > New (const word &name, const dictionary &dict)
 Selector. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
- Protected Attributes inherited from Function1< Type >
const word name_
 Name of entry. More...
 

Detailed Description

Turbulent boundary-layer function pow(yHat, exponent)

where yHat is the normalised distance to the wall and the optional exponent defaults to 1/7.

Usage: 

    <name> turbulentBL;

or 

    <name>
    {
        type      turbulentBL;
        exponent  0.143;
    }
See also
Foam::Function1 Foam::Function1s::laminarBL
Source files

Definition at line 70 of file turbulentBL.H.

Constructor & Destructor Documentation

◆ turbulentBL()

turbulentBL ( const word &  name,
const dictionary &  dict 
)

Construct from name and dictionary.

Definition at line 49 of file turbulentBL.C.

References dict.

◆ ~turbulentBL()

~turbulentBL ( )
virtual

Destructor.

Definition at line 63 of file turbulentBL.C.

Member Function Documentation

◆ TypeName()

TypeName ( "turbulentBL"  )

◆ value()

Foam::scalar value ( const scalar  t) const
inlinevirtual

Return value for time t.

Implements FieldFunction1< scalar, turbulentBL >.

Definition at line 30 of file turbulentBLI.H.

References Foam::pow().

Here is the call graph for this function:

◆ integral()

Foam::scalar integral ( const scalar  t1,
const scalar  t2 
) const
inlinevirtual

Return the integral between times t1 and t2.

Implements FieldFunction1< scalar, turbulentBL >.

Definition at line 36 of file turbulentBLI.H.

References Foam::patchToPatchTools::NaN(), and NotImplemented.

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write data to dictionary stream.

Implements Function1< Type >.

Definition at line 69 of file turbulentBL.C.

References Foam::Function1s::writeEntry().

Here is the call graph for this function:

◆ operator=()

void operator= ( const turbulentBL &  )
delete

Disallow default bitwise assignment.

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