SUAVE.Analyses.Aerodynamics.Vortex_Lattice.Vortex_Lattice Class Reference

Inheritance diagram for SUAVE.Analyses.Aerodynamics.Vortex_Lattice.Vortex_Lattice:

Public Member Functions
def	__defaults__ (self)
def	initialize (self, use_surrogate, n_sw, n_cw, propeller_wake_model, mf, mn, dcs)
def	evaluate_surrogate (self, state, settings, geometry)
def	evaluate_no_surrogate (self, state, settings, geometry)
def	sample_training (self)
def	build_surrogate (self)
Public Member Functions inherited from SUAVE.Analyses.Aerodynamics.Aerodynamics.Aerodynamics
def	evaluate (self, state)
def	finalize (self)
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
	geometry
	settings
	training
	hsub_min
	hsub_max
	hsup_min
	hsup_max
	surrogates
	evaluate
Public Attributes inherited from SUAVE.Analyses.Aerodynamics.Aerodynamics.Aerodynamics
	tag
	geometry
	settings
Public Attributes inherited from SUAVE.Analyses.Analysis.Analysis
	tag
	features
	settings

Detailed Description

This builds a surrogate and computes lift using a basic vortex lattice.

Assumptions:
None

Source:
None

Member Function Documentation

__defaults__()

def SUAVE.Analyses.Aerodynamics.Vortex_Lattice.Vortex_Lattice.__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.Aerodynamics.Aerodynamics.Aerodynamics.

build_surrogate()

def SUAVE.Analyses.Aerodynamics.Vortex_Lattice.Vortex_Lattice.build_surrogate

(

self

)

Build a surrogate using sample evaluation results.

Assumptions:
None

Source:
N/A

Inputs:
see properties used

Outputs:
self.surrogates.
  lift_coefficient            
  wing_lift_coefficient       
  drag_coefficient            
  wing_drag_coefficient

Properties Used:
self.training.
  lift_coefficient            [-] 
  wing_lift_coefficient       [-] (wing specific)
  drag_coefficient            [-] 
  wing_drag_coefficient       [-] (wing specific)

evaluate_no_surrogate()

def SUAVE.Analyses.Aerodynamics.Vortex_Lattice.Vortex_Lattice.evaluate_no_surrogate	(		self,
			state,
			settings,
			geometry
	)

Evaluates lift and drag directly using VLM

Assumptions:
no changes to initial geometry or settings

Source:
N/A

Inputs:
state.conditions.
  angle_of_attack                         [radians]
  
Outputs:
conditions.aerodynamics.lift_breakdown.
  inviscid_wings_lift[wings.*.tag]        [-] CL (wing specific)
  inviscid_wings_lift.total               [-] CL
  inviscid_wings_sectional                [-] Cly  
  compressible_wing                       [-] CL (wing specific)
conditions.aerodynamics.drag_breakdown.induced.
  total                                   [-] CDi 
  inviscid                                [-] CDi 
  wings_sectional_drag                    [-] CDiy (wing specific)
  induced.inviscid_wings                  [-] CDi  (wing specific)        
    
conditions.aerodynamics.
  pressure_coefficient                    [-] CP
 
Properties Used:
self.surrogates.
  lift_coefficient                        [-] CL
  wing_lift_coefficient[wings.*.tag]      [-] CL (wing specific)

evaluate_surrogate()

def SUAVE.Analyses.Aerodynamics.Vortex_Lattice.Vortex_Lattice.evaluate_surrogate	(		self,
			state,
			settings,
			geometry
	)

Evaluates lift and drag using available surrogates.

Assumptions:
None

Source:
N/A

Inputs:
state.conditions.
  freestream.dynamics_pressure       [-]
  angle_of_attack                    [radians]

Outputs:
conditions.aerodynamics.lift_breakdown.
  inviscid_wings[wings.*.tag]             [-] CL (wing specific)
  inviscid_wings_lift.total               [-] CL
  compressible_wing                       [-] CL (wing specific)
conditions.aerodynamics.lift_coefficient  [-] CL
conditions.aerodynamics.drag_breakdown.induced.
  total                                   [-] CDi 
  inviscid                                [-] CDi 
  wings_sectional_drag                    [-] CDiy (wing specific)
  inviscid_wings                          [-] CDi (wing specific)
  
Properties Used:
self.surrogates.
  lift_coefficient                        [-] CL
  wing_lift_coefficient[wings.*.tag]      [-] CL (wing specific)

initialize()

def SUAVE.Analyses.Aerodynamics.Vortex_Lattice.Vortex_Lattice.initialize	(		self,
			use_surrogate,
			n_sw,
			n_cw,
			propeller_wake_model,
			mf,
			mn,
			dcs
	)

Drives functions to get training samples and build a surrogate.

Assumptions:
None

Source:
N/A

Inputs:
use_surrogate                                       [bool]
n_sw                   number of spanwise vortices  [int]
n_cw                   number of chordwise vortices [int]
propeller_wake_model                                [bool] 

Outputs:
None

Properties Used:
None

sample_training()

def SUAVE.Analyses.Aerodynamics.Vortex_Lattice.Vortex_Lattice.sample_training

(

self

)

Call methods to run vortex lattice for sample point evaluation.

Assumptions:
None

Source:
N/A

Inputs:
see properties used

Outputs:
self.training.
  lift_coefficient            [-] 
  wing_lift_coefficient       [-] (wing specific)
  drag_coefficient            [-]          

  wing_drag_coefficient       [-] (wing specific)

Properties Used:
self.geometry.wings.*.tag
self.settings                 (passed to calculate vortex lattice)
self.training.angle_of_attack [radians]

---

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

• /Users/emiliobotero/Dropbox/SUAVE/SUAVE/trunk/SUAVE/Analyses/Aerodynamics/Vortex_Lattice.py