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

Trim model base class. More...

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

Public Member Functions

 TypeName ("trimModel")
 Run-time type information. More...
 
 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. More...
 
virtual ~trimModel ()=default
 Destructor. More...
 
virtual void read (const dictionary &dict)
 Read. More...
 
virtual tmp< scalarField > thetag () const =0
 Return the geometric angle of attack [rad]. More...
 
virtual void correct (const vectorField &U, vectorField &force)=0
 Correct the model. More...
 
virtual void correct (const volScalarField rho, const vectorField &U, vectorField &force)=0
 Correct the model for compressible flow. More...
 

Static Public Member Functions

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

Protected Attributes

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

Detailed Description

Trim model base class.

Source files

Definition at line 52 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 42 of file trimModel.C.

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

Here is the call graph for this function:

◆ ~trimModel()

virtual ~trimModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "trimModel"  )

Run-time type information.

◆ 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

Return a reference to the selected trim model.

Definition at line 34 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

Read.

Reimplemented in targetCoeffTrim, and fixedTrim.

Definition at line 58 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

Return the geometric angle of attack [rad].

Implemented in targetCoeffTrim, and fixedTrim.

◆ correct() [1/2]

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

Correct the model.

Implemented in targetCoeffTrim, and fixedTrim.

◆ correct() [2/2]

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

Correct the model for compressible flow.

Implemented in targetCoeffTrim, and fixedTrim.

Member Data Documentation

◆ rotor_

const fv::rotorDiskSource& rotor_
protected

Reference to the rotor source model.

Definition at line 59 of file trimModel.H.

◆ name_

const word name_
protected

Name of model.

Definition at line 62 of file trimModel.H.

Referenced by trimModel::read().

◆ coeffs_

dictionary coeffs_
protected

Coefficients dictionary.

Definition at line 65 of file trimModel.H.

Referenced by trimModel::read().

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