Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
trimModel Class Referenceabstract

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

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

Public Member Functions

 TypeName ("trimModel")
 
 declareRunTimeSelectionTable (autoPtr, trimModel, dictionary,(const fv::rotorDiskSource &rotor, const dictionary &dict),(rotor, dict))
 
 trimModel (const fv::rotorDiskSource &rotor, const dictionary &dict, const word &name)
 
virtual ~trimModel ()=default
 
virtual void read (const dictionary &dict)
 
virtual tmp< scalarFieldthetag () const =0
 
virtual void correct (const vectorField &U, vectorField &force)=0
 
virtual void correct (const volScalarField rho, const vectorField &U, vectorField &force)=0
 

Static Public Member Functions

static autoPtr< trimModelNew (const fv::rotorDiskSource &rotor, const dictionary &dict)
 

Protected Attributes

const fv::rotorDiskSourcerotor_
 
const word name_
 
dictionary coeffs_
 

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
Source files

Definition at line 107 of file trimModel.H.

Constructor & Destructor Documentation

◆ trimModel()

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

Definition at line 36 of file trimModel.C.

References dict, and Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ ~trimModel()

virtual ~trimModel ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "trimModel"  )

◆ declareRunTimeSelectionTable()

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

◆ New()

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

Definition at line 27 of file trimModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::Info.

Here is the call graph for this function:

◆ read()

void read ( const dictionary dict)
virtual

Reimplemented in targetCoeffTrim, and fixedTrim.

Definition at line 52 of file trimModel.C.

References trimModel::coeffs_, dict, and trimModel::name_.

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

Here is the caller graph for this function:

◆ thetag()

virtual tmp<scalarField> thetag ( ) const
pure virtual

Implemented in targetCoeffTrim, and fixedTrim.

◆ correct() [1/2]

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

Implemented in targetCoeffTrim, and fixedTrim.

◆ correct() [2/2]

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

Implemented in targetCoeffTrim, and fixedTrim.

Member Data Documentation

◆ rotor_

const fv::rotorDiskSource& rotor_
protected

Definition at line 114 of file trimModel.H.

◆ name_

const word name_
protected

Definition at line 117 of file trimModel.H.

Referenced by trimModel::read().

◆ coeffs_

dictionary coeffs_
protected

Definition at line 120 of file trimModel.H.

Referenced by trimModel::read().


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