3.4.0
tigl::CCPACSWing Class Reference

#include <CCPACSWing.h>

+ Inheritance diagram for tigl::CCPACSWing:

Data Structures

struct  LocatedGuideCurves
 

Public Member Functions

TIGL_EXPORT CCPACSWing (CCPACSWings *parent, CTiglUIDManager *uidMgr)
 
TIGL_EXPORT CCPACSWing (CCPACSRotorBlades *parent, CTiglUIDManager *uidMgr)
 
TIGL_EXPORT void CreateNewConnectedElementAfter (std::string startElementUID) override
 
TIGL_EXPORT void CreateNewConnectedElementBefore (std::string startElementUID) override
 
TIGL_EXPORT void CreateNewConnectedElementBetween (std::string startElementUID, std::string endElementUID) override
 
TIGL_EXPORT void DeleteConnectedElement (std::string ElementUID) override
 
TIGL_EXPORT std::vector< std::string > GetAllUsedAirfoils ()
 
TIGL_EXPORT double GetAspectRatio () const
 Returns the aspect ratio of the wing. More...
 
TIGL_EXPORT gp_Pnt GetChordPoint (int segmentIndex, double eta, double xsi, TiglCoordinateSystem referenceCS=GLOBAL_COORDINATE_SYSTEM)
 Returns a point on the chord surface in absolute (world) coordinates for a given segment, eta, xsi, if fourth parameter is ommited, otherwise it will give you the point in the chosen coordinate system (e.g. WING_COORDINATE_SYSTEM) More...
 
TIGL_EXPORT TiglGeometricComponentIntent GetComponentIntent () const override
 
TIGL_EXPORT CCPACSWingComponentSegmentGetComponentSegment (const int index)
 Returns the segment for a given index. More...
 
TIGL_EXPORT const CCPACSWingComponentSegmentGetComponentSegment (const int index) const
 Returns the segment for a given index. More...
 
TIGL_EXPORT CCPACSWingComponentSegmentGetComponentSegment (const std::string &uid)
 Returns the segment for a given uid. More...
 
TIGL_EXPORT int GetComponentSegmentCount () const
 Returns the number of component segments of the wing. More...
 
TIGL_EXPORT TiglGeometricComponentType GetComponentType () const override
 Returns the Component Type TIGL_COMPONENT_WING or TIGL_COMPONENT_ROTORBLADE. More...
 
TIGL_EXPORT CCPACSConfigurationGetConfiguration () const
 Returns the parent configuration. More...
 
TIGL_EXPORT std::vector< CTiglSectionElement * > GetCTiglElements () const
 
TIGL_EXPORT std::string GetDefaultedUID () const override
 
TIGL_EXPORT double GetDihedral (double chordPercentage=0.25) const
 
TIGL_EXPORT std::vector< gp_Pnt > GetGuideCurvePoints ()
 Returns all points that define the guide curves. More...
 
TIGL_EXPORT CCPACSGuideCurveGetGuideCurveSegment (std::string uid)
 Get the guide curve segment (partial guide curve) with a given UID. More...
 
TIGL_EXPORT std::vector< double > GetGuideCurveStartParameters () const
 Returns the relative circumference parameters (as defined in CPACS) (These parameters are calculated to scale the guide curve wire and construct the guide curves) More...
 
TIGL_EXPORT TopoDS_Compound GetGuideCurveWires () const
 Returns a wire consisting of all guide curves as a compound. More...
 
TIGL_EXPORT TopoDS_Shape GetLoftWithCutouts ()
 Returns the wing loft with cut out control surface. More...
 
TIGL_EXPORT TopoDS_Shape & GetLoftWithLeadingEdge ()
 Returns the rebuilt loft of the whole wing with modeled leading edge, if wing shape rebuild is indicated. More...
 
TIGL_EXPORT gp_Pnt GetLowerPoint (int segmentIndex, double eta, double xsi)
 Returns the lower point in absolute (world) coordinates for a given segment, eta, xsi (calculated output may be influenced by setting different value for Enum getPointBehavior) More...
 
TIGL_EXPORT TopoDS_Shape & GetLowerShape ()
 Returns lower loft of the wing and builds it if shells require rebuild. More...
 
TIGL_EXPORT std::vector< std::string > GetOrderedConnectedElement () override
 
TIGL_EXPORT CTiglTransformation GetPositioningTransformation (std::string sectionUID)
 Returns the positioning transformation for a given section uid. More...
 
TIGL_EXPORT double GetReferenceArea (TiglSymmetryAxis symPlane) const
 Returns the reference area of the wing by taking account the quadrilateral portions of each wing segment by projecting the wing segments into the plane defined by the user. More...
 
TIGL_EXPORT double GetReferenceArea () const
 Returns the reference area of the wing in the plane normal to the major direction. More...
 
TIGL_EXPORT CTiglPoint GetRootLEPosition () const
 
TIGL_EXPORT CCPACSWingSectionGetSection (int index)
 Returns the section for a given index. More...
 
TIGL_EXPORT const CCPACSWingSectionGetSection (int index) const
 Returns the section for a given index. More...
 
TIGL_EXPORT int GetSectionCount () const
 Get section count. More...
 
TIGL_EXPORT CCPACSWingSegmentGetSegment (const int index)
 Returns the segment for a given index. More...
 
TIGL_EXPORT const CCPACSWingSegmentGetSegment (const int index) const
 Returns the segment for a given index. More...
 
TIGL_EXPORT CCPACSWingSegmentGetSegment (std::string uid)
 Returns the segment for a given uid. More...
 
TIGL_EXPORT const CCPACSWingSegmentGetSegment (std::string uid) const
 Returns the segment for a given uid. More...
 
TIGL_EXPORT int GetSegmentCount () const
 Returns the number of segments of the wing. More...
 
TIGL_EXPORT int GetSegmentEtaXsi (const gp_Pnt &xyz, double &eta, double &xsi, bool &onTop)
 Calculates the segment coordinates from global (x,y,z) coordinates If x,y,z does not belong to any segment, -1 is returned. More...
 
TIGL_EXPORT double GetSurfaceArea ()
 Returns the surface area of this wing. More...
 
TIGL_EXPORT double GetSweep (double chordPercentage=0.25) const
 
TIGL_EXPORT gp_Pnt GetUpperPoint (int segmentIndex, double eta, double xsi)
 Returns the upper point in absolute (world) coordinates for a given segment, eta, xsi (calculated output may be influenced by setting different value for Enum getPointBehavior) More...
 
TIGL_EXPORT TopoDS_Shape & GetUpperShape ()
 Returns upper loft of the wing and builds it if shells require rebuild. More...
 
TIGL_EXPORT double GetVolume ()
 Returns the volume of this wing (corresponding to CPACS conventions the result will be in SI-units) More...
 
TIGL_EXPORT double GetWettedArea (TopoDS_Shape parent) const
 Returns wetted Area. More...
 
TIGL_EXPORT PNamedShape GetWingCleanShape () const
 Returns the wing shape without flaps cut out. More...
 
TIGL_EXPORT double GetWingHalfSpan ()
 
TIGL_EXPORT void GetWingMAC (double &mac_chord, double &mac_x, double &mac_y, double &mac_z) const
 Returns the mean aerodynamic chord of the wing. More...
 
TIGL_EXPORT double GetWingspan () const
 
TIGL_EXPORT Handle (Geom_Surface) GetLowerSegmentSurface(int index)
 Returns the lower Surface of a Segment. More...
 
TIGL_EXPORT Handle (Geom_Surface) GetUpperSegmentSurface(int index)
 Returns the upper Surface of a Segment. More...
 
TIGL_EXPORT bool IsRotorBlade () const
 Returns whether this wing is a rotor blade. More...
 
TIGL_EXPORT void ReadCPACS (const TixiDocumentHandle &tixiHandle, const std::string &wingXPath) override
 
TIGL_EXPORT void Scale (double scaleF)
 
TIGL_EXPORT void SetAllAirfoils (const std::string &profileUID)
 
TIGL_EXPORT void SetAreaKeepAR (double newArea)
 
TIGL_EXPORT void SetAreaKeepSpan (double newArea)
 
TIGL_EXPORT void SetARKeepArea (double newAR)
 
TIGL_EXPORT void SetARKeepSpan (double newAR)
 
TIGL_EXPORT void SetBuildFlaps (bool enabled)
 Determines, whether the wing should be modeled with the flaps or not. More...
 
TIGL_EXPORT void SetDihedral (double dihedralAngle, double chordPercentage=0.25)
 
TIGL_EXPORT void SetHalfSpanKeepAR (double newHalfSpan)
 
TIGL_EXPORT void SetHalfSpanKeepArea (double newHalfSpan)
 
TIGL_EXPORT void SetParentUID (const boost::optional< std::string > &value) override
 
TIGL_EXPORT void SetRootLEPosition (CTiglPoint newRootPosition)
 
TIGL_EXPORT void SetRotation (CTiglPoint newRot)
 
TIGL_EXPORT void SetSweep (double sweepAngle, double chordPercentage=0.25)
 
TIGL_EXPORT void SetSymmetryAxis (const TiglSymmetryAxis &axis) override
 
TIGL_EXPORT ~CCPACSWing () override
 
- Public Member Functions inherited from tigl::generated::CPACSWing
TIGL_EXPORT CPACSWing (CCPACSRotorBlades *parent, CTiglUIDManager *uidMgr)
 
TIGL_EXPORT CPACSWing (CCPACSWings *parent, CTiglUIDManager *uidMgr)
 
virtual TIGL_EXPORT const boost::optional< CCPACSWingComponentSegments > & GetComponentSegments () const
 
virtual TIGL_EXPORT boost::optional< CCPACSWingComponentSegments > & GetComponentSegments ()
 
virtual TIGL_EXPORT CCPACSWingComponentSegmentsGetComponentSegments (CreateIfNotExistsTag)
 
virtual TIGL_EXPORT const boost::optional< std::string > & GetDescription () const
 
virtual TIGL_EXPORT const std::string & GetName () const
 
virtual TIGL_EXPORT CTiglUIDObjectGetNextUIDParent ()
 
virtual TIGL_EXPORT const CTiglUIDObjectGetNextUIDParent () const
 
template<typename P >
P * GetParent ()
 
template<typename P >
const P * GetParent () const
 
virtual TIGL_EXPORT const boost::optional< std::string > & GetParentUID () const
 
virtual TIGL_EXPORT const boost::optional< CCPACSPositionings > & GetPositionings () const
 
virtual TIGL_EXPORT boost::optional< CCPACSPositionings > & GetPositionings ()
 
virtual TIGL_EXPORT CCPACSPositioningsGetPositionings (CreateIfNotExistsTag)
 
virtual TIGL_EXPORT const CCPACSWingSectionsGetSections () const
 
virtual TIGL_EXPORT CCPACSWingSectionsGetSections ()
 
virtual TIGL_EXPORT const CCPACSWingSegmentsGetSegments () const
 
virtual TIGL_EXPORT CCPACSWingSegmentsGetSegments ()
 
virtual TIGL_EXPORT const boost::optional< TiglSymmetryAxis > & GetSymmetry () const
 
virtual TIGL_EXPORT const CCPACSTransformationGetTransformation () const
 
virtual TIGL_EXPORT CCPACSTransformationGetTransformation ()
 
virtual TIGL_EXPORT const std::string & GetUID () const
 
TIGL_EXPORT CTiglUIDManagerGetUIDManager ()
 
TIGL_EXPORT const CTiglUIDManagerGetUIDManager () const
 
template<typename P >
bool IsParent () const
 
virtual TIGL_EXPORT void RemoveComponentSegments ()
 
virtual TIGL_EXPORT void RemovePositionings ()
 
virtual TIGL_EXPORT void SetDescription (const boost::optional< std::string > &value)
 
virtual TIGL_EXPORT void SetName (const std::string &value)
 
virtual TIGL_EXPORT void SetSymmetry (const boost::optional< TiglSymmetryAxis > &value)
 
virtual TIGL_EXPORT void SetUID (const std::string &value)
 
virtual TIGL_EXPORT void WriteCPACS (const TixiDocumentHandle &tixiHandle, const std::string &xpath) const
 
virtual TIGL_EXPORT ~CPACSWing ()
 
- Public Member Functions inherited from tigl::CTiglReqUIDObject
boost::optional< std::string > GetObjectUID () const
 
virtual ~CTiglReqUIDObject ()=default
 
- Public Member Functions inherited from tigl::CTiglUIDObject
TIGL_EXPORT void Invalidate (const boost::optional< std::string > &source=boost::none) const
 
- Public Member Functions inherited from tigl::ITiglUIDRefObject
virtual ~ITiglUIDRefObject ()=default
 
- Public Member Functions inherited from tigl::CTiglRelativelyPositionedComponent
TIGL_EXPORT CTiglRelativelyPositionedComponent (MaybeOptionalPtr< std::string > parentUid, MaybeOptionalPtr< CCPACSTransformation > trans)
 
TIGL_EXPORT CTiglRelativelyPositionedComponent (MaybeOptionalPtr< std::string > parentUid, MaybeOptionalPtr< CCPACSTransformation > trans, boost::optional< TiglSymmetryAxis > *symmetryAxis)
 
TIGL_EXPORT ChildContainerType GetChildren (bool recursive)
 
TIGL_EXPORT boost::optional< const std::string & > GetParentUID () const
 
virtual TIGL_EXPORT CTiglPoint GetRotation () const
 
virtual TIGL_EXPORT CTiglPoint GetScaling () const
 
TIGL_EXPORT TiglSymmetryAxis GetSymmetryAxis () const override
 
virtual TIGL_EXPORT CTiglTransformation GetTransformationMatrix () const
 
virtual TIGL_EXPORT CTiglPoint GetTranslation () const
 
virtual TIGL_EXPORT ECPACSTranslationType GetTranslationType () const
 
TIGL_EXPORT void Reset () const
 
TIGL_EXPORT void SetParentUID (const std::string &parentUID)
 
virtual TIGL_EXPORT void SetTransformation (const CCPACSTransformation &transform)
 
- Public Member Functions inherited from tigl::CTiglAbstractGeometricComponent
 CTiglAbstractGeometricComponent ()
 
TIGL_EXPORT Bnd_Box const & GetBoundingBox () const
 
virtual TIGL_EXPORT bool GetIsOn (const gp_Pnt &pnt) const
 
TIGL_EXPORT bool GetIsOnMirrored (const gp_Pnt &pnt) const
 
TIGL_EXPORT PNamedShape GetLoft () const override
 
virtual TIGL_EXPORT PNamedShape GetMirroredLoft () const
 
TIGL_EXPORT void Reset () const
 
- Public Member Functions inherited from tigl::ITiglGeometricComponent
virtual ~ITiglGeometricComponent ()
 

Data Fields

TiglGetPointBehavior getPointBehavior {asParameterOnSurface}
 

Protected Member Functions

void BuildFusedSegments (PNamedShape &) const
 
void BuildGuideCurveWires (LocatedGuideCurves &cache) const
 
PNamedShape BuildLoft () const override
 
void BuildUpperLowerShells ()
 
void Cleanup ()
 
void SetWingHelper (CTiglWingHelper &cache) const
 
void Update ()
 
- Protected Member Functions inherited from tigl::CTiglUIDObject
 ~CTiglUIDObject ()=default
 

Private Member Functions

void BuildWingWithCutouts (PNamedShape &) const
 
std::string GetShortShapeName () const
 
PNamedShape GroupedFlapsAndWingShapes () const
 
void InvalidateImpl (const boost::optional< std::string > &source) const override
 

Private Attributes

bool buildFlaps
 
CCPACSConfigurationconfiguration
 
FusedElementsContainerType fusedElements
 
TopoDS_Shape fusedSegmentWithEdge
 
Cache< LocatedGuideCurves, CCPACSWingguideCurves
 
bool isRotorBlade
 
TopoDS_Shape lowerShape
 
double myVolume
 
bool rebuildFusedSegWEdge
 
bool rebuildShells
 
TopoDS_Shape upperShape
 
Cache< PNamedShape, CCPACSWingwingCleanShape
 
Cache< CTiglWingHelper, CCPACSWingwingHelper
 
Cache< PNamedShape, CCPACSWingwingShapeWithCutouts
 

Friends

class CCPACSWingComponentSegment
 
class CCPACSWingSegment
 
class CTiglStandardizer
 
class CTiglWingBuilder
 

Additional Inherited Members

- Public Types inherited from tigl::CTiglRelativelyPositionedComponent
typedef std::vector< CTiglRelativelyPositionedComponent * > ChildContainerType
 
- Protected Types inherited from tigl::CTiglRelativelyPositionedComponent
typedef std::map< int, int > FusedElementsContainerType
 
- Protected Attributes inherited from tigl::generated::CPACSWing
boost::optional< CCPACSWingComponentSegmentsm_componentSegments
 
boost::optional< std::string > m_description
 Description of the wing. More...
 
std::string m_name
 Name of the wing. More...
 
void * m_parent
 
const std::type_info * m_parentType
 
boost::optional< std::string > m_parentUID
 UID of part to which the wing is mounted (if any). The parent of the wing can e.g. be the fuselage. In each aircraft model, there is exactly one part without a parent part (The root of the connection hierarchy). More...
 
boost::optional< CCPACSPositioningsm_positionings
 
CCPACSWingSections m_sections
 
CCPACSWingSegments m_segments
 
boost::optional< TiglSymmetryAxism_symmetry
 
CCPACSTransformation m_transformation
 
std::string m_uID
 
CTiglUIDManagerm_uidMgr
 
- Protected Attributes inherited from tigl::CTiglAbstractGeometricComponent
Cache< Bnd_Box, CTiglAbstractGeometricComponentbounding_box
 
Cache< PNamedShape, CTiglAbstractGeometricComponentloft
 

Constructor & Destructor Documentation

◆ CCPACSWing() [1/2]

TIGL_EXPORT tigl::CCPACSWing::CCPACSWing ( CCPACSWings parent,
CTiglUIDManager uidMgr 
)

Constructor of Class CCPACSWing Constructor is automatically called during reading of a CPACS-file. Not intended to be called manually.

Parameters
parent
uidMgr

◆ CCPACSWing() [2/2]

TIGL_EXPORT tigl::CCPACSWing::CCPACSWing ( CCPACSRotorBlades parent,
CTiglUIDManager uidMgr 
)

Constructor of Class CCPACSWing Constructor is automatically called during reading of a CPACS-file. Not intended to be called manually.

Parameters
parent
uidMgr

◆ ~CCPACSWing()

TIGL_EXPORT tigl::CCPACSWing::~CCPACSWing ( )
override

Member Function Documentation

◆ BuildFusedSegments()

void tigl::CCPACSWing::BuildFusedSegments ( PNamedShape ) const
protected

◆ BuildGuideCurveWires()

void tigl::CCPACSWing::BuildGuideCurveWires ( LocatedGuideCurves cache) const
protected

◆ BuildLoft()

PNamedShape tigl::CCPACSWing::BuildLoft ( ) const
overrideprotectedvirtual

◆ BuildUpperLowerShells()

void tigl::CCPACSWing::BuildUpperLowerShells ( )
protected

◆ BuildWingWithCutouts()

void tigl::CCPACSWing::BuildWingWithCutouts ( PNamedShape ) const
private

◆ Cleanup()

void tigl::CCPACSWing::Cleanup ( )
protected

◆ CreateNewConnectedElementAfter()

TIGL_EXPORT void tigl::CCPACSWing::CreateNewConnectedElementAfter ( std::string  startElementUID)
overridevirtual

Create a new section, a new element and connect the element to the "startElement". The new element is placed "after" the start element. If there is already a element after the start element, we split the existing segment and insert the new element between the the two elements.

Parameters
startElementUID

Implements tigl::CreateConnectedElementI.

◆ CreateNewConnectedElementBefore()

TIGL_EXPORT void tigl::CCPACSWing::CreateNewConnectedElementBefore ( std::string  startElementUID)
overridevirtual

Create a new section, a new element and connect the element to the "startElement". The new element is placed "Before" the start element. If there is already a element before the start element, we split the existing segment and insert the new element between the the two elements.

Parameters
startElementUID

Implements tigl::CreateConnectedElementI.

◆ CreateNewConnectedElementBetween()

TIGL_EXPORT void tigl::CCPACSWing::CreateNewConnectedElementBetween ( std::string  startElementUID,
std::string  endElementUID 
)
overridevirtual

Create a new section, a new element and place the new element between the startElement and the endElement.

Remarks
The startElement and endElement must be connected by a segment.
Parameters
startElementUID
endElementUID

Implements tigl::CreateConnectedElementI.

◆ DeleteConnectedElement()

TIGL_EXPORT void tigl::CCPACSWing::DeleteConnectedElement ( std::string  ElementUID)
overridevirtual

Delete the connected element. This mean that the section containing the element is delete and the segment associated with this element are either deleted or updated.

Parameters
ElementUID

Implements tigl::CreateConnectedElementI.

◆ GetAllUsedAirfoils()

TIGL_EXPORT std::vector<std::string> tigl::CCPACSWing::GetAllUsedAirfoils ( )
Returns
Return all the uid of the airfoils used by this wing

◆ GetAspectRatio()

TIGL_EXPORT double tigl::CCPACSWing::GetAspectRatio ( ) const

Returns the aspect ratio of the wing.

Returns
double

◆ GetChordPoint()

TIGL_EXPORT gp_Pnt tigl::CCPACSWing::GetChordPoint ( int  segmentIndex,
double  eta,
double  xsi,
TiglCoordinateSystem  referenceCS = GLOBAL_COORDINATE_SYSTEM 
)

Returns a point on the chord surface in absolute (world) coordinates for a given segment, eta, xsi, if fourth parameter is ommited, otherwise it will give you the point in the chosen coordinate system (e.g. WING_COORDINATE_SYSTEM)

Parameters
segmentIndex
eta
xsi
referenceCS
Returns
gp_nP

◆ GetComponentIntent()

TIGL_EXPORT TiglGeometricComponentIntent tigl::CCPACSWing::GetComponentIntent ( ) const
inlineoverridevirtual

◆ GetComponentSegment() [1/3]

TIGL_EXPORT CCPACSWingComponentSegment& tigl::CCPACSWing::GetComponentSegment ( const int  index)

Returns the segment for a given index.

Parameters
indexSegment index
Returns
CCPACSWingComponentSegment&

◆ GetComponentSegment() [2/3]

TIGL_EXPORT const CCPACSWingComponentSegment& tigl::CCPACSWing::GetComponentSegment ( const int  index) const

Returns the segment for a given index.

Parameters
indexSegment index
Returns
CCPACSWingComponentSegment&

◆ GetComponentSegment() [3/3]

TIGL_EXPORT CCPACSWingComponentSegment& tigl::CCPACSWing::GetComponentSegment ( const std::string &  uid)

Returns the segment for a given uid.

Parameters
uidSegment UID
Returns
CCPACSWingComponentSegment&

◆ GetComponentSegmentCount()

TIGL_EXPORT int tigl::CCPACSWing::GetComponentSegmentCount ( ) const

Returns the number of component segments of the wing.

Returns
int

◆ GetComponentType()

TIGL_EXPORT TiglGeometricComponentType tigl::CCPACSWing::GetComponentType ( ) const
inlineoverridevirtual

Returns the Component Type TIGL_COMPONENT_WING or TIGL_COMPONENT_ROTORBLADE.

Implements tigl::ITiglGeometricComponent.

◆ GetConfiguration()

TIGL_EXPORT CCPACSConfiguration& tigl::CCPACSWing::GetConfiguration ( ) const

Returns the parent configuration.

Returns
CCPACSConfiguration&

◆ GetCTiglElements()

TIGL_EXPORT std::vector<CTiglSectionElement* > tigl::CCPACSWing::GetCTiglElements ( ) const

◆ GetDefaultedUID()

TIGL_EXPORT std::string tigl::CCPACSWing::GetDefaultedUID ( ) const
overridevirtual

◆ GetDihedral()

TIGL_EXPORT double tigl::CCPACSWing::GetDihedral ( double  chordPercentage = 0.25) const

◆ GetGuideCurvePoints()

TIGL_EXPORT std::vector<gp_Pnt> tigl::CCPACSWing::GetGuideCurvePoints ( )

Returns all points that define the guide curves.

Returns
std::vector<gp_Pnt> Returns a vector containing all points definig the guide curves

◆ GetGuideCurveSegment()

TIGL_EXPORT CCPACSGuideCurve& tigl::CCPACSWing::GetGuideCurveSegment ( std::string  uid)

Get the guide curve segment (partial guide curve) with a given UID.

Parameters
uidUID of the segment
Returns
CCPACSGuideCurve&

◆ GetGuideCurveStartParameters()

TIGL_EXPORT std::vector<double> tigl::CCPACSWing::GetGuideCurveStartParameters ( ) const

Returns the relative circumference parameters (as defined in CPACS) (These parameters are calculated to scale the guide curve wire and construct the guide curves)

Returns
std::vector<double>

◆ GetGuideCurveWires()

TIGL_EXPORT TopoDS_Compound tigl::CCPACSWing::GetGuideCurveWires ( ) const

Returns a wire consisting of all guide curves as a compound.

Returns
TopoDS_Compound

◆ GetLoftWithCutouts()

TIGL_EXPORT TopoDS_Shape tigl::CCPACSWing::GetLoftWithCutouts ( )

Returns the wing loft with cut out control surface.

Returns
TopoDS_Shape Returns the wing shape with cutouts

◆ GetLoftWithLeadingEdge()

TIGL_EXPORT TopoDS_Shape& tigl::CCPACSWing::GetLoftWithLeadingEdge ( )

Returns the rebuilt loft of the whole wing with modeled leading edge, if wing shape rebuild is indicated.

Returns
TopoDS_Shape& Returns the wing shape

◆ GetLowerPoint()

TIGL_EXPORT gp_Pnt tigl::CCPACSWing::GetLowerPoint ( int  segmentIndex,
double  eta,
double  xsi 
)

Returns the lower point in absolute (world) coordinates for a given segment, eta, xsi (calculated output may be influenced by setting different value for Enum getPointBehavior)

Parameters
segmentIndex
eta
xsi
Returns
gp_nP

◆ GetLowerShape()

TIGL_EXPORT TopoDS_Shape& tigl::CCPACSWing::GetLowerShape ( )

Returns lower loft of the wing and builds it if shells require rebuild.

Returns
TooDS_Shape

◆ GetOrderedConnectedElement()

TIGL_EXPORT std::vector<std::string> tigl::CCPACSWing::GetOrderedConnectedElement ( )
overridevirtual

Return the current connected element uids in order for this component (wing or fuselage)

Returns

Implements tigl::CreateConnectedElementI.

◆ GetPositioningTransformation()

TIGL_EXPORT CTiglTransformation tigl::CCPACSWing::GetPositioningTransformation ( std::string  sectionUID)

Returns the positioning transformation for a given section uid.

Parameters
sectionUID
Returns
CTiglTransformation

◆ GetReferenceArea() [1/2]

TIGL_EXPORT double tigl::CCPACSWing::GetReferenceArea ( TiglSymmetryAxis  symPlane) const

Returns the reference area of the wing by taking account the quadrilateral portions of each wing segment by projecting the wing segments into the plane defined by the user.

Parameters
symPlaneThe TiglSymmetryAxis is defined as follows: TIGL_NO_SYMMETRY = 0, TIGL_X_Y_PLANE = 1, TIGL_X_Z_PLANE = 2, TIGL_Y_Z_PLANE = 3, TIGL_INHERIT_SYMMETRY = 4
Returns
double

◆ GetReferenceArea() [2/2]

TIGL_EXPORT double tigl::CCPACSWing::GetReferenceArea ( ) const

Returns the reference area of the wing in the plane normal to the major direction.

Returns
double

◆ GetRootLEPosition()

TIGL_EXPORT CTiglPoint tigl::CCPACSWing::GetRootLEPosition ( ) const

◆ GetSection() [1/2]

TIGL_EXPORT CCPACSWingSection& tigl::CCPACSWing::GetSection ( int  index)

Returns the section for a given index.

Returns
CCPACSWingSection&

◆ GetSection() [2/2]

TIGL_EXPORT const CCPACSWingSection& tigl::CCPACSWing::GetSection ( int  index) const

Returns the section for a given index.

Returns
CCPACSWingSection&

◆ GetSectionCount()

TIGL_EXPORT int tigl::CCPACSWing::GetSectionCount ( ) const

Get section count.

Returns
int

◆ GetSegment() [1/4]

TIGL_EXPORT CCPACSWingSegment& tigl::CCPACSWing::GetSegment ( const int  index)

Returns the segment for a given index.

Parameters
indexSegment index
Returns
CCPACSWingSegment&

◆ GetSegment() [2/4]

TIGL_EXPORT const CCPACSWingSegment& tigl::CCPACSWing::GetSegment ( const int  index) const

Returns the segment for a given index.

Parameters
indexSegment index
Returns
CCPACSWingSegment&

◆ GetSegment() [3/4]

TIGL_EXPORT CCPACSWingSegment& tigl::CCPACSWing::GetSegment ( std::string  uid)

Returns the segment for a given uid.

Parameters
uidSegment UID
Returns
CCPACSWingSegment&

◆ GetSegment() [4/4]

TIGL_EXPORT const CCPACSWingSegment& tigl::CCPACSWing::GetSegment ( std::string  uid) const

Returns the segment for a given uid.

Parameters
uidSegment UID
Returns
CCPACSWingSegment&

◆ GetSegmentCount()

TIGL_EXPORT int tigl::CCPACSWing::GetSegmentCount ( ) const

Returns the number of segments of the wing.

Parameters
index
Returns
int

◆ GetSegmentEtaXsi()

TIGL_EXPORT int tigl::CCPACSWing::GetSegmentEtaXsi ( const gp_Pnt &  xyz,
double &  eta,
double &  xsi,
bool &  onTop 
)

Calculates the segment coordinates from global (x,y,z) coordinates If x,y,z does not belong to any segment, -1 is returned.

Parameters
xyzGlobal (x,y,z) coordinates
[in]eta
[in]xsi
[out]eta
[out]xsi
onTop
Returns
int Returns -1 if x,y,z does not belong to any segment

◆ GetShortShapeName()

std::string tigl::CCPACSWing::GetShortShapeName ( ) const
private

◆ GetSurfaceArea()

TIGL_EXPORT double tigl::CCPACSWing::GetSurfaceArea ( )

Returns the surface area of this wing.

Returns
double

◆ GetSweep()

TIGL_EXPORT double tigl::CCPACSWing::GetSweep ( double  chordPercentage = 0.25) const

◆ GetUpperPoint()

TIGL_EXPORT gp_Pnt tigl::CCPACSWing::GetUpperPoint ( int  segmentIndex,
double  eta,
double  xsi 
)

Returns the upper point in absolute (world) coordinates for a given segment, eta, xsi (calculated output may be influenced by setting different value for Enum getPointBehavior)

Parameters
segmentIndex
eta
xsi
Returns
gp_nP

◆ GetUpperShape()

TIGL_EXPORT TopoDS_Shape& tigl::CCPACSWing::GetUpperShape ( )

Returns upper loft of the wing and builds it if shells require rebuild.

Returns
TopoDS_Shape

◆ GetVolume()

TIGL_EXPORT double tigl::CCPACSWing::GetVolume ( )

Returns the volume of this wing (corresponding to CPACS conventions the result will be in SI-units)

Returns
double

◆ GetWettedArea()

TIGL_EXPORT double tigl::CCPACSWing::GetWettedArea ( TopoDS_Shape  parent) const

Returns wetted Area.

Parameters
parent
Returns
double

◆ GetWingCleanShape()

TIGL_EXPORT PNamedShape tigl::CCPACSWing::GetWingCleanShape ( ) const

Returns the wing shape without flaps cut out.

Returns
PNamedShape

◆ GetWingHalfSpan()

TIGL_EXPORT double tigl::CCPACSWing::GetWingHalfSpan ( )

Returns the half span of the wing If the wing is not mirrored, return the whole width.

Remarks
The span is computed using bounding Box. So, the result may no be exactly correct
Returns
half span of the wing

◆ GetWingMAC()

TIGL_EXPORT void tigl::CCPACSWing::GetWingMAC ( double &  mac_chord,
double &  mac_x,
double &  mac_y,
double &  mac_z 
) const

Returns the mean aerodynamic chord of the wing.

Parameters
mac_chord
mac_x
may_y
mac_z

◆ GetWingspan()

TIGL_EXPORT double tigl::CCPACSWing::GetWingspan ( ) const

◆ GroupedFlapsAndWingShapes()

PNamedShape tigl::CCPACSWing::GroupedFlapsAndWingShapes ( ) const
private

◆ Handle() [1/2]

TIGL_EXPORT tigl::CCPACSWing::Handle ( Geom_Surface  )

Returns the lower Surface of a Segment.

Parameters
indexIndex of the segment
Returns
Handle(Geom_Surface) Returns Handle to the lower surface of a segment

◆ Handle() [2/2]

TIGL_EXPORT tigl::CCPACSWing::Handle ( Geom_Surface  )

Returns the upper Surface of a Segment.

Parameters
indexIndex of the segment
Returns
Handle(Geom_Surface) Returns Handle to the upper surface of a segment

◆ InvalidateImpl()

void tigl::CCPACSWing::InvalidateImpl ( const boost::optional< std::string > &  source) const
overrideprivatevirtual

Reimplemented from tigl::CTiglUIDObject.

◆ IsRotorBlade()

TIGL_EXPORT bool tigl::CCPACSWing::IsRotorBlade ( ) const

Returns whether this wing is a rotor blade.

Returns
bool

◆ ReadCPACS()

TIGL_EXPORT void tigl::CCPACSWing::ReadCPACS ( const TixiDocumentHandle &  tixiHandle,
const std::string &  wingXPath 
)
overridevirtual

Reimplemented from tigl::generated::CPACSWing.

◆ Scale()

TIGL_EXPORT void tigl::CCPACSWing::Scale ( double  scaleF)

Scale the wing uniformly. The root leading point stay at the same position.

Parameters
scaleFthe scale factor

◆ SetAllAirfoils()

TIGL_EXPORT void tigl::CCPACSWing::SetAllAirfoils ( const std::string &  profileUID)

Set the airfoil uid of all the section elements of this wing.

Parameters
profileUID; the airfoil UID to use

◆ SetAreaKeepAR()

TIGL_EXPORT void tigl::CCPACSWing::SetAreaKeepAR ( double  newArea)

Set the wing reference area while keeping the aspect ratio constant. The area is set scaling the wing uniformly.

Remarks
The span will change.
Parameters
newArea

◆ SetAreaKeepSpan()

TIGL_EXPORT void tigl::CCPACSWing::SetAreaKeepSpan ( double  newArea)

Set the wing reference area while keeping the span constant. To obtain the wanted area each airfoil is scaled by the same factor. The leading point of each airfoil stay at the same position.

Remarks
The aspect ratio will change.
The tip airfoil is also scaled, so it is possible that the the span change slighly if the tip airfoil is not parallel to the deep axis.
Parameters
newArea

◆ SetARKeepArea()

TIGL_EXPORT void tigl::CCPACSWing::SetARKeepArea ( double  newAR)

Set the wing aspect ratio (AR) while keeping the area constant. The span will change so that the AR is reached.

Parameters
newAR

◆ SetARKeepSpan()

TIGL_EXPORT void tigl::CCPACSWing::SetARKeepSpan ( double  newAR)

Set the wing aspect ratio (AR) while keeping the span constant. The area will change so that the AR is reached.

Parameters
newAR

◆ SetBuildFlaps()

TIGL_EXPORT void tigl::CCPACSWing::SetBuildFlaps ( bool  enabled)

Determines, whether the wing should be modeled with the flaps or not.

Parameters
enabledSet 'True' if wing should be built with flags

◆ SetDihedral()

TIGL_EXPORT void tigl::CCPACSWing::SetDihedral ( double  dihedralAngle,
double  chordPercentage = 0.25 
)

◆ SetHalfSpanKeepAR()

TIGL_EXPORT void tigl::CCPACSWing::SetHalfSpanKeepAR ( double  newHalfSpan)

Set the wing half span while keeping the aspect ratio constant. The span is set scaling the wing uniformly.

Remarks
The area will change.
Parameters
newArea

◆ SetHalfSpanKeepArea()

TIGL_EXPORT void tigl::CCPACSWing::SetHalfSpanKeepArea ( double  newHalfSpan)

Set the wing half span while keeping the area constant. The span is set by first scaling the wing uniformly, then resetting the area while keeping the span constant.

Remarks
The aspect ratio will change.
Parameters
newArea

◆ SetParentUID()

TIGL_EXPORT void tigl::CCPACSWing::SetParentUID ( const boost::optional< std::string > &  value)
overridevirtual

Reimplemented from tigl::generated::CPACSWing.

◆ SetRootLEPosition()

TIGL_EXPORT void tigl::CCPACSWing::SetRootLEPosition ( CTiglPoint  newRootPosition)

◆ SetRotation()

TIGL_EXPORT void tigl::CCPACSWing::SetRotation ( CTiglPoint  newRot)

◆ SetSweep()

TIGL_EXPORT void tigl::CCPACSWing::SetSweep ( double  sweepAngle,
double  chordPercentage = 0.25 
)

◆ SetSymmetryAxis()

TIGL_EXPORT void tigl::CCPACSWing::SetSymmetryAxis ( const TiglSymmetryAxis axis)
overridevirtual

◆ SetWingHelper()

void tigl::CCPACSWing::SetWingHelper ( CTiglWingHelper cache) const
protected

◆ Update()

void tigl::CCPACSWing::Update ( )
protected

Friends And Related Function Documentation

◆ CCPACSWingComponentSegment

friend class CCPACSWingComponentSegment
friend

◆ CCPACSWingSegment

friend class CCPACSWingSegment
friend

◆ CTiglStandardizer

friend class CTiglStandardizer
friend

◆ CTiglWingBuilder

friend class CTiglWingBuilder
friend

Field Documentation

◆ buildFlaps

bool tigl::CCPACSWing::buildFlaps
private

Indicates if the wing's loft shall include flaps

◆ configuration

CCPACSConfiguration* tigl::CCPACSWing::configuration
private

Parent configuration

◆ fusedElements

FusedElementsContainerType tigl::CCPACSWing::fusedElements
private

Stores already fused segments

◆ fusedSegmentWithEdge

TopoDS_Shape tigl::CCPACSWing::fusedSegmentWithEdge
private

All Segments in one shape plus modelled leading edge

◆ getPointBehavior

TiglGetPointBehavior tigl::CCPACSWing::getPointBehavior {asParameterOnSurface}

sets behavior of the GetPoint-function (default: asParameterOnSurface)

◆ guideCurves

Cache<LocatedGuideCurves, CCPACSWing> tigl::CCPACSWing::guideCurves
private

◆ isRotorBlade

bool tigl::CCPACSWing::isRotorBlade
private

Indicates if this wing is a rotor blade

◆ lowerShape

TopoDS_Shape tigl::CCPACSWing::lowerShape
private

◆ myVolume

double tigl::CCPACSWing::myVolume
private

Volume of this Wing

◆ rebuildFusedSegWEdge

bool tigl::CCPACSWing::rebuildFusedSegWEdge
mutableprivate

Indicates if segmentation fusing need rebuild

◆ rebuildShells

bool tigl::CCPACSWing::rebuildShells
mutableprivate

◆ upperShape

TopoDS_Shape tigl::CCPACSWing::upperShape
private

◆ wingCleanShape

Cache<PNamedShape, CCPACSWing> tigl::CCPACSWing::wingCleanShape
private

Clean wing surface without flaps cutout

◆ wingHelper

Cache<CTiglWingHelper, CCPACSWing> tigl::CCPACSWing::wingHelper
private

◆ wingShapeWithCutouts

Cache<PNamedShape, CCPACSWing> tigl::CCPACSWing::wingShapeWithCutouts
private

Wing without flaps / flaps removed


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