general Class Reference

Computes U+ as a function of Reynolds number by inverting table of y+ vs U+. More...

#include <general.H>

Inheritance diagram for general:

Collaboration diagram for general:

Public Types
enum	interpolationType { itLinear }
	Enumeration listing available interpolation types. More...

Public Member Functions
	TypeName ("general")
	Run-time type information.
	general (const dictionary &dict, const polyMesh &mesh)
virtual	~general ()
	Destructor.
virtual scalar	yPlus (const scalar uPlus) const
	Return y+ as a function of u+.
virtual scalar	Re (const scalar uPlus) const
	Return Reynolds number as a function of u+.
virtual void	writeData (Ostream &os) const
	Write to Ostream.
Public Member Functions inherited from tabulatedWallFunction
	TypeName ("tabulatedWallFunction")
	Run-time type information.
	declareRunTimeSelectionTable (autoPtr, tabulatedWallFunction, dictionary,(const dictionary &dict, const polyMesh &mesh),(dict, mesh))
	Declare runtime constructor selection table.
	tabulatedWallFunction (const dictionary &dict, const polyMesh &mesh, const word &name)
	Constructor.
virtual	~tabulatedWallFunction ()
	Destructor.
const word &	invertedTableName () const
	Return the inverted table name.
const uniformInterpolationTable< scalar > &	invertedTable () const
	Return the inverted table.
virtual void	write ()
	Write.

Static Public Attributes
static const Enum< interpolationType >	interpolationTypeNames_

Protected Member Functions
virtual void	invertTable ()
	Invert the table.
virtual scalar	interpolate (const scalar xi, const scalarList &x, const scalarList &fx) const
	Interpolate.

Protected Attributes
interpolationType	interpType_
	Type of interpolation to apply when inverting the data set.
bool	log10YPlus_
	Are y+ values entered as log10(y+)?
bool	log10UPlus_
	Are U+ values entered as log10(U+)?
List< scalar >	yPlus_
	Input y+ values.
List< scalar >	uPlus_
	Input U+ values.
Protected Attributes inherited from tabulatedWallFunction
const dictionary	dict_
	Main dictionary.
const polyMesh &	mesh_
	Reference to the mesh database.
const dictionary	coeffDict_
	Coefficients dictionary.
word	invertedTableName_
	Name of inverted table.
uniformInterpolationTable< scalar >	invertedTable_
	Inverted table.

Additional Inherited Members
Static Public Member Functions inherited from tabulatedWallFunction
static autoPtr< tabulatedWallFunction >	New (const dictionary &dict, const polyMesh &mesh)
	Selector.

Detailed Description

Computes U+ as a function of Reynolds number by inverting table of y+ vs U+.

Example dictionary specification:

    tabulatedWallFunction general;

    // Output table info
    tableName       uPlusWallFunctionData; // Output table name
    log10           yes;                // Re interpreted as log10(Rey)
    dx              0.2;                // Interval log10(Rey)
    x0              -3;                 // Minimum log10(Rey)
    xMax            7;                  // Maximum log10(Rey)

    generalCoeffs
    {
        interpType      linear;         // Interpolation method
        log10YPlus      true;           // y+ values defined as log10(y+)
        log10UPlus      true;           // U+ values defined as log10(y+)
        inputTable
        (
            (yPlusValue0    uPlusValue0)
            ...
            (yPlusValueN    uPlusValueN)
        );
    }

Source files

• general.H
• general.C

Definition at line 77 of file general.H.

Member Enumeration Documentation

interpolationType

enum interpolationType

Enumeration listing available interpolation types.

Enumerator
itLinear

Definition at line 88 of file general.H.

Constructor & Destructor Documentation

general()

general	(	const dictionary &	dict,
		const polyMesh &	mesh )

References dict, and mesh.

~general()

virtual ~general ( )

virtual

Destructor.

Member Function Documentation

invertTable()

virtual void invertTable ( )

protectedvirtual

Invert the table.

interpolate()

virtual scalar interpolate ( const scalar xi, const scalarList & x, const scalarList & fx ) const

protectedvirtual

Interpolate.

References x.

TypeName()

TypeName

(

"general"

)

Run-time type information.

yPlus()

virtual scalar yPlus ( const scalar uPlus ) const

virtual

Return y+ as a function of u+.

References uPlus.

Re()

virtual scalar Re ( const scalar uPlus ) const

virtual

Return Reynolds number as a function of u+.

References uPlus.

writeData()

virtual void writeData ( Ostream & os ) const

virtual

Write to Ostream.

References os().

Here is the call graph for this function:

Member Data Documentation

interpolationTypeNames_

const Enum<interpolationType> interpolationTypeNames_

static

Definition at line 93 of file general.H.

interpType_

interpolationType interpType_

protected

Type of interpolation to apply when inverting the data set.

Definition at line 103 of file general.H.

log10YPlus_

bool log10YPlus_

protected

Are y+ values entered as log10(y+)?

Definition at line 108 of file general.H.

log10UPlus_

bool log10UPlus_

protected

Are U+ values entered as log10(U+)?

Definition at line 113 of file general.H.

yPlus_

List<scalar> yPlus_

protected

Input y+ values.

Definition at line 118 of file general.H.

uPlus_

List<scalar> uPlus_

protected

Input U+ values.

Definition at line 123 of file general.H.

---

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

• applications/utilities/preProcessing/wallFunctionTable/tabulatedWallFunction/general/general.H