Applies cell-based momentum sources on velocity (i.e. U) within a specified cylindrical region to approximate the mean effects of rotor forces. More...

#include <rotorDiskSource.H>

Inheritance diagram for rotorDiskSource:

[legend]

Collaboration diagram for rotorDiskSource:

[legend]

Classes
struct	flapData

Public Types
enum	geometryModeType { gmAuto , gmSpecified }
	Options for the geometry type specification. More...
enum	inletFlowType { ifFixed , ifSurfaceNormal , ifLocal }
	Options for the inlet flow type specification. More...
Public Types inherited from cellSetOption
enum	selectionModeType : char { smAll , smCellSet , smCellZone , smPoints , smMovingPoints , smGeometric , smCellType }
	Enumeration for selection mode types. More...

Public Member Functions
	TypeName ("rotorDisk")
	Runtime type information.
	rotorDiskSource (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components.
	rotorDiskSource (const rotorDiskSource &)=delete
	No copy construct.
void	operator= (const rotorDiskSource &)=delete
	No copy assignment.
virtual	~rotorDiskSource ()=default
	Destructor.
scalar	rhoRef () const
	Return the reference density for incompressible case.
scalar	omega () const
	Return the rotational speed [rad/s].
const List< point > &	x () const
	Return the cell centre positions in local rotor frame.
const coordSystem::cylindrical &	coordSys () const
	Return the rotor coordinate system (r-theta-z).
template<class RhoFieldType>
void	calculate (const RhoFieldType &rho, const vectorField &U, const scalarField &thetag, vectorField &force, const bool divideVolume=true, const bool output=true) const
	Calculate forces.
virtual void	addSup (fvMatrix< vector > &eqn, const label fieldi)
	Add explicit contribution to momentum equation.
virtual void	addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
	Add explicit contribution to compressible momentum equation.
virtual bool	read (const dictionary &dict)
	Read source dictionary.
Public Member Functions inherited from cellSetOption
	TypeName ("cellSetOption")
	Runtime type information.
	cellSetOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components.
virtual	~cellSetOption ()=default
	Destructor.
scalar	timeStart () const noexcept
	Return const access to the time start.
scalar	duration () const noexcept
	Return const access to the duration.
bool	inTimeLimits (const scalar timeValue) const
	True if within time limits.
bool	useSubMesh () const noexcept
	True if sub-selection should be used.
selectionModeType	selectionMode () const noexcept
	Return the cell selection mode.
const wordRes &	selectionNames () const noexcept
	Return const access to the selection names (set or zone selection).
const wordRe &	zoneName () const
	Return const access to the first set/zone name.
scalar	V () const noexcept
	Return const access to the total cell volume.
const labelList &	cells () const noexcept
	Return const access to the cell selection.
bool	isSelectionUpdated () const noexcept
	Return flag for selection updates.
scalar	timeStart (scalar val) noexcept
	Adjust the time start, return the old value.
scalar	duration (scalar val) noexcept
	Adjust the duration, return the old value.
virtual bool	isActive ()
	Is the source active?
const word &	cellSetName () const
	The name of the cell set/zone [as a word] for "cellSet" / "cellZone" selection modes).
Public Member Functions inherited from option
	TypeName ("option")
	Runtime type information.
	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.
autoPtr< option >	clone () const
	Return clone.
virtual	~option ()=default
	Destructor.
const word &	name () const noexcept
	Return const access to the source name.
const fvMesh &	mesh () const noexcept
	Return const access to the mesh database.
const dictionary &	coeffs () const noexcept
	Return dictionary.
bool	active () const noexcept
	True if source is active.
void	setApplied (const label fieldi)
	Set the applied flag to true for field index fieldi.
bool	active (const bool on) noexcept
	Change source active flag, return previous value.
virtual label	applyToField (const word &fieldName) const
	Return index of field name if found in fieldNames list.
virtual void	checkApplied () const
	Check that the source has been applied.
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	correct (surfaceScalarField &field)
virtual void	correct (surfaceVectorField &field)
virtual void	correct (surfaceTensorField &field)
virtual void	postProcessSens (scalarField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void	postProcessSens (vectorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void	postProcessSens (tensorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void	postProcessAuxSens (const volScalarField &primalField, const volScalarField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	postProcessAuxSens (const volVectorField &primalField, const volVectorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	postProcessAuxSens (const volTensorField &primalField, const volTensorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	writeHeader (Ostream &) const
	Write the source header information.
virtual void	writeFooter (Ostream &) const
	Write the source footer information.
virtual void	writeData (Ostream &) const
	Write the source properties.

Static Public Attributes
static const Enum< geometryModeType >	geometryModeTypeNames_
	Names for geometryModeType.
static const Enum< inletFlowType >	inletFlowTypeNames_
	Names for inletFlowType.
Static Public Attributes inherited from cellSetOption
static const Enum< selectionModeType >	selectionModeTypeNames_
	List of selection mode type names.

Protected Member Functions
void	checkData ()
	Check data.
void	setFaceArea (vector &axis, const bool correct)
	Set the face areas per cell, and optionally correct the rotor axis.
void	createCoordinateSystem ()
	Create the coordinate system.
void	constructGeometry ()
	Construct geometry.
tmp< vectorField >	inflowVelocity (const volVectorField &U) const
	Return the inlet flow field.
template<class Type>
void	writeField (const word &name, const List< Type > &values, const bool writeNow=false) const
	Helper function to write rotor values.
Protected Member Functions inherited from cellSetOption
void	setSelection (const dictionary &dict)
	Set cell selection name or points selection from dictionary input.
void	setCellSelection ()
	Set the cell selection based on user input selection mode.
void	setVol ()
	Recalculate the volume.
Protected Member Functions inherited from option
void	resetApplied ()
	Resize/reset applied flag list for all fieldNames_ entries.

Protected Attributes
scalar	rhoRef_
	Reference density for incompressible case.
scalar	omega_
	Rotational speed [rad/s].
label	nBlades_
	Number of blades.
inletFlowType	inletFlow_
	Inlet flow type.
vector	inletVelocity_
	Inlet velocity for specified inflow.
scalar	tipEffect_
	Tip effect [0-1].
flapData	flap_
	Blade flap coefficients [rad/s].
List< point >	x_
	Cell centre positions in local rotor frame.
List< tensor >	Rcone_
	Rotation tensor for flap angle.
List< scalar >	area_
	Area [m2].
coordSystem::cylindrical	coordSys_
	Rotor local cylindrical coordinate system (r-theta-z).
autoPtr< tensorField >	Rcyl_
	Cached rotation tensors for cylindrical coordinates.
scalar	rMax_
	Maximum radius.
autoPtr< trimModel >	trim_
	Trim model.
bladeModel	blade_
	Blade data.
profileModelList	profiles_
	Profile data.
Protected Attributes inherited from cellSetOption
selectionModeType	selectionMode_
	Cell selection mode.
bool	updateSelection_
	Flag to enable dictionary-based updates of selections.
scalar	timeStart_
	Start time of fvOption.
scalar	duration_
	Duration of fvOption execution starting from timeStart.
wordRes	selectionNames_
	Face selection names (for set or zone selections).
List< point >	points_
	List of points for "points" selectionMode.
PtrList< Function1< point > >	movingPoints_
	List of points for "movingPoints" selectionMode.
dictionary	geometricSelection_
	Dictionary entries for "geometric" (topoSetCellSource) selection.
labelList	cells_
	Set of cells to apply source to.
scalar	V_
	Sum of cell volumes.
Protected Attributes inherited from option
const word	name_
	Source name.
const word	modelType_
	Model type.
const fvMesh &	mesh_
	Reference to the mesh database.
dictionary	dict_
	Top level source dictionary.
dictionary	coeffs_
	Dictionary containing source coefficients.
wordList	fieldNames_
	Field names to apply source to - populated by derived models.
List< bool >	applied_
	Applied flag list - corresponds to each fieldNames_ entry.
bool	active_
	Source active flag.

Additional Inherited Members
Static Public Member Functions inherited from option
static autoPtr< option >	New (const word &name, const dictionary &dict, const fvMesh &mesh)
	Return a reference to the selected fvOption model.
Public Attributes inherited from option
bool	log
	Switch write log to Info.

Detailed Description

Applies cell-based momentum sources on velocity (i.e. U) within a specified cylindrical region to approximate the mean effects of rotor forces.

Sources applied to:

  U         | Velocity    [m/s]

Required fields:

  U         | Velocity    [m/s]

Usage: Minimal example by using constant/fvOptions: rotorDiskSource1 { Mandatory entries (unmodifiable) type rotorDiskSource;

Mandatory entries (runtime modifiable) fields (<field1> <field2> ... <fieldN>); rhoRef 1.0; rpm 5.5; nBlades 3; inletFlowType local; geometryMode auto; tipEffect 0.96; // [0, 1] refDirection (-1 0 0 ); flapCoeffs { beta0 0.0; beta1c 0.0; beta2s 0.0; }

trimModel fixed;

blade { see bladeModel.H for documentation }

profiles { profile1 { type lookup; // lookup || series ... see lookupProfile.H or seriesProfile.H for documentation } profile2 { ... } }

Conditional mandatory entries (runtime modifiable)

when inletFlowType=fixed inletVelocity (1 0 0);

when inletFlowType=surfaceNormal inletNormalVelocity 5.0;

when geometryMode=auto pointAbove (1 0 0);

when geometryMode=specified origin (0 0 0); axis (1 0 0);

Mandatory/Optional (inherited) entries ... }

where the entries mean:

Property	Description	Type	Reqd	Dflt
`type`	Type name: rotorDiskSource	word	yes	-
`fields`	Names of operand fields	wordList	yes	-
`rhoRef`	Reference density for incompressible case	scalar	yes	-
`rpm`	Rotational speed [rev/min]	scalar	yes	-
`nBlades`	Number of rotor blades	label	yes	-
`tipEffect`	Ratio of blade radius beyond which lift=0	scalar	yes	-
`refDirection`	Reference direction used as reference for psi angle	vector	yes	-
`beta0`	Coning angle [deg]	scalar	yes	-
`beta1c`	Lateral flapping coeff (cos coeff) [deg]	scalar	yes	-
`beta2s`	Longitudinal flapping coeff (sin coeff) [deg]	scalar	yes	-
`inletFlowType`	Inlet flow type specification	word	yes	-
`inletVelocity`	Inlet velocity [m/s]	vector	cndtnl	-
`inletNormalVelocity`	Inlet normal velocity magnitude	scalar	cndtnl	-
`geometryMode`	Geometry mode specification	word	yes	-
`pointAbove`	Correct the axis direction using a point above the rotor	vector	cndtnl	-
`origin`	Origin of the specified coordinate system	vector	cndtnl	-
`axis`	Axis of the specified coordinate system	vector	cndtnl	-
`trimModel`	Trim model specification	word	yes	-
`blade`	Blade properties	dictionary	yes	-

The inherited entries are elaborated in:

Options for the inletFlowType entry:

      fixed    | Use a specified velocity
      local    | Use local flow conditions
      surfaceNormal | Use a specified normal velocity (positive towards rotor)

Options for the geometryMode entry:

      auto      | Determine rotor coordinate system from selected cells
      specified | Use a specified coordinate system

Options for the trimModel entry:

      fixed       | Fixed blade/angle characteristics
      targetForce | Target thrust/torque by using time-variant blade characs.

Note

The entry rpm is positive anti-clockwise when looking along -ve lift direction.

See also

Source files

Definition at line 326 of file rotorDiskSource.H.

Member Enumeration Documentation

◆ geometryModeType

enum geometryModeType

Options for the geometry type specification.

Enumerator
gmAuto
gmSpecified

Definition at line 337 of file rotorDiskSource.H.

◆ inletFlowType

enum inletFlowType

Options for the inlet flow type specification.

Enumerator
ifFixed
ifSurfaceNormal
ifLocal

Definition at line 351 of file rotorDiskSource.H.

Constructor & Destructor Documentation

◆ rotorDiskSource() [1/2]

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

Construct from components.

Definition at line 434 of file rotorDiskSource.C.

References area_, blade_, cellSetOption::cells_, cellSetOption::cellSetOption(), option::coeffs_, coordSys_, dict, flap_, Foam::I, ifLocal, inletFlow_, inletVelocity_, option::mesh(), option::name(), nBlades_, option::New(), omega_, profiles_, Rcone_, read(), rhoRef_, rMax_, tipEffect_, trim_, x_, and Foam::Zero.

Referenced by operator=(), and rotorDiskSource().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rotorDiskSource() [2/2]

rotorDiskSource ( const rotorDiskSource & )

delete

No copy construct.

References rotorDiskSource().

Here is the call graph for this function:

◆ ~rotorDiskSource()

virtual ~rotorDiskSource ( )

virtualdefault

Destructor.

References dict, rho, and U.

Member Function Documentation

◆ checkData()

void checkData ( )

protected

Check data.

Definition at line 69 of file rotorDiskSource.C.

References Foam::abort(), blade_, option::coeffs_, coordSys_, Foam::exit(), Foam::FatalError, FatalErrorInFunction, ifFixed, ifLocal, ifSurfaceNormal, inletFlow_, inletVelocity_, Foam::nl, profiles_, cellSetOption::selectionMode(), cellSetOption::selectionModeTypeNames_, cellSetOption::smAll, cellSetOption::smCellSet, and cellSetOption::smCellZone.

Here is the call graph for this function:

◆ setFaceArea()

void setFaceArea	(	vector &	axis,
		const bool	correct )

protected

Set the face areas per cell, and optionally correct the rotor axis.

Definition at line 121 of file rotorDiskSource.C.

References area_, cellSetOption::cells_, option::correct(), Foam::dimArea, Foam::endl(), forAll, Foam::identity(), Foam::Info, Foam::mag(), option::mesh_, n, option::name_, GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, pbm, pp(), Foam::reduce(), IOobject::scopedName(), syncTools::swapBoundaryFaceList(), Foam::type(), and Foam::Zero.

Referenced by createCoordinateSystem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createCoordinateSystem()

void createCoordinateSystem ( )

protected

Create the coordinate system.

Definition at line 253 of file rotorDiskSource.C.

References area_, cellSetOption::cells_, option::coeffs_, coordSys_, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, geometryModeTypeNames_, gmAuto, gmSpecified, Foam::gSum(), Foam::Info, Foam::mag(), option::mesh_, Foam::nl, Vector< Cmpt >::normalise(), Foam::constant::mathematical::pi(), Foam::reduce(), setFaceArea(), Foam::sqrt(), cellSetOption::V(), and Foam::Zero.

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ constructGeometry()

void constructGeometry ( )

protected

Construct geometry.

Rcyl_.reset(coordSys_.R(cc).ptr());

Definition at line 367 of file rotorDiskSource.C.

References area_, beta(), cellSetOption::cells_, coordSys_, Foam::cos(), flap_, forAll, Foam::max(), option::mesh_, psi, Rcone_, rMax_, s(), Foam::sin(), x, and x_.

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ inflowVelocity()

Foam::tmp< Foam::vectorField > inflowVelocity ( const volVectorField & U ) const

protected

Return the inlet flow field.

Definition at line 401 of file rotorDiskSource.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, ifFixed, ifLocal, ifSurfaceNormal, inletFlow_, inletVelocity_, option::mesh_, tmp< T >::New(), U, and Foam::Zero.

Referenced by addSup(), and addSup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeField()

template<class Type>

void writeField	(	const word &	name,
		const List< Type > &	values,
		const bool	writeNow = false ) const

protected

Helper function to write rotor values.

Definition at line 167 of file rotorDiskSourceTemplates.C.

References Foam::abort(), cellSetOption::cells_, Foam::dimless, Foam::FatalError, FatalErrorInFunction, field(), option::mesh_, option::name(), GeometricField< Type, PatchField, GeoMesh >::New(), Foam::nl, IOobjectOption::NO_REGISTER, and Foam::Zero.

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "rotorDisk" )

Runtime type information.

References dict, option::mesh(), and option::name().

Here is the call graph for this function:

◆ operator=()

void operator= ( const rotorDiskSource & )

delete

No copy assignment.

References rotorDiskSource().

Here is the call graph for this function:

◆ rhoRef()

Foam::scalar rhoRef ( ) const

inline

Return the reference density for incompressible case.

Definition at line 25 of file rotorDiskSourceI.H.

References rhoRef_.

◆ omega()

Foam::scalar omega ( ) const

inline

Return the rotational speed [rad/s].

Positive anti-clockwise when looking along -ve lift direction

Definition at line 31 of file rotorDiskSourceI.H.

References omega_.

◆ x()

const Foam::List< Foam::point > & x ( ) const

inline

Return the cell centre positions in local rotor frame.

(Cylindrical r-theta-z)

Definition at line 37 of file rotorDiskSourceI.H.

References x_.

◆ coordSys()

const Foam::coordSystem::cylindrical & coordSys ( ) const

inline

Return the rotor coordinate system (r-theta-z).

Definition at line 44 of file rotorDiskSourceI.H.

References coordSys_.

◆ calculate()

template<class RhoFieldType>

void calculate	(	const RhoFieldType &	rho,
		const vectorField &	U,
		const scalarField &	thetag,
		vectorField &	force,
		const bool	divideVolume = true,
		const bool	output = true ) const