Public Member Functions | Protected Attributes | List of all members
actuationDiskSource Class Reference

Actuation disk source. More...

Inheritance diagram for actuationDiskSource:
Inheritance graph
[legend]
Collaboration diagram for actuationDiskSource:
Collaboration graph
[legend]

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...
 
virtual ~actuationDiskSource ()
 Destructor. More...
 
scalar Cp () const
 Return Cp. More...
 
scalar Ct () const
 Return Ct. More...
 
const vectordiskDir () const
 Normal disk direction. More...
 
scalar diskArea () const
 Disk area. More...
 
virtual void addSup (fvMatrix< vector > &eqn, const label fieldI)
 Source term to momentum equation. More...
 
virtual void addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldI)
 Source term to compressible momentum equation. More...
 
virtual bool read (const dictionary &dict)
 Read dictionary. More...
 
- Public Member Functions inherited from cellSetOption
 TypeName ("cellSetOption")
 Runtime type information. More...
 
 cellSetOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
virtual ~cellSetOption ()
 Destructor. More...
 
scalar timeStart () const
 Return const access to the time start. More...
 
scalar duration () const
 Return const access to the duration. More...
 
bool inTimeLimits (const scalar time) const
 Return true if within time limits. More...
 
const selectionModeTypeselectionMode () const
 Return const access to the cell selection mode. More...
 
const wordcellSetName () const
 Return const access to the name of cell set for "cellSet". More...
 
scalar V () const
 Return const access to the total cell volume. More...
 
const labelListcells () const
 Return const access to the cell set. More...
 
scalar & timeStart ()
 Return access to the time start. More...
 
scalar & duration ()
 Return access to the duration. More...
 
virtual bool isActive ()
 Is the source active? More...
 
- Public Member Functions inherited from option
 TypeName ("option")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, option, dictionary,( const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh ),(name, modelType, dict, mesh))
 
 option (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
autoPtr< optionclone () const
 Return clone. More...
 
virtual ~option ()
 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...
 
bool active () const
 Return const access to the source active flag. More...
 
void setApplied (const label fieldI)
 Set the applied flag to true for field index fieldI. More...
 
Switchactive ()
 Return access to the source active flag. More...
 
virtual label applyToField (const word &fieldName) const
 Return index of field name if found in fieldNames list. More...
 
virtual void checkApplied () const
 Check that the source has been applied. More...
 
virtual void addSup (fvMatrix< scalar > &eqn, const label fieldI)
 
virtual void addSup (fvMatrix< symmTensor > &eqn, const label fieldI)
 
virtual void addSup (fvMatrix< sphericalTensor > &eqn, const label fieldI)
 
virtual void addSup (fvMatrix< tensor > &eqn, const label fieldI)
 
virtual void addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldI)
 
virtual void addSup (const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldI)
 
virtual void addSup (const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldI)
 
virtual void addSup (const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldI)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldI)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldI)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldI)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldI)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldI)
 
virtual void constrain (fvMatrix< scalar > &eqn, const label fieldI)
 
virtual void constrain (fvMatrix< vector > &eqn, const label fieldI)
 
virtual void constrain (fvMatrix< sphericalTensor > &eqn, const label fieldI)
 
virtual void constrain (fvMatrix< symmTensor > &eqn, const label fieldI)
 
virtual void constrain (fvMatrix< tensor > &eqn, const label fieldI)
 
virtual void correct (volScalarField &field)
 
virtual void correct (volVectorField &field)
 
virtual void correct (volSphericalTensorField &field)
 
virtual void correct (volSymmTensorField &field)
 
virtual void correct (volTensorField &field)
 
virtual void writeHeader (Ostream &) const
 Write the source header information. More...
 
virtual void writeFooter (Ostream &) const
 Write the source footer information. More...
 
virtual void writeData (Ostream &) const
 Write the source properties. More...
 

Protected Attributes

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...
 
- Protected Attributes inherited from cellSetOption
scalar timeStart_
 Time start. More...
 
scalar duration_
 Duration. More...
 
selectionModeType selectionMode_
 Cell selection mode. More...
 
word cellSetName_
 Name of cell set for "cellSet" and "cellZone" selectionMode. More...
 
List< pointpoints_
 List of points for "points" selectionMode. More...
 
labelList cells_
 Set of cells to apply source to. More...
 
scalar V_
 Sum of cell volumes. More...
 
- Protected Attributes inherited from option
const word name_
 Source name. More...
 
const word modelType_
 Model type. More...
 
const fvMeshmesh_
 Reference to the mesh database. More...
 
dictionary dict_
 Top level source dictionary. More...
 
dictionary coeffs_
 Dictionary containing source coefficients. More...
 
Switch active_
 Source active flag. More...
 
wordList fieldNames_
 Field names to apply source to - populated by derived models. More...
 
List< bool > applied_
 Applied flag list - corresponds to each fieldNames_ entry. More...
 

Additional Inherited Members

- Public Types inherited from cellSetOption
enum  selectionModeType { smPoints, smCellSet, smCellZone, smAll }
 Enumeration for selection mode types. More...
 
- Static Public Member Functions inherited from option
static autoPtr< optionNew (const word &name, const dictionary &dict, const fvMesh &mesh)
 Return a reference to the selected fvOption model. More...
 
- Static Public Attributes inherited from cellSetOption
static const NamedEnum< selectionModeType, 4 > selectionModeTypeNames_
 Word list of selection mode type names. More...
 
- Protected Member Functions inherited from cellSetOption
void setSelection (const dictionary &dict)
 Set the cellSet or points selection. More...
 
void setCellSet ()
 Set the cell set based on the user input selection mode. More...
 

Detailed Description

Actuation disk source.

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


Source usage

Example usage:

    actuationDiskSourceCoeffs
    {
        fieldNames      (U);        // names of fields to apply source
        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 100 of file actuationDiskSource.H.

Constructor & Destructor Documentation

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

Construct from components.

Definition at line 83 of file actuationDiskSource.C.

References actuationDiskSource::addSup(), Foam::endl(), polyMesh::findCell(), Foam::Info, and Foam::name().

Here is the call graph for this function:

virtual ~actuationDiskSource ( )
inlinevirtual

Destructor.

Definition at line 172 of file actuationDiskSource.H.

Member Function Documentation

TypeName ( "actuationDiskSource"  )

Runtime type information.

scalar Cp ( ) const
inline

Return Cp.

Definition at line 181 of file actuationDiskSource.H.

References actuationDiskSource::Cp_.

scalar Ct ( ) const
inline

Return Ct.

Definition at line 187 of file actuationDiskSource.H.

References actuationDiskSource::Ct_.

const vector& diskDir ( ) const
inline

Normal disk direction.

Definition at line 193 of file actuationDiskSource.H.

References actuationDiskSource::diskDir_.

scalar diskArea ( ) const
inline

Disk area.

Definition at line 199 of file actuationDiskSource.H.

References actuationDiskSource::addSup(), dict, actuationDiskSource::diskArea_, actuationDiskSource::read(), and rho.

Here is the call graph for this function:

void addSup ( fvMatrix< vector > &  eqn,
const label  fieldI 
)
virtual

Source term to momentum equation.

Reimplemented from option.

Reimplemented in radialActuationDiskSource.

Definition at line 113 of file actuationDiskSource.C.

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

Referenced by actuationDiskSource::actuationDiskSource(), and actuationDiskSource::diskArea().

Here is the call graph for this function:

Here is the caller graph for this function:

void addSup ( const volScalarField rho,
fvMatrix< vector > &  eqn,
const label  fieldI 
)
virtual

Source term to compressible momentum equation.

Reimplemented from option.

Reimplemented in radialActuationDiskSource.

Definition at line 137 of file actuationDiskSource.C.

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

Here is the call graph for this function:

bool read ( const dictionary dict)
virtual

Read dictionary.

Reimplemented from cellSetOption.

Reimplemented in radialActuationDiskSource.

Definition at line 161 of file actuationDiskSource.C.

References cellSetOption::read().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

vector diskDir_
protected

Disk area normal.

Definition at line 110 of file actuationDiskSource.H.

Referenced by actuationDiskSource::diskDir().

scalar Cp_
protected

Power coefficient.

Definition at line 113 of file actuationDiskSource.H.

Referenced by actuationDiskSource::Cp().

scalar Ct_
protected

Thrust coefficient.

Definition at line 116 of file actuationDiskSource.H.

Referenced by actuationDiskSource::Ct().

scalar diskArea_
protected

Disk area.

Definition at line 119 of file actuationDiskSource.H.

Referenced by actuationDiskSource::diskArea().

point upstreamPoint_
protected

Upstream point sample.

Definition at line 122 of file actuationDiskSource.H.

label upstreamCellId_
protected

Upstream cell ID.

Definition at line 125 of file actuationDiskSource.H.


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