actuationDiskSource Class Reference

Actuation disk source. More...

Inheritance diagram for actuationDiskSource:
Collaboration diagram for actuationDiskSource:

Public Member Functions

 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 (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 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...
 
virtual bool read (const dictionary &dict)
 Read dictionary. 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
 

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

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:
actuationDiskSource1
{
    type            actuationDiskSource;

    selectionMode   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 110 of file actuationDiskSource.H.

Constructor & Destructor Documentation

◆ actuationDiskSource() [1/2]

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

Construct from components.

Definition at line 101 of file actuationDiskSource.C.

◆ actuationDiskSource() [2/2]

Disallow default bitwise copy construction.

◆ ~actuationDiskSource()

Member Function Documentation

◆ TypeName()

TypeName ( "actuationDiskSource"  )

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 125 of file actuationDiskSource.C.

References actuationDiskSource::addSup().

Referenced by actuationDiskSource::~actuationDiskSource().

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

◆ addSup() [1/3]

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

Source term to momentum equation.

Reimplemented in radialActuationDiskSource.

Definition at line 132 of file actuationDiskSource.C.

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

Referenced by actuationDiskSource::addSup(), actuationDiskSource::addSupFields(), and actuationDiskSource::~actuationDiskSource().

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

◆ addSup() [2/3]

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

Source term to compressible momentum equation.

Reimplemented in radialActuationDiskSource.

Definition at line 157 of file actuationDiskSource.C.

References actuationDiskSource::addSup(), mesh, fvMatrix< Type >::psi(), 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,
fvMatrix< vector > &  eqn,
const word fieldName 
) const
virtual

Explicit and implicit sources for phase equations.

Definition at line 183 of file actuationDiskSource.C.

References alpha(), mesh, fvMatrix< Type >::psi(), 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 209 of file actuationDiskSource.C.

Referenced by actuationDiskSource::~actuationDiskSource().

Here is the caller graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap map)
virtual

Update topology using the given map.

Implements fvModel.

Definition at line 216 of file actuationDiskSource.C.

Referenced by actuationDiskSource::~actuationDiskSource().

Here is the caller graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap map)
virtual

Update from another mesh using the given map.

Implements fvModel.

Definition at line 222 of file actuationDiskSource.C.

References actuationDiskSource::distribute().

Referenced by actuationDiskSource::~actuationDiskSource().

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

◆ distribute()

void distribute ( const polyDistributionMap map)
virtual

Redistribute or update using the given distribution map.

Implements fvModel.

Definition at line 229 of file actuationDiskSource.C.

Referenced by actuationDiskSource::mapMesh(), and actuationDiskSource::~actuationDiskSource().

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary dict)
virtual

Read dictionary.

Reimplemented from fvModel.

Reimplemented in radialActuationDiskSource.

Definition at line 237 of file actuationDiskSource.C.

References fvModel::read().

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

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

◆ operator=()

void operator= ( const actuationDiskSource )
delete

Disallow default bitwise assignment.

Referenced by actuationDiskSource::~actuationDiskSource().

Here is the caller graph for this function:

Member Data Documentation

◆ set_

fvCellSet set_
protected

The set of cells the fvConstraint applies to.

Definition at line 119 of file actuationDiskSource.H.

◆ phaseName_

word phaseName_
protected

The name of the phase to which this fvModel applies.

Definition at line 122 of file actuationDiskSource.H.

◆ UName_

word UName_
protected

Name of the velocity field.

Definition at line 125 of file actuationDiskSource.H.

◆ diskDir_

vector diskDir_
protected

Disk area normal.

Definition at line 128 of file actuationDiskSource.H.

◆ Cp_

scalar Cp_
protected

Power coefficient.

Definition at line 131 of file actuationDiskSource.H.

◆ Ct_

scalar Ct_
protected

Thrust coefficient.

Definition at line 134 of file actuationDiskSource.H.

◆ diskArea_

scalar diskArea_
protected

Disk area.

Definition at line 137 of file actuationDiskSource.H.

◆ upstreamPoint_

point upstreamPoint_
protected

Upstream point sample.

Definition at line 140 of file actuationDiskSource.H.

◆ upstreamCellId_

label upstreamCellId_
protected

Upstream cell ID.

Definition at line 143 of file actuationDiskSource.H.


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