trimModel Class Reference

Base class for trim models for handling blade characteristics and thrust-torque relations. More...

#include <trimModel.H>

Inheritance diagram for trimModel:

Collaboration diagram for trimModel:

Public Member Functions
	TypeName ("trimModel")
	Run-time type information.
	declareRunTimeSelectionTable (autoPtr, trimModel, dictionary,(const fv::rotorDiskSource &rotor, const dictionary &dict),(rotor, dict))
	trimModel (const fv::rotorDiskSource &rotor, const dictionary &dict, const word &name)
	Construct from components.
virtual	~trimModel ()=default
	Destructor.
virtual void	read (const dictionary &dict)
	Read.
virtual tmp< scalarField >	thetag () const =0
	Return the geometric angle of attack [rad].
virtual void	correct (const vectorField &U, vectorField &force)=0
	Correct the model.
virtual void	correct (const volScalarField rho, const vectorField &U, vectorField &force)=0
	Correct the model for compressible flow.

Static Public Member Functions
static autoPtr< trimModel >	New (const fv::rotorDiskSource &rotor, const dictionary &dict)
	Return a reference to the selected trim model.

Protected Attributes
const fv::rotorDiskSource &	rotor_
	Reference to the rotor source model.
const word	name_
	Name of model.
dictionary	coeffs_
	Coefficients dictionary.

Detailed Description

Base class for trim models for handling blade characteristics and thrust-torque relations.

Usage

Minimal example by using constant/fvOptions: rotorDiskSource1 { Mandatory/Optional (inherited) entries ...

Mandatory entries (runtime modifiable) trimModel <trimModel>;

<trimModel>Coeffs { Conditional mandatory entries (runtime modifiable)

when trimModel=fixedTrim theta0 5.0; theta1c 1.0; theta1s 4.0; } }

where the entries mean:

Property	Description	Type	Reqd	Dflt
trimModel	Trim model specification	word	yes	-
file	Name of file containing profile characteristics	word	no	-

Options for the trimModel entry:

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

See also

• Foam::fv::rotorDiskSource
• Foam::fixedTrim
• Foam::targetCoeffTrim

Source files

• trimModel.H
• trimModel.C

Definition at line 107 of file trimModel.H.

Constructor & Destructor Documentation

trimModel()

trimModel	(	const fv::rotorDiskSource &	rotor,
		const dictionary &	dict,
		const word &	name )

Construct from components.

Definition at line 35 of file trimModel.C.

References coeffs_, dict, Foam::name(), name_, read(), and rotor_.

Referenced by declareRunTimeSelectionTable(), fixedTrim::fixedTrim(), and targetCoeffTrim::targetCoeffTrim().

Here is the call graph for this function:

Here is the caller graph for this function:

~trimModel()

virtual ~trimModel ( )

virtualdefault

Destructor.

References dict.

Member Function Documentation

TypeName()

TypeName

(

"trimModel"

)

Run-time type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		trimModel	,
		dictionary	,
		(const fv::rotorDiskSource &rotor, const dictionary &dict)	,
		(rotor, dict)	)

References dict, Foam::name(), and trimModel().

Here is the call graph for this function:

New()

Foam::autoPtr< Foam::trimModel > New ( const fv::rotorDiskSource & rotor, const dictionary & dict )

static

Return a reference to the selected trim model.

Definition at line 26 of file trimModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, and Foam::Info.

Here is the call graph for this function:

read()

void read ( const dictionary & dict )

virtual

Read.

Reimplemented in fixedTrim, and targetCoeffTrim.

Definition at line 52 of file trimModel.C.

References coeffs_, dict, and name_.

Referenced by fixedTrim::read(), targetCoeffTrim::read(), and trimModel().

Here is the caller graph for this function:

thetag()

virtual tmp< scalarField > thetag ( ) const

pure virtual

Return the geometric angle of attack [rad].

Implemented in fixedTrim, and targetCoeffTrim.

correct() [1/2]

virtual void correct ( const vectorField & U, vectorField & force )

pure virtual

Correct the model.

Implemented in fixedTrim, and targetCoeffTrim.

References U.

correct() [2/2]

virtual void correct ( const volScalarField rho, const vectorField & U, vectorField & force )

pure virtual

Correct the model for compressible flow.

Implemented in fixedTrim, and targetCoeffTrim.

References rho, and U.

Member Data Documentation

rotor_

const fv::rotorDiskSource& rotor_

protected

Reference to the rotor source model.

Definition at line 116 of file trimModel.H.

Referenced by targetCoeffTrim::calcCoeffs(), targetCoeffTrim::correctTrim(), fixedTrim::read(), targetCoeffTrim::thetag(), and trimModel().

name_

const word name_

protected

Name of model.

Definition at line 121 of file trimModel.H.

Referenced by read(), and trimModel().

coeffs_

dictionary coeffs_

protected

Coefficients dictionary.

Definition at line 126 of file trimModel.H.

Referenced by fixedTrim::read(), targetCoeffTrim::read(), read(), and trimModel().

---

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

• src/fvOptions/sources/derived/rotorDiskSource/trimModel/trimModel/trimModel.H
• src/fvOptions/sources/derived/rotorDiskSource/trimModel/trimModel/trimModel.C
• src/fvOptions/sources/derived/rotorDiskSource/trimModel/trimModel/trimModelNew.C