Disk momentum source which approximates a propeller based on a given propeller curve. More...

Inheritance diagram for propellerDisk:

Collaboration diagram for propellerDisk:

[legend]

Public Member Functions
	TypeName ("propellerDisk")
	Runtime type information. More...

	propellerDisk (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from components. More...

	propellerDisk (const propellerDisk &)=delete
	Disallow default bitwise copy construction. More...

virtual	~propellerDisk ()
	Destructor. More...

virtual wordList	addSupFields () const
	Return the list of fields for which the fvModel adds source term. More...

virtual void	addSup (const volVectorField &U, fvMatrix< vector > &eqn) const
	Source term to momentum equation. More...

virtual void	addSup (const volScalarField &rho, const volVectorField &U, fvMatrix< vector > &eqn) const
	Source term to compressible momentum equation. More...

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, const volVectorField &U, fvMatrix< vector > &eqn) const
	Explicit and implicit sources for phase equations. More...

virtual bool	movePoints ()
	Update for mesh motion. More...

virtual void	topoChange (const polyTopoChangeMap &)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

virtual bool	read (const dictionary &dict)
	Read dictionary. More...

void	operator= (const propellerDisk &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from fvModel
	TypeName ("fvModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, fvModel, dictionary,(const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict),(name, modelType, mesh, dict))

	fvModel (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from components. More...

autoPtr< fvModel >	clone () const
	Return clone. More...

virtual	~fvModel ()
	Destructor. More...

const word &	name () const
	Return const access to the source name. More...

const fvMesh &	mesh () const
	Return const access to the mesh database. More...

const dictionary &	coeffs () const
	Return dictionary. More...

virtual bool	addsSupToField (const word &fieldName) const
	Return true if the fvModel adds a source term to the given. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

virtual void	addSup (fvMatrix< scalar > &eqn) const
	Add a source term to a field-less proxy equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const VolField< Type > &eqnField) const
	Add a source term to an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const VolField< Type > &field) const
	Return source for an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field) const
	Return source for a compressible equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for a compressible equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	d2dt2 (const VolField< Type > &field) const
	Return source for an equation with a second time derivative. More...

virtual void	preUpdateMesh ()
	Prepare for mesh update. More...

virtual void	correct ()
	Correct the fvModel. More...

virtual bool	write (const bool write=true) const
	Write fvModel data. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::dimensionSet	sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
const Foam::word &	fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)

template<class AlphaRhoFieldType >
const Foam::word &	fieldName (const AlphaRhoFieldType &alphaRhoField)

template<class Type , class ... AlphaRhoFieldTypes>
Foam::tmp< Foam::fvMatrix< Type > >	sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	d2dt2 (const VolField< Type > &field) const

Protected Member Functions
virtual scalar	n () const
	Return the rotation speed. More...

virtual void	correctn (const scalar T) const
	No rotation speed correction. More...

vector	diskCentre () const
	Computes the disk centre. More...

scalar	diskThickness (const vector &centre) const
	Computes the thickness of the disk in streamwise direction. More...

scalar	J (const vectorField &U, const vector &nHat) const
	Return the normalised flow-rate through the disk. More...

Protected Member Functions inherited from fvModel
template<class Type >
void	addSupType (const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to an equation. More...

template<class Type >
void	addSupType (const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a compressible equation. More...

template<class Type >
void	addSupType (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a phase equation. More...

template<class Type , class ... AlphaRhoFieldTypes>
tmp< fvMatrix< Type > >	sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const
	Return a source for an equation. More...

Protected Attributes
fvCellSet	set_
	The set of cells the fvConstraint applies to. More...

word	phaseName_
	The name of the phase to which this fvModel applies. More...

word	UName_
	Name of the velocity field. More...

vector	diskNormal_
	Disk normal direction. More...

scalar	n_
	Rotation speed [1/s]. More...

scalar	rotationDir_
	Rotation direction (obtained from the sign of n_) More...

scalar	dProp_
	Propeller diameter. More...

scalar	dHub_
	Hub diameter. More...

autoPtr< Function1< vector2D > >	propellerFunction_
	Propeller function. More...

Switch	log_
	Optional switch to enable logging of integral properties. More...

autoPtr< functionObjects::logFile >	logFile_
	Optional log file. More...

Additional Inherited Members
Static Public Member Functions inherited from fvModel
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static dimensionSet	sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
	Return the dimensions of the matrix of a source term. More...

static const dimensionSet &	sourceDims (const dimensionSet &ds)
	Return the dimensions of the matrix of a source term (base. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static const word &	fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
	Return the name of the field associated with a source term. More...

template<class AlphaRhoFieldType >
static const word &	fieldName (const AlphaRhoFieldType &alphaRhoField)
	Return the name of the field associated with a source term (base. More...

static const word &	fieldName ()
	Return the name of the field associated with a source term. Special. More...

static autoPtr< fvModel >	New (const word &name, const fvMesh &mesh, const dictionary &dict)
	Return a reference to the selected fvModel. More...

Detailed Description

Disk momentum source which approximates a propeller based on a given propeller curve.

Reference:

    Hough, G. R., & Ordway, D. E. (1964).
    The generalized actuator disk.
    Developments in theoretical and applied mechanics, 2, 317-336.

Usage

Example usage:

diskSource
{
    type            propellerDisk;

    selectionMode   cellZone;
    cellZone        propeller;

    diskNormal      (1 0 0);    // Normal direction of the disk

    n               26.03;      // Rotation speed [1/s]

    dPropeller      0.203;      // Propeller diameter
    dHub            0.039179;   // Hub diameter

    propellerCurve
    {
        type table;

        //   J     Kt     Kq
        values
        (
            (0.10 (0.3267 0.03748))
            (0.15 (0.3112 0.03629))
            (0.20 (0.2949 0.03500))
            (0.25 (0.2777 0.03361))
            (0.30 (0.2598 0.03210))
            (0.35 (0.2410 0.03047))
            (0.40 (0.2214 0.02871))
            (0.45 (0.2010 0.02682))
            (0.50 (0.1798 0.02479))
            (0.55 (0.1577 0.02261))
            (0.60 (0.1349 0.02027))
            (0.65 (0.1112 0.01777))
            (0.70 (0.0867 0.01509))
            (0.75 (0.0614 0.01224))
            (0.80 (0.0353 0.00921))
        );
    }
}

Source files

Definition at line 109 of file propellerDisk.H.

Constructor & Destructor Documentation

◆ propellerDisk() [1/2]

propellerDisk	(	const word &	name,
		const word &	modelType,
		const fvMesh &	mesh,
		const dictionary &	dict
	)

Construct from components.

Definition at line 140 of file propellerDisk.C.

References fvModel::coeffs().

Here is the call graph for this function:

◆ propellerDisk() [2/2]

propellerDisk ( const propellerDisk & )

delete

Disallow default bitwise copy construction.

◆ ~propellerDisk()

virtual ~propellerDisk ( )

inlinevirtual

Destructor.

Definition at line 213 of file propellerDisk.H.

Member Function Documentation

◆ n()

virtual scalar n ( ) const

inlineprotectedvirtual

Return the rotation speed.

Definition at line 154 of file propellerDisk.H.

References propellerDisk::n_.

◆ correctn()

virtual void correctn ( const scalar T ) const

inlineprotectedvirtual

No rotation speed correction.

Definition at line 160 of file propellerDisk.H.

◆ diskCentre()

Foam::vector diskCentre ( ) const

protected

Computes the disk centre.

Definition at line 98 of file propellerDisk.C.

References Foam::gSum().

Here is the call graph for this function:

◆ diskThickness()

Foam::scalar diskThickness ( const vector & centre ) const

protected

Computes the thickness of the disk in streamwise direction.

Definition at line 107 of file propellerDisk.C.

References Foam::gMax(), Foam::magSqr(), and Foam::constant::mathematical::pi().

Here is the call graph for this function:

◆ J()

Foam::scalar J	(	const vectorField &	U,
		const vector &	nHat
	)		const

protected

Return the normalised flow-rate through the disk.

Definition at line 116 of file propellerDisk.C.

References cells, forAll, Foam::mag(), Foam::reduce(), and U.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "propellerDisk" )

Runtime type information.

◆ addSupFields()

Foam::wordList addSupFields ( ) const

virtual

Return the list of fields for which the fvModel adds source term.

to the transport equation

Reimplemented from fvModel.

Definition at line 175 of file propellerDisk.C.

◆ addSup() [1/3]

void addSup	(	const volVectorField &	U,
		fvMatrix< vector > &	eqn
	)		const

virtual

Source term to momentum equation.

Definition at line 199 of file propellerDisk.C.

References fvMatrix< Type >::source(), and U.

Here is the call graph for this function:

◆ addSup() [2/3]

void addSup	(	const volScalarField &	rho,
		const volVectorField &	U,
		fvMatrix< vector > &	eqn
	)		const

virtual

Source term to compressible momentum equation.

Definition at line 215 of file propellerDisk.C.

References rho, fvMatrix< Type >::source(), and U.

Here is the call graph for this function:

◆ addSup() [3/3]

void addSup	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		const volVectorField &	U,
		fvMatrix< vector > &	eqn
	)		const

virtual

Explicit and implicit sources for phase equations.

Definition at line 181 of file propellerDisk.C.

References alpha(), rho, fvMatrix< Type >::source(), and U.

Here is the call graph for this function:

◆ movePoints()

bool movePoints ( )

virtual

Update for mesh motion.

Implements fvModel.

Definition at line 232 of file propellerDisk.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Implements fvModel.

Definition at line 239 of file propellerDisk.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Implements fvModel.

Definition at line 245 of file propellerDisk.C.

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Implements fvModel.

Definition at line 251 of file propellerDisk.C.

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from fvModel.

Definition at line 160 of file propellerDisk.C.

References dict, and fvModel::read().

Here is the call graph for this function:

◆ operator=()

void operator= ( const propellerDisk & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ set_

fvCellSet set_

protected

The set of cells the fvConstraint applies to.

Definition at line 118 of file propellerDisk.H.

◆ phaseName_

word phaseName_

protected

The name of the phase to which this fvModel applies.

Definition at line 121 of file propellerDisk.H.

◆ UName_

word UName_

protected

Name of the velocity field.

Definition at line 124 of file propellerDisk.H.

◆ diskNormal_

vector diskNormal_

protected

Disk normal direction.

Definition at line 127 of file propellerDisk.H.

◆ n_

scalar n_

protected

Rotation speed [1/s].

Definition at line 130 of file propellerDisk.H.

Referenced by propellerDisk::n().

◆ rotationDir_

scalar rotationDir_

protected

Rotation direction (obtained from the sign of n_)

Definition at line 133 of file propellerDisk.H.

◆ dProp_

scalar dProp_

protected

Propeller diameter.

Definition at line 136 of file propellerDisk.H.

◆ dHub_

scalar dHub_

protected

Hub diameter.

Definition at line 139 of file propellerDisk.H.

◆ propellerFunction_

autoPtr<Function1<vector2D> > propellerFunction_

protected

Propeller function.

Definition at line 142 of file propellerDisk.H.

◆ log_

Switch log_

protected

Optional switch to enable logging of integral properties.

Definition at line 145 of file propellerDisk.H.

◆ logFile_

autoPtr<functionObjects::logFile> logFile_

mutableprotected

Optional log file.

Definition at line 148 of file propellerDisk.H.

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

src/fvModels/propellerDisk/propellerDisk.H
src/fvModels/propellerDisk/propellerDisk.C
src/fvModels/propellerDisk/propellerDiskTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ propellerDisk() [1/2]

◆ propellerDisk() [2/2]

◆ ~propellerDisk()

Member Function Documentation

◆ n()

◆ correctn()

◆ diskCentre()

◆ diskThickness()

◆ J()

◆ TypeName()

◆ addSupFields()

◆ addSup() [1/3]

◆ addSup() [2/3]

◆ addSup() [3/3]

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ read()

◆ operator=()

Member Data Documentation

◆ set_

◆ phaseName_

◆ UName_

◆ diskNormal_

◆ n_

◆ rotationDir_

◆ dProp_

◆ dHub_

◆ propellerFunction_

◆ log_

◆ logFile_