SUAVE  2.5.2
An Aerospace Vehicle Environment for Designing Future Aircraft
SUAVE.Analyses.Stability.AVL.AVL Class Reference
Inheritance diagram for SUAVE.Analyses.Stability.AVL.AVL:
SUAVE.Analyses.Stability.Stability.Stability SUAVE.Analyses.Analysis.Analysis

Public Member Functions

def __defaults__ (self)
 
def finalize (self)
 
def __call__ (self, conditions)
 
def sample_training (self)
 
def build_surrogate (self)
 
def evaluate_conditions (self, run_conditions, trim_aircraft)
 
- Public Member Functions inherited from SUAVE.Analyses.Stability.Stability.Stability
def evaluate (self, conditions)
 
- Public Member Functions inherited from SUAVE.Analyses.Analysis.Analysis
def compile (self, *args, **kwarg)
 
def initialize (self, *args, **kwarg)
 
def evaluate (self, *args, **kwarg)
 
def finalize (self, *args, **kwarg)
 
def __call__ (self, *args, **kwarg)
 

Public Attributes

 tag
 
 current_status
 
 geometry
 
 settings
 
 training
 
 training_file
 
 surrogates
 
 configuration
 
- Public Attributes inherited from SUAVE.Analyses.Stability.Stability.Stability
 tag
 
 geometry
 
 settings
 
- Public Attributes inherited from SUAVE.Analyses.Analysis.Analysis
 tag
 
 features
 
 settings
 

Detailed Description

This builds a surrogate and computes moment using AVL.

Assumptions:
None

Source:
None

Member Function Documentation

◆ __call__()

def SUAVE.Analyses.Stability.AVL.AVL.__call__ (   self,
  conditions 
)
Evaluates moment coefficient, stability and body axis deriviatives and neutral point using available surrogates.

Assumptions:
None

Source:
N/A

Inputs:
state.conditions.
  mach_number      [-]
  angle_of_attack  [radians]

Outputs:
results
    results.stability.static
    results.stability.dynamic


Properties Used:
self.surrogates.
   pitch_moment_coefficient [-] CM
   cm_alpha                 [-] Cm_alpha
   cn_beta                  [-] Cn_beta
   neutral_point            [-] NP

◆ __defaults__()

def SUAVE.Analyses.Stability.AVL.AVL.__defaults__ (   self)
This sets the default values and methods for the analysis.

Assumptions:
None

Source:
N/A

Inputs:
None

Outputs:
None

Properties Used:
N/A

Reimplemented from SUAVE.Analyses.Stability.Stability.Stability.

◆ build_surrogate()

def SUAVE.Analyses.Stability.AVL.AVL.build_surrogate (   self)
Builds a surrogate based on sample evalations using a Guassian process.

Assumptions:
None

Source:
N/A

Inputs:
self.training.
  coefficients     [-] CM, Cm_alpha, Cn_beta 
  neutral point    [meters] NP
  grid_points      [radians,-] angles of attack and Mach numbers 

Outputs:
self.surrogates.
  moment_coefficient           
  Cm_alpha_moment_coefficient  
  Cn_beta_moment_coefficient   
  neutral_point                      

Properties Used:
No others

◆ evaluate_conditions()

def SUAVE.Analyses.Stability.AVL.AVL.evaluate_conditions (   self,
  run_conditions,
  trim_aircraft 
)
Process vehicle to setup geometry, condititon, and configuration.

Assumptions:
None

Source:
N/A

Inputs:
run_conditions <SUAVE data type> aerodynamic conditions; until input
method is finalized, will assume mass_properties are always as 
defined in self.features

Outputs:
results        <SUAVE data type>

Properties Used:
self.settings.filenames.
  run_folder
  output_template
  batch_template
  deck_template
self.current_status.
  batch_index
  batch_file
  deck_file
  cases

◆ finalize()

def SUAVE.Analyses.Stability.AVL.AVL.finalize (   self)
Drives functions to get training samples and build a surrogate.

Assumptions:
None

Source:
N/A

Inputs:
None

Outputs:
self.tag = 'avl_analysis_of_{}'.format( )

Properties Used:
self.geometry.tag

Reimplemented from SUAVE.Analyses.Stability.Stability.Stability.

◆ sample_training()

def SUAVE.Analyses.Stability.AVL.AVL.sample_training (   self)
Call methods to run AVL for sample point evaluation.

Assumptions:
None

Source:
N/A

Inputs:
see properties used

Outputs:
self.training.
  coefficients     [-] CM, Cm_alpha, Cn_beta
  neutral point    [-] NP
  grid_points      [radians,-] angles of attack and Mach numbers 

Properties Used:
self.geometry.tag  <string>
self.training.     
  angle_of_attack  [radians]
  Mach             [-]
self.training_file (optional - file containing previous AVL data)

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