Source code for RCAIDE.Library.Methods.Aerodynamics.Athena_Vortex_Lattice.write_input_deck
# RCAIDE/Library/Methods/Aerodynamics/Athena_Vortex_Lattice/write_input_deck.py
#
# Created: Oct 2024, M. Clarke
# ----------------------------------------------------------------------------------------------------------------------
# IMPORT
# ----------------------------------------------------------------------------------------------------------------------
# RCAIDE imports
from RCAIDE.Library.Components.Wings.Control_Surfaces import Aileron , Elevator , Rudder
from RCAIDE.Framework.Core import Units
from .purge_files import purge_files
# ----------------------------------------------------------------------------------------------------------------------
# write_input_deck
# ----------------------------------------------------------------------------------------------------------------------
[docs]
def make_case_command(avl_object,case,trim_aircraft,control_surfaces):
""" Makes commands for case execution in AVL
Assumptions:
None
Source:
None
Inputs:
case.index
case.tag
case.result_filename
Outputs:
case_command
Properties Used:
N/A
"""
# This is a template (place holder) for the input deck. Think of it as the actually keys
# you will type if you were to manually run an analysis
base_case_command = \
'''{0}{1}{2}{3}{4}
x
{5}
{6}
{7}
{8}
{9}
{10}
{11}
{12}
'''
# if trim analysis is specified, this function writes the trim commands else it
# uses the defined deflection of the control surfaces of the aircraft
if trim_aircraft:
trim_command = make_trim_text_command(case, avl_object)
beta_command = make_beta_text_command(case)
roll_rate_command = make_roll_rate_text_command(case)
pitch_rate_command = make_pitch_rate_text_command(case)
else:
roll_rate_command = ''
pitch_rate_command = ''
beta_command = ''
if control_surfaces:
trim_command = control_surface_deflection_command(case,avl_object)
else:
trim_command = ''
index = case.index
case_tag = case.tag
# AVL executable commands which correlate to particular result types
aero_command_1 = 'st' # stability axis derivatives
aero_command_2 = 'fn' # surface forces
aero_command_3 = 'fs' # strip forces
aero_command_4 = 'sb' # body axis derivatives
# create aliases for filenames for future handling
aero_file_1 = case.aero_result_filename_1
aero_file_2 = case.aero_result_filename_2
aero_file_3 = case.aero_result_filename_3
aero_file_4 = case.aero_result_filename_4
# purge files
if not avl_object.settings.keep_files:
purge_files([aero_file_1])
purge_files([aero_file_2])
purge_files([aero_file_3])
# write input deck for avl executable
case_command = base_case_command.format(index,trim_command,roll_rate_command,pitch_rate_command ,beta_command,aero_command_1 , aero_file_1 ,aero_command_2 \
, aero_file_2 , aero_command_3 , aero_file_3, aero_command_4 , aero_file_4)
return case_command
[docs]
def make_trim_text_command(case,avl_object):
""" Writes the trim command currently for a specified AoA or flight CL condition
Assumptions:
None
Source:
None
Inputs:
case
Outputs:
trim_command
Properties Used:
N/A
"""
cs_template = \
'''
D{0}
{1}
'''
cs_idx = 1
cs_commands = ''
for wing in avl_object.vehicle.wings:
for ctrl_surf in wing.control_surfaces:
if type(ctrl_surf) == Aileron:
control = 'RM'
cs_command = cs_template.format(cs_idx,control)
cs_commands = cs_commands + cs_command
cs_idx += 1
elif type(ctrl_surf) == Elevator:
control = 'PM'
cs_command = cs_template.format(cs_idx,control)
cs_commands = cs_commands + cs_command
cs_idx += 1
elif type(ctrl_surf) == Rudder:
control = 'YM'
cs_command = cs_template.format(cs_idx,control)
cs_commands = cs_commands + cs_command
cs_idx += 1
else:
cs_idx += 1
base_trim_command = \
'''
c1
{0}
{1}
'''
# if Angle of Attack command is specified, write A
if case.conditions.aerodynamics.coefficients.lift.total == None:
condition = 'A'
val = case.conditions.aerodynamics.angles.alpha
elif case.conditions.aerodynamics.coefficients.lift.total > 0:
condition = 'C'
val = case.conditions.aerodynamics.coefficients.lift.total
else:
trim_command = ''
return trim_command
# write trim commands into template
trim_command = base_trim_command.format(condition,val)
return cs_commands + trim_command
[docs]
def make_roll_rate_text_command(case):
""" Writes the roll rate command currently for a specified flight condition
Assumptions:
None
Source:
None
Inputs:
case
Outputs:
trim_command
Properties Used:
N/A
"""
base_roll_command = \
'''
R
R
{0}'''
roll_rate_coeff = case.conditions.static_stability.coefficients.roll
if roll_rate_coeff != 0.0:
roll_command = base_roll_command.format(roll_rate_coeff)
else:
roll_command = ''
return roll_command
[docs]
def make_pitch_rate_text_command(case):
""" Writes the pitch rate command currently for a specified flight condition
Assumptions:
None
Source:
None
Inputs:
case
Outputs:
trim_command
Properties Used:
N/A
"""
base_pitch_command = \
'''
Y
Y
{0}'''
pitch_rate_coeff = case.conditions.static_stability.coefficients.pitch
if pitch_rate_coeff != 0.0:
blade_pitch_command = base_pitch_command.format(pitch_rate_coeff)
else:
blade_pitch_command = ''
return blade_pitch_command
[docs]
def make_beta_text_command(case):
""" Writes the roll rate command currently for a specified flight condition
Assumptions:
None
Source:
None
Inputs:
case
Outputs:
trim_command
Properties Used:
N/A
"""
base_roll_command = \
'''
B
B
{0}'''
beta = case.conditions.aerodynamics.angles.beta
if beta != 0.0:
beta_command = base_roll_command.format(beta)
else:
beta_command = ''
return beta_command
[docs]
def control_surface_deflection_command(case,avl_object):
"""Writes the control surface command template
Assumptions:
None
Source:
None
Inputs:
avl_object
case
Outputs:
em_case_command
Properties Used:
N/A
"""
cs_template = \
'''
D{0}
D{1}
{2}'''
cs_idx = 1
cs_commands = ''
for wing in avl_object.vehicle.wings:
for ctrl_surf in wing.control_surfaces:
cs_command = cs_template.format(cs_idx,cs_idx,round(ctrl_surf.deflection/Units.degrees,4))
cs_commands = cs_commands + cs_command
cs_idx += 1
return cs_commands
