PR

OpenVSPのPythonAPIのWingGeomで利用できるパラメータ一覧

OpenVSPのPythonAPIのWingGeomで利用できるパラメータ一覧について説明する

スポンサーリンク

パラメータ一覧

OpenVSPのPythonAPIのWingGeomで利用できるパラメータ一覧はこんな感じ(スペース区切りでAND検索可能)

parm_name type discription
X_Location double Global X Location
Y_Location double Global Y Location
Z_Location double Global Z Location
X_Rotation double Global X Rotation
Y_Rotation double Global Y Rotation
Z_Rotation double Global Z Rotation
Origin double Rotation Origin
X_Rel_Location double X Location Relative to Parent
Y_Rel_Location double Y Location Relative to Parent
Z_Rel_Location double Z Location Relative to Parent
X_Rel_Rotation double X Rotation Relative to Parent
Y_Rel_Rotation double Y Rotation Relative to Parent
Z_Rel_Rotation double Z Rotation Relative to Parent
Abs_Or_Relitive_flag int -
Trans_Attach_Flag int Determines relative translation coordinate system
Rots_Attach_Flag int Determines relative rotation axes
U_Attach_Location double U Location on parent's surface
U_01 boolean The U value is specified in [0, 1] basis or [0, N] basis.
U_Attach_Location0N double U Location on parent's surface on [0,N] basis.
V_Attach_Location double V Location on parent's surface
R_Attach_Location double R Location in parent's volume
R_01 boolean The R value is specified in [0, 1] basis or [0, N] basis.
R_Attach_Location0N double R Location in parent's volume on [0,N] basis.
S_Attach_Location double S Location in parent's volume
T_Attach_Location double T Location in parent's volume
L_Attach_Location double L Location in parent's volume
L_01 boolean The L value is specified in [0, 1] basis or dimensional basis.
L_Attach_Location0Len double L Location in parent's volume on [0,Len] basis.
M_Attach_Location double M Location in parent's volume
N_Attach_Location double N Location in parent's volume
Eta_Attach_Location double Eta Location in parent's volume
Scale double Scale Geometry Size
Last_Scale double Last Scale Value
Tess_U int Number of tessellated curves in the U direction
Tess_W limited int Number of tessellated curves in the W direction
Wake boolean Flag that indicates if this WingGeom has wakes attached
WakeScale double Wake length scale
WakeAngle double Wake angle in degrees
X_Len double X length of geom bounding box
Y_Len double Y length of geom bounding box
Z_Len double Z length of geom bounding box
X_Min double Minimum X coordinate of geom bounding box
Y_Min double Minimum Y coordinate of geom bounding box
Z_Min double Minimum Z coordinate of geom bounding box
Sym_Ancestor int -
Sym_Ancestor_Origin_Flag boolean -
Sym_Planar_Flag int -
Sym_Axial_Flag int -
Sym_Rot_N int -
Density double Volumetric density (mass/len^3)
Mass_Area double Areal density (mass/len^2)
Mass_Prior int Priority for volume overlap. Highest priority wins.
Shell_Flag boolean Flag to turn on/off area-based mass contribution
PointMass double -
CGx double -
CGy double -
CGz double -
Ixx double -
Iyy double -
Izz double -
Ixy double -
Ixz double -
Iyz double -
Negative_Volume_Flag boolean -
CapUMinOption int Type of End Cap on Wing Root
CapUMinLength double Scaled length of end cap
CapUMinOffset double Scaled offset of end cap
CapUMinStrength double Tangent strength of end cap
CapUMinSweepFlag boolean Flag to stretch end cap length for sweep
CapUMinTess int Number of tessellated curves on Wing Root and Tip
CapUMaxOption int Type of End Cap on Wing Tip
CapUMaxLength double Scaled length of end cap
CapUMaxOffset double Scaled offset of end cap
CapUMaxStrength double Tangent strength of end cap
CapUMaxSweepFlag boolean Flag to stretch end cap length for sweep
PercLam double Percentage Laminar
FFBodyEqnType int Equation that defines the form factor of a body type surface included this Geom
FFWingEqnType int Equation that defines the form factor of a wing type surface included this Geom
FFUser double User Input Form Factor Value
Q double Interference Factor
Roughness double Roughness Height
TeTwRatio double Temperature Ratio of Freestream to Wall
TawTwRatio double Temperature Ratio of Ambient Wall to Wall
IncorporatedGen int Ancestor Generation that incorporates this geoms Swet
ExpandedList boolean Flag to determine whether or not this geom has a collapsed list in parasite drag
ActiveXSec int -
RelativeDihedralFlag boolean Relative or Absolute Dihedral
RelativeTwistFlag boolean Relative or Absolute Twist
RotateAirfoilMatchDideralFlag boolean Rotate all foils perpendicular to dihedral
CorrectAirfoilthicknessFlag boolean Scale airfoil thickness to correct for dihedral rotation
TotalSpan double Total Planform Span
TotalProjectedSpan double Total Projected Planform Span
TotalChord double Total Planform Chord
TotalArea double Total Planform Area
TotalAR double Total Aspect Ratio
LECluster double LE Tess Cluster Control
TECluster double TE Tess Cluster Control
SmallPanelW double Smallest LE/TE panel width
MaxGrowth double Maximum chordwise panel growth ratio
ActiveAirfoil int -
SectTess_U int Number of tessellated curves in the U direction for this section
InLESweep double -
InTESweep double -
InLEDihedral double -
InTEDihedral double -
InLEStrength double -
InTEStrength double -
OutLESweep double -
OutTESweep double -
OutLEDihedral double -
OutTEDihedral double -
OutLEStrength double -
OutTEStrength double -
InLEMode int -
OutLEMode int -
InTEMode int -
OutTEMode int -
ProjectedSpan double Projected Span of Wing Section
Aspect double Aspect Ratio of Wing Section
Taper double Taper Ratio of Wing Section
Area double Area of Wing Section
Span double Span of Wing Section
Avg_Chord double Avg Chord of Wing Section
Tip_Chord double Tip Chord of Wing Section
Root_Chord double Root Chord of Wing Section
Sec_Sweep double Secondary Sweep of Wing Section
Sweep double Sweep of Wing Section
Sweep_Location noteq Location Along Chord That Sweep is Measured For Wing Section
Sec_Sweep_Location noteq Location Along Chord That Secondary Sweep is Measured For Wing Section
Twist double Twist of Wing Section
Twist_Location double Location Along Chord That Airfoil is Rotated
Dihedral double Dihedral of Wing Section
RotateMatchDideralFlag boolean Rotate foil perpendicular to dihedral
InCluster double Inboard Tess Cluster Control
OutCluster double Outboard Tess Cluster Control
TE_Close_Type int -
TE_Close_AbsRel int -
TE_Close_Thick double Thickness for trailing edge closure
TE_Close_Thick_Chord double T/C for trailing edge closure
LE_Close_Type int -
LE_Close_AbsRel int -
LE_Close_Thick double Thickness for leading edge closure
LE_Close_Thick_Chord double T/C for leading edge closure
TE_Trim_Type int -
TE_Trim_AbsRel int -
TE_Trim_X double X length to trim trailing edge
TE_Trim_X_Chord double X/C length to trim trailing edge
TE_Trim_Thick double Thickness to trim trailing edge
TE_Trim_Thick_Chord double T/C to trim trailing edge
LE_Trim_Type int -
LE_Trim_AbsRel int -
LE_Trim_X double X length to trim leading edge
LE_Trim_X_Chord double X/C length to trim leading edge
LE_Trim_Thick double Thickness to trim leading edge
LE_Trim_Thick_Chord double T/C to trim leading edge
TE_Cap_Type int -
TE_Cap_Length double -
TE_Cap_Offset double -
TE_Cap_Strength double -
LE_Cap_Type int -
LE_Cap_Length double -
LE_Cap_Offset double -
LE_Cap_Strength double -
Theta double -
Scale double -
DeltaX double -
DeltaY double -
ShiftLE double -
Chevron_Type int -
Number int -
On_Duty double -
Off_Duty double -
AllSym boolean Set all chevron angles equal.
TBSym boolean Set top/bottom chevron angles equal.
RLSym boolean Set left/right chevron angles equal.
W01_Mode int -
W01_Start_Guide int -
W01_Start double -
W01_End_Guide int -
W01_End double -
W01_Center_Guide int -
W01_Center double -
W01_Width double -
TopAmplitude double -
BottomAmplitude double -
LeftAmplitude double -
RightAmplitude double -
Top_Angle double -
Bottom_Angle double -
Right_Angle double -
Left_Angle double -
Top_Slew double -
Bottom_Slew double -
Right_Slew double -
Left_Slew double -
Valley_Radius double -
Peak_Radius double -
XSecImagePreserveAR boolean -
XSecImageFlag boolean -
XSecLockImageFlag boolean -
XSecImageW fraction -
XSecImageH fraction -
XSecImageXOffset fraction -
XSecImageYOffset fraction -
XSecFlipImageFlag boolean -
Area double XSec Area
HWRatio double XSec H/W Ratio
Invert boolean -
Chord double -
ThickChord double -
FitDegree int -
Camber double -
CamberLoc double -
SharpTEFlag boolean -
IdealCl double -
CamberInputFlag int -
SectTess_U int Number of tessellated curves in the U direction for this section
InLESweep double -
InTESweep double -
InLEDihedral double -
InTEDihedral double -
InLEStrength double -
InTEStrength double -
OutLESweep double -
OutTESweep double -
OutLEDihedral double -
OutTEDihedral double -
OutLEStrength double -
OutTEStrength double -
InLEMode int -
OutLEMode int -
InTEMode int -
OutTEMode int -
ProjectedSpan double Projected Span of Wing Section
Aspect double Aspect Ratio of Wing Section
Taper double Taper Ratio of Wing Section
Area double Area of Wing Section
Span double Span of Wing Section
Avg_Chord double Avg Chord of Wing Section
Tip_Chord double Tip Chord of Wing Section
Root_Chord double Root Chord of Wing Section
Sec_Sweep double Secondary Sweep of Wing Section
Sweep double Sweep of Wing Section
Sweep_Location noteq Location Along Chord That Sweep is Measured For Wing Section
Sec_Sweep_Location noteq Location Along Chord That Secondary Sweep is Measured For Wing Section
Twist double Twist of Wing Section
Twist_Location double Location Along Chord That Airfoil is Rotated
Dihedral double Dihedral of Wing Section
RotateMatchDideralFlag boolean Rotate foil perpendicular to dihedral
InCluster double Inboard Tess Cluster Control
OutCluster double Outboard Tess Cluster Control
TE_Close_Type int -
TE_Close_AbsRel int -
TE_Close_Thick double Thickness for trailing edge closure
TE_Close_Thick_Chord double T/C for trailing edge closure
LE_Close_Type int -
LE_Close_AbsRel int -
LE_Close_Thick double Thickness for leading edge closure
LE_Close_Thick_Chord double T/C for leading edge closure
TE_Trim_Type int -
TE_Trim_AbsRel int -
TE_Trim_X double X length to trim trailing edge
TE_Trim_X_Chord double X/C length to trim trailing edge
TE_Trim_Thick double Thickness to trim trailing edge
TE_Trim_Thick_Chord double T/C to trim trailing edge
LE_Trim_Type int -
LE_Trim_AbsRel int -
LE_Trim_X double X length to trim leading edge
LE_Trim_X_Chord double X/C length to trim leading edge
LE_Trim_Thick double Thickness to trim leading edge
LE_Trim_Thick_Chord double T/C to trim leading edge
TE_Cap_Type int -
TE_Cap_Length double -
TE_Cap_Offset double -
TE_Cap_Strength double -
LE_Cap_Type int -
LE_Cap_Length double -
LE_Cap_Offset double -
LE_Cap_Strength double -
Theta double -
Scale double -
DeltaX double -
DeltaY double -
ShiftLE double -
Chevron_Type int -
Number int -
On_Duty double -
Off_Duty double -
AllSym boolean Set all chevron angles equal.
TBSym boolean Set top/bottom chevron angles equal.
RLSym boolean Set left/right chevron angles equal.
W01_Mode int -
W01_Start_Guide int -
W01_Start double -
W01_End_Guide int -
W01_End double -
W01_Center_Guide int -
W01_Center double -
W01_Width double -
TopAmplitude double -
BottomAmplitude double -
LeftAmplitude double -
RightAmplitude double -
Top_Angle double -
Bottom_Angle double -
Right_Angle double -
Left_Angle double -
Top_Slew double -
Bottom_Slew double -
Right_Slew double -
Left_Slew double -
Valley_Radius double -
Peak_Radius double -
XSecImagePreserveAR boolean -
XSecImageFlag boolean -
XSecLockImageFlag boolean -
XSecImageW fraction -
XSecImageH fraction -
XSecImageXOffset fraction -
XSecImageYOffset fraction -
XSecFlipImageFlag boolean -
Area double XSec Area
HWRatio double XSec H/W Ratio
Invert boolean -
Chord double -
ThickChord double -
FitDegree int -
Camber double -
CamberLoc double -
SharpTEFlag boolean -
IdealCl double -
CamberInputFlag int -

PARM_TYPE = { 
    vsp.PARM_DOUBLE_TYPE : 'double',
    vsp.PARM_INT_TYPE : 'int',
    vsp.PARM_BOOL_TYPE : 'boolean',
    vsp.PARM_FRACTION_TYPE : 'fraction',
    vsp.PARM_LIMITED_INT_TYPE : 'limited int',
    vsp.PARM_NOTEQ_TYPE : 'noteq',
    vsp.PARM_POWER_INT_TYPE : 'power int',
}

def print_parm_discription(geom_id):
    parm_array = vsp.GetGeomParmIDs( geom_id )
    print(f'| {"parm_name":25s}', f'| {"type":<12s}', '| discription |')
    print('| --- | --- | --- |')
    for parm_id in parm_array:
        parm_name = vsp.GetParmName(parm_id)
        parm_type = vsp.GetParmType(parm_id)
        parm_discription = vsp.GetParmDescript(parm_id)

        print(f'| {parm_name:25s}', f'| {PARM_TYPE.get(parm_type, "Unknown"):12s}', '\t|', parm_discription.replace('Default Description', '-'), '|')

geom_id = vsp.AddGeom("WING")
vsp.SetGeomName(geom_id, "WingGeom")
print_parm_discription(geom_id)

使用しているメソッドは以下の通り

PARM_TYPEの定義はGithubのソースにある

OpenVSP/src/geom_api/APIDefines.h at main ?? OpenVSP/OpenVSP
A parametric aircraft geometry tool. Contribute to OpenVSP/OpenVSP development by creating an account on GitHub.

全部で332個あり、とてもじゃないが説明しきれないので、主要なパラメータのみ説明する

幾何学的配置・位置・回転関連

パラメータ説明
X_Location, Y_Location, Z_Locationdoubleグローバル座標での幾何学の位置
X_Rotation, Y_Rotation, Z_Rotationdoubleグローバル座標系での回転角
X_Rel_Location, Y_Rel_Location, Z_Rel_Locationdouble親ジオメトリに対する相対位置
X_Rel_Rotation, Y_Rel_Rotation, Z_Rel_Rotationdouble親ジオメトリに対する相対回転

翼形状関連

パラメータ説明
TotalSpandouble全翼幅
TotalAreadouble翼面積
TotalChorddouble翼弦長
TotalARdoubleアスペクト比
Twistdouble翼捩じり角(トゥイスト)
Dihedraldouble翼捻角(上反角)
Sweepdouble後退角
Taperdoubleテーパー比
Avg_Chorddouble平均弦長
Tip_Chord, Root_Chorddouble翼端弦長、翼根弦長

TotalChordAvg_Chord平均空力翼弦長(MAC)ではないので注意!!

翼の面分割・メッシュ制御関連

パラメータ説明
Tess_U, Tess_Wint翼のU/W方向メッシュ分割数
LECluster, TEClusterdouble前縁/後縁のメッシュ集中度
InCluster, OutClusterdouble内側/外側セクションのメッシュ調整

質量・慣性特性関連

パラメータ説明
Densitydouble材料密度
Mass_Areadouble面密度(翼など)
PointMassdouble集中質量
CGx, CGy, CGzdouble重心位置
Ixx, Iyy, Izz, Ixy, Ixz, Iyzdouble慣性モーメント

おわりに

OpenVSPのPythonAPIのWingGeomで利用できるパラメータ一覧を示した。

↓関連記事

OpenVSP
質問・感想・意見などあれば気軽にTwitterのDMかコメントお願いします!
スポンサーリンク

コメント