radialActuationDisk Class Reference

Actuation disk source including radial thrust. More...

Inheritance diagram for radialActuationDisk:
Collaboration diagram for radialActuationDisk:

Public Member Functions

 TypeName ("radialActuationDisk")
 Runtime type information. More...
 
 radialActuationDisk (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
 Construct from components. More...
 
 radialActuationDisk (const radialActuationDisk &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~radialActuationDisk ()
 Destructor. 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 bool read (const dictionary &dict)
 Read dictionary. More...
 
void operator= (const radialActuationDisk &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from actuationDisk
 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 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...
 
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< 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
 

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...
 
- 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 inherited from actuationDisk
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...
 

Detailed Description

Actuation disk source including radial thrust.

Constant values for momentum source for actuation disk

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

and

\[ U_1 = (1 - a)U_{o} \]

where:

$ A $ = disk area
$ U_o $ = upstream velocity
$ a $ = 1 - Cp/Ct
$ U_1 $ = velocity at the disk

The thrust is distributed by a radial function:

\[ thrust(r) = T (C_0 + C_1 r^2 + C_2 r^4) \]

Usage
Example usage:
radialActuationDisk1
{
    type            radialActuationDisk;

    select          cellSet;
    cellSet         radialActuationDisk1;

    U               U;              // Name of the velocity field

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

Definition at line 116 of file radialActuationDisk.H.

Constructor & Destructor Documentation

◆ radialActuationDisk() [1/2]

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

Construct from components.

Definition at line 125 of file radialActuationDisk.C.

◆ radialActuationDisk() [2/2]

Disallow default bitwise copy construction.

◆ ~radialActuationDisk()

virtual ~radialActuationDisk ( )
inlinevirtual

Destructor.

Definition at line 165 of file radialActuationDisk.H.

Member Function Documentation

◆ TypeName()

TypeName ( "radialActuationDisk"  )

Runtime type information.

◆ addSup() [1/2]

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

Source term to momentum equation.

Reimplemented from actuationDisk.

Definition at line 142 of file radialActuationDisk.C.

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

Here is the call graph for this function:

◆ addSup() [2/2]

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

Source term to compressible momentum equation.

Reimplemented from actuationDisk.

Definition at line 159 of file radialActuationDisk.C.

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

Here is the call graph for this function:

◆ read()

bool read ( const dictionary &  dict)
virtual

Read dictionary.

Reimplemented from actuationDisk.

Definition at line 177 of file radialActuationDisk.C.

References dict, and actuationDisk::read().

Here is the call graph for this function:

◆ operator=()

void operator= ( const radialActuationDisk &  )
delete

Disallow default bitwise assignment.


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