radialActuationDiskSource Class Reference

Actuation disk source including radial thrust. More...

Inheritance diagram for radialActuationDiskSource:
Collaboration diagram for radialActuationDiskSource:

Public Member Functions

 TypeName ("radialActuationDiskSource")
 Runtime type information. More...
 
 radialActuationDiskSource (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
 radialActuationDiskSource (const radialActuationDiskSource &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~radialActuationDiskSource ()
 Destructor. More...
 
virtual void addSup (fvMatrix< vector > &eqn, const word &fieldName) const
 Source term to momentum equation. More...
 
virtual void addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const word &fieldName) const
 Source term to compressible momentum equation. More...
 
virtual bool read (const dictionary &dict)
 Read dictionary. More...
 
void operator= (const radialActuationDiskSource &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from actuationDiskSource
 TypeName ("actuationDiskSource")
 Runtime type information. More...
 
 actuationDiskSource (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
 actuationDiskSource (const actuationDiskSource &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~actuationDiskSource ()
 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, fvMatrix< vector > &eqn, const word &fieldName) 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 actuationDiskSource &)=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 dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))
 
 fvModel (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 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...
 
 FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_SUP)
 Add a source term to an equation. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_RHO_SUP)
 Add a source term to a compressible equation. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_ALPHA_RHO_SUP)
 Add a source term to a phase equation. More...
 
template<class Type >
tmp< fvMatrix< Type > > source (const GeometricField< Type, fvPatchField, volMesh > &field) const
 Return source for an equation. More...
 
template<class Type >
tmp< fvMatrix< Type > > source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
 Return source for an equation with a specified name. More...
 
template<class Type >
tmp< fvMatrix< Type > > source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const
 Return source for a compressible equation. More...
 
template<class Type >
tmp< fvMatrix< Type > > source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
 Return source for a compressible equation with a specified name. More...
 
template<class Type >
tmp< fvMatrix< Type > > source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const
 Return source for a phase equation. More...
 
template<class Type >
tmp< fvMatrix< Type > > source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
 Return source for a phase equation with a specified name. More...
 
virtual void preUpdateMesh ()
 Prepare for mesh update. More...
 
virtual void correct ()
 Correct the fvModel. More...
 
template<class Type , class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::dimensionSet sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds, const AlphaRhoFieldType &alphaRho, const AlphaRhoFieldTypes &... alphaRhos)
 
template<class Type >
Foam::dimensionSet sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds)
 
template<class Type , class ... AlphaRhoFieldTypes>
Foam::tmp< Foam::fvMatrix< Type > > source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const
 
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > > source (const GeometricField< Type, fvPatchField, volMesh > &field) const
 
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > > source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
 
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > > source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const
 
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > > source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
 
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > > source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const
 
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > > source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
 

Additional Inherited Members

- Static Public Member Functions inherited from fvModel
template<class Type , class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static dimensionSet sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds, const AlphaRhoFieldType &alphaRho, const AlphaRhoFieldTypes &... alphaRhos)
 Return the dimensions of the matrix of a source term. More...
 
template<class Type >
static dimensionSet sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds)
 Return the dimensions of the matrix of a source term (base. More...
 
static autoPtr< fvModelNew (const word &name, const dictionary &dict, const fvMesh &mesh)
 Return a reference to the selected fvModel. More...
 
- Protected Member Functions inherited from fvModel
template<class Type >
void addSupType (fvMatrix< Type > &eqn, const word &fieldName) const
 Add a source term to an equation. More...
 
template<class Type >
void addSupType (const volScalarField &rho, fvMatrix< Type > &eqn, const word &fieldName) const
 Add a source term to a compressible equation. More...
 
template<class Type >
void addSupType (const volScalarField &alpha, const volScalarField &rho, fvMatrix< Type > &eqn, const word &fieldName) const
 Add a source term to a phase equation. More...
 
template<class Type , class ... AlphaRhoFieldTypes>
tmp< fvMatrix< Type > > source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const
 Return source for equation with specified name and dimensions. More...
 
- Protected Attributes inherited from actuationDiskSource
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:
radialActuationDiskSource1
{
    type            radialActuationDiskSource;

    selectionMode   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 radialActuationDiskSource.H.

Constructor & Destructor Documentation

◆ radialActuationDiskSource() [1/2]

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

Construct from components.

Definition at line 57 of file radialActuationDiskSource.C.

References radialActuationDiskSource::addSup().

Here is the call graph for this function:

◆ radialActuationDiskSource() [2/2]

Disallow default bitwise copy construction.

◆ ~radialActuationDiskSource()

virtual ~radialActuationDiskSource ( )
inlinevirtual

Destructor.

Definition at line 165 of file radialActuationDiskSource.H.

References radialActuationDiskSource::addSup(), radialActuationDiskSource::operator=(), and radialActuationDiskSource::read().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "radialActuationDiskSource"  )

Runtime type information.

◆ addSup() [1/2]

void addSup ( fvMatrix< vector > &  eqn,
const word fieldName 
) const
virtual

Source term to momentum equation.

Reimplemented from actuationDiskSource.

Definition at line 74 of file radialActuationDiskSource.C.

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

Referenced by radialActuationDiskSource::radialActuationDiskSource(), and radialActuationDiskSource::~radialActuationDiskSource().

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

◆ addSup() [2/2]

void addSup ( const volScalarField rho,
fvMatrix< vector > &  eqn,
const word fieldName 
) const
virtual

Source term to compressible momentum equation.

Reimplemented from actuationDiskSource.

Definition at line 98 of file radialActuationDiskSource.C.

References mesh, fvMatrix< Type >::psi(), 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 actuationDiskSource.

Definition at line 122 of file radialActuationDiskSource.C.

References actuationDiskSource::read().

Referenced by radialActuationDiskSource::~radialActuationDiskSource().

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

◆ operator=()

void operator= ( const radialActuationDiskSource )
delete

Disallow default bitwise assignment.

Referenced by radialActuationDiskSource::~radialActuationDiskSource().

Here is the caller graph for this function:

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