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 vector	centre () const
	Return the propeller centre. More...

vector	force () const
	Return the current force of the fluid on the propeller. More...

vector	moment () const
	Return the current moment of the fluid on the propeller. 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 word &	keyword () const
	Return name as the keyword. More...

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

const dictionary &	coeffs (const dictionary &) const
	Return the coefficients sub-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 void	readCoeffs (const dictionary &dict)
	Read the model coefficients. More...

virtual vector	normal () const
	Return the propeller normal. More...

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

virtual void	correctn (const scalar T) const
	No rotation speed correction. 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
fvCellZone	zone_
	The cellZone 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	centre_
	Propeller disk centre. More...

vector	normal_
	Propeller 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...

autoPtr< volVectorField::Internal >	forcePtr_

vector	force_
	Current force of the fluid on the propeller. More...

vector	moment_
	Current moment of the fluid on the propeller. 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
static const dictionary &	coeffs (const word &modelType, const dictionary &)
	Return the coefficients sub-dictionary for a given model type. More...

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...

Static Public Attributes inherited from fvModel
static const wordHashSet	keywords
	The keywords read by this class. 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;

    libs            ("libpropellerDisk.so");

    cellZone        propeller;

    normal          (1 0 0);    // Normal direction of the propeller

    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 110 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 141 of file propellerDisk.C.

References fvModel::coeffs(), dict, and propellerDisk::readCoeffs().

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 228 of file propellerDisk.H.

Member Function Documentation

◆ readCoeffs()

void readCoeffs ( const dictionary & dict )

protectedvirtual

Read the model coefficients.

Reimplemented in rigidBodyPropellerDisk.

Definition at line 48 of file propellerDisk.C.

References propellerDisk::centre_, propellerDisk::dHub_, dict, Foam::dimless, propellerDisk::dProp_, IOobject::groupName(), Foam::gSum(), propellerDisk::log_, propellerDisk::logFile_, Foam::mag(), UPstream::master(), fvModel::mesh(), propellerDisk::n_, fvModel::name(), Function1< Type >::New(), propellerDisk::normal_, Foam::normalised(), word::null, propellerDisk::phaseName_, propellerDisk::propellerFunction_, propellerDisk::rotationDir_, Foam::sign(), propellerDisk::UName_, fvCellZone::V(), generatedCellZone::zone(), and propellerDisk::zone_.

Referenced by propellerDisk::propellerDisk(), and rigidBodyPropellerDisk::readCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ normal()

virtual vector normal ( ) const

inlineprotectedvirtual

Return the propeller normal.

Reimplemented in rigidBodyPropellerDisk.

Definition at line 169 of file propellerDisk.H.

References propellerDisk::normal_.

◆ n()

virtual scalar n ( ) const

inlineprotectedvirtual

Return the rotation speed.

Definition at line 175 of file propellerDisk.H.

References propellerDisk::n_.

◆ correctn()

virtual void correctn ( const scalar T ) const

inlineprotectedvirtual

No rotation speed correction.

Definition at line 181 of file propellerDisk.H.

◆ diskThickness()

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

protected

Computes the thickness of the disk in streamwise direction.

Definition at line 108 of file propellerDisk.C.

References Foam::gMax(), Foam::magSqr(), mesh, 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 117 of file propellerDisk.C.

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

Here is the call graph for this function:

◆ TypeName()

TypeName ( "propellerDisk" )

Runtime type information.

◆ centre()

virtual vector centre ( ) const

inlinevirtual

Return the propeller centre.

Reimplemented in rigidBodyPropellerDisk.

Definition at line 235 of file propellerDisk.H.

References propellerDisk::centre_.

◆ force()

vector force ( ) const

inline

Return the current force of the fluid on the propeller.

Definition at line 241 of file propellerDisk.H.

References propellerDisk::force_.

Referenced by propellerDiskForce::restrain().

Here is the caller graph for this function:

◆ moment()

vector moment ( ) const

inline

Return the current moment of the fluid on the propeller.

Definition at line 247 of file propellerDisk.H.

References propellerDisk::moment_.

Referenced by propellerDiskForce::restrain().

Here is the caller graph for this function:

◆ 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 178 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 202 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 218 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 184 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 235 of file propellerDisk.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Implements fvModel.

Definition at line 242 of file propellerDisk.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Implements fvModel.

Definition at line 248 of file propellerDisk.C.

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Implements fvModel.

Definition at line 254 of file propellerDisk.C.

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from fvModel.

Definition at line 163 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

◆ zone_

fvCellZone zone_

protected

The cellZone the fvConstraint applies to.

Definition at line 119 of file propellerDisk.H.

Referenced by propellerDisk::readCoeffs().

◆ phaseName_

word phaseName_

protected

The name of the phase to which this fvModel applies.

Definition at line 122 of file propellerDisk.H.

Referenced by propellerDisk::readCoeffs().

◆ UName_

word UName_

protected

Name of the velocity field.

Definition at line 125 of file propellerDisk.H.

Referenced by propellerDisk::readCoeffs().

◆ centre_

vector centre_

protected

Propeller disk centre.

Definition at line 128 of file propellerDisk.H.

Referenced by propellerDisk::centre(), and propellerDisk::readCoeffs().

◆ normal_

vector normal_

protected

Propeller disk normal direction.

Definition at line 131 of file propellerDisk.H.

Referenced by propellerDisk::normal(), and propellerDisk::readCoeffs().

◆ n_

scalar n_

protected

Rotation speed [1/s].

Definition at line 134 of file propellerDisk.H.

Referenced by propellerDisk::n(), and propellerDisk::readCoeffs().

◆ rotationDir_

scalar rotationDir_

protected

Rotation direction (obtained from the sign of n_)

Definition at line 137 of file propellerDisk.H.

Referenced by propellerDisk::readCoeffs().

◆ dProp_

scalar dProp_

protected

Propeller diameter.

Definition at line 140 of file propellerDisk.H.

Referenced by propellerDisk::readCoeffs().

◆ dHub_

scalar dHub_

protected

Hub diameter.

Definition at line 143 of file propellerDisk.H.

Referenced by propellerDisk::readCoeffs().

◆ propellerFunction_

autoPtr<Function1<vector2D> > propellerFunction_

protected

Propeller function.

Definition at line 146 of file propellerDisk.H.

Referenced by propellerDisk::readCoeffs().

◆ forcePtr_

autoPtr<volVectorField::Internal> forcePtr_

mutableprotected

Definition at line 148 of file propellerDisk.H.

◆ force_

vector force_

mutableprotected

Current force of the fluid on the propeller.

Definition at line 151 of file propellerDisk.H.

Referenced by propellerDisk::force().

◆ moment_

vector moment_

mutableprotected

Current moment of the fluid on the propeller.

Definition at line 154 of file propellerDisk.H.

Referenced by propellerDisk::moment().

◆ log_

Switch log_

protected

Optional switch to enable logging of integral properties.

Definition at line 157 of file propellerDisk.H.

Referenced by propellerDisk::readCoeffs().

◆ logFile_

autoPtr<functionObjects::logFile> logFile_

mutableprotected

Optional log file.

Definition at line 160 of file propellerDisk.H.

Referenced by propellerDisk::readCoeffs().

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

◆ readCoeffs()

◆ normal()

◆ n()

◆ correctn()

◆ diskThickness()

◆ J()

◆ TypeName()

◆ centre()

◆ force()

◆ moment()

◆ addSupFields()

◆ addSup() [1/3]

◆ addSup() [2/3]

◆ addSup() [3/3]

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ read()

◆ operator=()

Member Data Documentation

◆ zone_

◆ phaseName_

◆ UName_

◆ centre_

◆ normal_

◆ n_

◆ rotationDir_

◆ dProp_

◆ dHub_

◆ propellerFunction_

◆ forcePtr_

◆ force_

◆ moment_

◆ log_

◆ logFile_