actuationDisk Class Reference

Actuation disk source. More...

Inheritance diagram for actuationDisk:
Collaboration diagram for actuationDisk:

Public Member Functions

 TypeName ("actuationDisk")
 Runtime type information. More...
 
 actuationDisk (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
 Construct from components. More...
 
 actuationDisk (const actuationDisk &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~actuationDisk ()
 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 actuationDisk &)=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< fvModelclone () const
 Return clone. More...
 
virtual ~fvModel ()
 Destructor. More...
 
const wordname () const
 Return const access to the source name. More...
 
const fvMeshmesh () const
 Return const access to the mesh database. More...
 
const dictionarycoeffs () 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::wordfieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
 
template<class AlphaRhoFieldType >
const Foam::wordfieldName (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 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 diskDir_
 Disk area normal. More...
 
scalar Cp_
 Power coefficient. More...
 
scalar Ct_
 Thrust coefficient. More...
 
scalar diskArea_
 Disk area. More...
 
point upstreamPoint_
 Upstream point sample. More...
 
label upstreamCellId_
 Upstream cell ID. 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 dimensionSetsourceDims (const dimensionSet &ds)
 Return the dimensions of the matrix of a source term (base. More...
 
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static const wordfieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
 Return the name of the field associated with a source term. More...
 
template<class AlphaRhoFieldType >
static const wordfieldName (const AlphaRhoFieldType &alphaRhoField)
 Return the name of the field associated with a source term (base. More...
 
static const wordfieldName ()
 Return the name of the field associated with a source term. Special. More...
 
static autoPtr< fvModelNew (const word &name, const fvMesh &mesh, const dictionary &dict)
 Return a reference to the selected fvModel. 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...
 

Detailed Description

Actuation disk source.

Constant values for momentum source for actuation disk

\[ T = 2 \rho A (\hat{d}\dot U_{o})^2 a (1-a) \hat{d} \]

where:

$ A $ = Disk area
$ dHat $ = Unit disk direction
$ U_o $ = Upstream velocity
$ a $ = 1 - Cp/Ct
$ Cp $ = Power coefficient
$ Ct $ = Thrust coefficient
Usage
Example usage:
actuationDisk1
{
    type            actuationDisk;

    select          cellSet;
    cellSet         actuationDisk1;

    diskDir         (-1 0 0);   // Disk direction
    Cp              0.1;        // Power coefficient
    Ct              0.5;        // Thrust coefficient
    diskArea        5.0;        // Disk area
    upstreamPoint   (0 0 0);    // Upstream point
}
Source files

Definition at line 109 of file actuationDisk.H.

Constructor & Destructor Documentation

◆ actuationDisk() [1/2]

actuationDisk ( const word name,
const word modelType,
const fvMesh mesh,
const dictionary dict 
)

Construct from components.

Definition at line 134 of file actuationDisk.C.

◆ actuationDisk() [2/2]

actuationDisk ( const actuationDisk )
delete

Disallow default bitwise copy construction.

◆ ~actuationDisk()

virtual ~actuationDisk ( )
inlinevirtual

Destructor.

Definition at line 187 of file actuationDisk.H.

Member Function Documentation

◆ TypeName()

TypeName ( "actuationDisk"  )

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 159 of file actuationDisk.C.

◆ addSup() [1/3]

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

Source term to momentum equation.

Reimplemented in radialActuationDisk.

Definition at line 165 of file actuationDisk.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.

Reimplemented in radialActuationDisk.

Definition at line 183 of file actuationDisk.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 202 of file actuationDisk.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 222 of file actuationDisk.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap map)
virtual

Update topology using the given map.

Implements fvModel.

Definition at line 229 of file actuationDisk.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap map)
virtual

Update from another mesh using the given map.

Implements fvModel.

Definition at line 235 of file actuationDisk.C.

◆ distribute()

void distribute ( const polyDistributionMap map)
virtual

Redistribute or update using the given distribution map.

Implements fvModel.

Definition at line 241 of file actuationDisk.C.

◆ read()

bool read ( const dictionary dict)
virtual

Read dictionary.

Reimplemented from fvModel.

Reimplemented in radialActuationDisk.

Definition at line 247 of file actuationDisk.C.

References dict, and fvModel::read().

Referenced by radialActuationDisk::read().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

void operator= ( const actuationDisk )
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 actuationDisk.H.

◆ phaseName_

word phaseName_
protected

The name of the phase to which this fvModel applies.

Definition at line 121 of file actuationDisk.H.

◆ UName_

word UName_
protected

Name of the velocity field.

Definition at line 124 of file actuationDisk.H.

◆ diskDir_

vector diskDir_
protected

Disk area normal.

Definition at line 127 of file actuationDisk.H.

◆ Cp_

scalar Cp_
protected

Power coefficient.

Definition at line 130 of file actuationDisk.H.

◆ Ct_

scalar Ct_
protected

Thrust coefficient.

Definition at line 133 of file actuationDisk.H.

◆ diskArea_

scalar diskArea_
protected

Disk area.

Definition at line 136 of file actuationDisk.H.

◆ upstreamPoint_

point upstreamPoint_
protected

Upstream point sample.

Definition at line 139 of file actuationDisk.H.

◆ upstreamCellId_

label upstreamCellId_
protected

Upstream cell ID.

Definition at line 142 of file actuationDisk.H.


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