FreeFOAM The Cross-Platform CFD Toolkit
actuationDiskSource Class Reference

Actuation disk zone definition. Constant values for momentum source for actuation disk. More...

#include <finiteVolume/actuationDiskSource.H>


Detailed Description

Actuation disk zone definition. Constant values for momentum source for actuation disk.

T = 2*rho*A*sqr(Uo)*a*(1-a) U1 = (1 -a)Uo where: A: disk area Uo: upstream velocity a: 1 - Cp/Ct U1: velocity at the disk

Source files

Definition at line 68 of file actuationDiskSource.H.

+ Inheritance diagram for actuationDiskSource:
+ Collaboration diagram for actuationDiskSource:

List of all members.

Public Member Functions

 TypeName ("actuationDiskSource")
 Runtime type information.
 actuationDiskSource (const word &name, const dictionary &dict, const fvMesh &mesh)
 Construct from components.
virtual ~actuationDiskSource ()
 Destructor.
label zoneId () const
 cellZone number
scalar Cp () const
 Return Cp.
scalar Ct () const
 Return Ct.
const vectordiskDir () const
 Normal disk direction.
scalar diskArea () const
 Disk area.
virtual void addSu (fvMatrix< vector > &UEqn)
 Source term to fvMatrix<vector>
virtual void addSu (fvMatrix< scalar > &UEqn)
 Source term to fvMatrix<scalar>
virtual void addExplicitSources ()
 Add all explicit source.
virtual void addSu (DimensionedField< scalar, volMesh > &field)
 Add source to scalar field.
virtual void addSu (DimensionedField< vector, volMesh > &field)
 Add source to vector field.
virtual void writeData (Ostream &) const
 Write data.
virtual bool read (const dictionary &dict)
 Read dictionary.
- Public Member Functions inherited from basicSource
 TypeName ("basicSource")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, basicSource, dictionary,(const word &name, const dictionary &dict, const fvMesh &mesh),(name, dict, mesh))
 basicSource (const word &name, const dictionary &dict, const fvMesh &mesh)
 Construct from components.
autoPtr< basicSourceclone () const
 Return clone.
virtual ~basicSource ()
 Destructor.
const wordname () const
 Return const access to the source name.
const fvMeshmesh () const
 Return const access to the mesh database.
const dictionarydictCoeffs () const
 Return dictionay.
bool active () const
 Return const access to the source active flag.
scalar timeStart () const
 Return const access to the time start.
scalar duration () const
 Return const access to the duration.
scalar timeEnd () const
 Return const access to the time end.
const selectionModeTypeselectionMode () const
 Return const access to the cell selection mode.
const wordcellSetName () const
 Return const access to the name of cell set for "cellSet".
scalar V () const
 Return const access to the total cell volume.
const labelListcells () const
 Return const access to the cell set.
wordname ()
 Return access to the source name.
bool & active ()
 Return access to the source active flag.
scalar & timeStart ()
 Return access to the time start.
scalar & duration ()
 Return access to the duration.
selectionModeTypeselectionMode ()
 Return access to the cell selection mode.
List< point > & points ()
 Return access to the list of points for "points" selectionMode.
wordcellSetName ()
 Return access to the name of cell set for "cellSet".
scalar & V ()
 Return access to the total cell volume.
labelListcells ()
 Return access to the cell set.
bool isActive ()
 Is the source active?

Additional Inherited Members

- Public Types inherited from basicSource
enum  selectionModeType { smPoints, smCellSet, smCellZone, smAll }
 Enumeration for selection mode types. More...
- Static Public Member Functions inherited from basicSource
static autoPtr< basicSourceNew (const word &name, const dictionary &dict, const fvMesh &mesh)
 Return a reference to the selected basicSource model.
- Static Public Attributes inherited from basicSource
static const wordList selectionModeTypeNames_
 Word list of selection mode type names.
- Protected Member Functions inherited from basicSource
selectionModeType wordToSelectionModeType (const word &smtName) const
 Helper function to convert from a word to a selectionModeType.
word selectionModeTypeToWord (const selectionModeType &smtType) const
 Helper function to convert from a selectionModeType to a word.
void setSelection (const dictionary &dict)
 Set the cellSet or points selection.
void setCellSet ()
 Set the cell set based on the user input selection mode.
- Protected Attributes inherited from basicSource
word name_
 Source name.
const fvMeshmesh_
 Reference to the mesh database.
bool active_
 Source active flag.
scalar timeStart_
 Time start.
scalar duration_
 Duration.
selectionModeType selectionMode_
 Cell selection mode.
word cellSetName_
 Name of cell set for "cellSet" and "cellZone" selectionMode.
labelList cells_
 Set of cells to apply source to.
scalar V_
 Sum of cell volumes.

Constructor & Destructor Documentation

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

Construct from components.

Definition at line 70 of file actuationDiskSource.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, Pstream::master(), Foam::name(), and Foam::reduce().

virtual ~actuationDiskSource ( )
inlinevirtual

Destructor.

Definition at line 134 of file actuationDiskSource.H.


Member Function Documentation

TypeName ( "actuationDiskSource"  )

Runtime type information.

label zoneId ( ) const
inline

cellZone number

Definition at line 143 of file actuationDiskSource.H.

scalar Cp ( ) const
inline

Return Cp.

Definition at line 149 of file actuationDiskSource.H.

scalar Ct ( ) const
inline

Return Ct.

Definition at line 155 of file actuationDiskSource.H.

const vector& diskDir ( ) const
inline

Normal disk direction.

Definition at line 161 of file actuationDiskSource.H.

scalar diskArea ( ) const
inline

Disk area.

Definition at line 167 of file actuationDiskSource.H.

void addSu ( fvMatrix< vector > &  UEqn)
virtual

Source term to fvMatrix<vector>

Implements basicSource.

Definition at line 107 of file actuationDiskSource.C.

References cells, fvMatrix< Type >::dimensions(), mesh, fvMatrix< Type >::psi(), fvMatrix< Type >::source(), U, and fvMesh::V().

virtual void addSu ( fvMatrix< scalar > &  UEqn)
inlinevirtual

Source term to fvMatrix<scalar>

Implements basicSource.

Definition at line 179 of file actuationDiskSource.H.

virtual void addExplicitSources ( )
inlinevirtual

Add all explicit source.

Implements basicSource.

Definition at line 182 of file actuationDiskSource.H.

virtual void addSu ( DimensionedField< scalar, volMesh > &  field)
inlinevirtual

Add source to scalar field.

Implements basicSource.

Definition at line 185 of file actuationDiskSource.H.

virtual void addSu ( DimensionedField< vector, volMesh > &  field)
inlinevirtual

Add source to vector field.

Implements basicSource.

Definition at line 188 of file actuationDiskSource.H.

bool read ( const dictionary dict)
virtual

Read dictionary.

Implements basicSource.

Definition at line 170 of file actuationDiskSource.C.

References Foam::name(), basicSource::read(), dictionary::readIfPresent(), and dictionary::subDict().


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