3.4.0
Functions for rotor calculations

Functions

TiglReturnCode tiglGetRotorCount (TiglCPACSConfigurationHandle cpacsHandle, int *rotorCountPtr)
 Returns the number of rotors in a CPACS configuration. More...
 
TiglReturnCode tiglRotorGetIndex (TiglCPACSConfigurationHandle cpacsHandle, const char *rotorUID, int *rotorIndexPtr)
 Returns the Index of a rotor. More...
 
TiglReturnCode tiglRotorGetRadius (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, double *radiusPtr)
 Returns the radius of the rotor. More...
 
TiglReturnCode tiglRotorGetReferenceArea (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, double *referenceAreaPtr)
 Returns the reference area of the rotor. More...
 
TiglReturnCode tiglRotorGetSolidity (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, double *solidityPtr)
 Returns the solidity of the rotor. More...
 
TiglReturnCode tiglRotorGetSurfaceArea (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, double *surfaceAreaPtr)
 Returns the surface area of the rotor. More...
 
TiglReturnCode tiglRotorGetTipSpeed (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, double *tipSpeedPtr)
 Returns the tip speed of the rotor in [m/s]. More...
 
TiglReturnCode tiglRotorGetTotalBladePlanformArea (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, double *totalBladePlanformAreaPtr)
 Returns the total blade planform area of the rotor. More...
 
TiglReturnCode tiglRotorGetUID (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, char **uidNamePtr)
 Returns the UID of a rotor. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed. More...
 
TiglReturnCode tiglRotorGetVolume (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, double *volumePtr)
 Returns the volume of the rotor. More...
 

Detailed Description

Functions to handle rotor geometries with TIGL.

Function Documentation

◆ tiglGetRotorCount()

TiglReturnCode tiglGetRotorCount ( TiglCPACSConfigurationHandle  cpacsHandle,
int *  rotorCountPtr 
)

Returns the number of rotors in a CPACS configuration.

Fortran syntax:

tigl_get_rotor_count(integer cpacsHandle, integer rotorCountPtr, integer returnCode)

Parameters
[in]cpacsHandleHandle for the CPACS configuration
[out]rotorCountPtrPointer to the number of rotors
Returns
  • TIGL_SUCCESS if no error occurred
  • TIGL_NOT_FOUND if no configuration was found for the given handle
  • TIGL_NULL_POINTER if rotorCountPtr is a null pointer
  • TIGL_ERROR if some other error occurred

◆ tiglRotorGetIndex()

TiglReturnCode tiglRotorGetIndex ( TiglCPACSConfigurationHandle  cpacsHandle,
const char *  rotorUID,
int *  rotorIndexPtr 
)

Returns the Index of a rotor.

Fortran syntax:

tigl_rotor_get_index(integer cpacsHandle, character*n uIDNamePtr, integer rotorIndex, integer returnCode)

Parameters
[in]cpacsHandleHandle for the CPACS configuration
[in]rotorUIDThe uid of the rotor
[out]rotorIndexPtrThe index of a rotor, starting at 1

Usage example:

   TiglReturnCode returnCode;
   int rotorIndex;
   returnCode = tiglRotorGetUID(cpacsHandle, rotorUID, &rotorIndex);
   printf("The Index of the rotor is %d\n", rotorIndex);
Returns
  • TIGL_SUCCESS if no error occurred
  • TIGL_NOT_FOUND if no configuration was found for the given handle
  • TIGL_UID_ERROR if rotorUID does not exist
  • TIGL_NULL_POINTER if rotorUID is a null pointer
  • TIGL_ERROR if some other error occurred

◆ tiglRotorGetRadius()

TiglReturnCode tiglRotorGetRadius ( TiglCPACSConfigurationHandle  cpacsHandle,
int  rotorIndex,
double *  radiusPtr 
)

Returns the radius of the rotor.

This function returns the radius of the largest blade attached to the rotor hub.

Fortran syntax:

tigl_rotor_get_radius(integer cpacsHandle, int rotorIndex, real radiusPtr, integer returnCode)

Parameters
[in]cpacsHandleHandle for the CPACS configuration
[in]rotorIndexIndex of the rotor to calculate the radius, starting at 1
[out]radiusPtrThe radius of the rotor
Returns
  • TIGL_SUCCESS if no error occurred
  • TIGL_NOT_FOUND if no configuration was found for the given handle
  • TIGL_INDEX_ERROR if rotorIndex is less or equal zero or greater than the rotor count
  • TIGL_NULL_POINTER if radiusPtr is a null pointer
  • TIGL_ERROR if some other error occurred

◆ tiglRotorGetReferenceArea()

TiglReturnCode tiglRotorGetReferenceArea ( TiglCPACSConfigurationHandle  cpacsHandle,
int  rotorIndex,
double *  referenceAreaPtr 
)

Returns the reference area of the rotor.

The area of the rotor disk is taken as reference area of the rotor. It is calculated using the formula pi*r^2, where r denotes the radius of the largest attached blade.

Fortran syntax:

tigl_rotor_get_reference_area(integer cpacsHandle, int rotorIndex, real referenceAreaPtr, integer returnCode)

Parameters
[in]cpacsHandleHandle for the CPACS configuration
[in]rotorIndexIndex of the rotor to calculate the area, starting at 1
[out]referenceAreaPtrThe reference area of the rotor
Returns
  • TIGL_SUCCESS if no error occurred
  • TIGL_NOT_FOUND if no configuration was found for the given handle
  • TIGL_INDEX_ERROR if rotorIndex is less or equal zero or greater than the rotor count
  • TIGL_NULL_POINTER if referenceAreaPtr is a null pointer
  • TIGL_ERROR if some other error occurred

◆ tiglRotorGetSolidity()

TiglReturnCode tiglRotorGetSolidity ( TiglCPACSConfigurationHandle  cpacsHandle,
int  rotorIndex,
double *  solidityPtr 
)

Returns the solidity of the rotor.

The rotor solidity ratio is calculated by dividing the total blade planform area by the rotor disk area.

Fortran syntax:

tigl_rotor_get_solidity(integer cpacsHandle, int rotorIndex, real solidityPtr, integer returnCode)

Parameters
[in]cpacsHandleHandle for the CPACS configuration
[in]rotorIndexIndex of the rotor to calculate the area, starting at 1
[out]solidityPtrThe reference area of the rotor
Returns
  • TIGL_SUCCESS if no error occurred
  • TIGL_NOT_FOUND if no configuration was found for the given handle
  • TIGL_INDEX_ERROR if rotorIndex is less or equal zero or greater than the rotor count
  • TIGL_NULL_POINTER if solidityPtr is a null pointer
  • TIGL_ERROR if some other error occurred

◆ tiglRotorGetSurfaceArea()

TiglReturnCode tiglRotorGetSurfaceArea ( TiglCPACSConfigurationHandle  cpacsHandle,
int  rotorIndex,
double *  surfaceAreaPtr 
)

Returns the surface area of the rotor.

The returned surface area is the sum of the surface areas of all attached rotor blades.

Fortran syntax:

tigl_rotor_get_surface_area(integer cpacsHandle, int rotorIndex, real surfaceAreaPtr, integer returnCode)

Parameters
[in]cpacsHandleHandle for the CPACS configuration
[in]rotorIndexIndex of the Rotor to calculate the area, starting at 1
[out]surfaceAreaPtrThe surface area of the rotor
Returns
  • TIGL_SUCCESS if no error occurred
  • TIGL_NOT_FOUND if no configuration was found for the given handle
  • TIGL_INDEX_ERROR if rotorIndex is less or equal zero or greater than the rotor count
  • TIGL_NULL_POINTER if surfaceAreaPtr is a null pointer
  • TIGL_ERROR if some other error occurred

◆ tiglRotorGetTipSpeed()

TiglReturnCode tiglRotorGetTipSpeed ( TiglCPACSConfigurationHandle  cpacsHandle,
int  rotorIndex,
double *  tipSpeedPtr 
)

Returns the tip speed of the rotor in [m/s].

The rotor tip speed is calculated using the nominal rotation speed of the rotor and the rotor radius.

Fortran syntax:

tigl_rotor_get_tip_speed(integer cpacsHandle, int rotorIndex, real tipSpeedPtr, integer returnCode)

Parameters
[in]cpacsHandleHandle for the CPACS configuration
[in]rotorIndexIndex of the rotor to calculate the area, starting at 1
[out]tipSpeedPtrThe tip speed of the rotor
Returns
  • TIGL_SUCCESS if no error occurred
  • TIGL_NOT_FOUND if no configuration was found for the given handle
  • TIGL_INDEX_ERROR if rotorIndex is less or equal zero or greater than the rotor count
  • TIGL_NULL_POINTER if tipSpeedPtr is a null pointer
  • TIGL_ERROR if some other error occurred

◆ tiglRotorGetTotalBladePlanformArea()

TiglReturnCode tiglRotorGetTotalBladePlanformArea ( TiglCPACSConfigurationHandle  cpacsHandle,
int  rotorIndex,
double *  totalBladePlanformAreaPtr 
)

Returns the total blade planform area of the rotor.

This function calculates the sum of the planform areas of all blades attached to the rotor hub.

Fortran syntax:

tigl_rotor_get_total_blade_planform_area(integer cpacsHandle, int rotorIndex, real totalBladePlanformAreaPtr, integer returnCode)

Parameters
[in]cpacsHandleHandle for the CPACS configuration
[in]rotorIndexIndex of the rotor to calculate the area, starting at 1
[out]totalBladePlanformAreaPtrThe total blade planform area of the rotor
Returns
  • TIGL_SUCCESS if no error occurred
  • TIGL_NOT_FOUND if no configuration was found for the given handle
  • TIGL_INDEX_ERROR if rotorIndex is less or equal zero or greater than the rotor count
  • TIGL_NULL_POINTER if totalBladePlanformAreaPtr is a null pointer
  • TIGL_ERROR if some other error occurred

◆ tiglRotorGetUID()

TiglReturnCode tiglRotorGetUID ( TiglCPACSConfigurationHandle  cpacsHandle,
int  rotorIndex,
char **  uidNamePtr 
)

Returns the UID of a rotor. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed.

Fortran syntax:

tigl_rotor_get_uid(integer cpacsHandle, integer rotorIndex, character*n uIDNamePtr, integer returnCode)

Parameters
[in]cpacsHandleHandle for the CPACS configuration
[in]rotorIndexThe index of a rotor, starting at 1
[out]uidNamePtrThe uid of the rotor

Usage example:

   TiglReturnCode returnCode;
   char* uidPtr = 0;
   returnCode = tiglRotorGetUID(cpacsHandle, rotor, &uidPtr);
   printf("The UID of the rotor is %s\n", uidPtr);
Returns
  • TIGL_SUCCESS if no error occurred
  • TIGL_NOT_FOUND if no configuration was found for the given handle
  • TIGL_INDEX_ERROR if rotorIndex is not valid
  • TIGL_NULL_POINTER if profileNamePtr is a null pointer
  • TIGL_ERROR if some other error occurred

◆ tiglRotorGetVolume()

TiglReturnCode tiglRotorGetVolume ( TiglCPACSConfigurationHandle  cpacsHandle,
int  rotorIndex,
double *  volumePtr 
)

Returns the volume of the rotor.

The returned volume is the sum of the volumes of all attached rotor blades.

Fortran syntax:

tigl_rotor_get_volume(integer cpacsHandle, int rotorIndex, real volumePtr, integer returnCode)

Parameters
[in]cpacsHandleHandle for the CPACS configuration
[in]rotorIndexIndex of the rotor to calculate the volume, starting at 1
[out]volumePtrThe volume of the rotor
Returns
  • TIGL_SUCCESS if no error occurred
  • TIGL_NOT_FOUND if no configuration was found for the given handle
  • TIGL_INDEX_ERROR if rotorIndex is less or equal zero or greater than the rotor count
  • TIGL_NULL_POINTER if volumePtr is a null pointer
  • TIGL_ERROR if some other error occurred