SUAVE.Components.Energy.Networks.Propulsor_Surrogate.Propulsor_Surrogate Class Reference

Inheritance diagram for SUAVE.Components.Energy.Networks.Propulsor_Surrogate.Propulsor_Surrogate:

Public Member Functions
def	__defaults__ (self)
def	evaluate_thrust (self, state)
def	build_surrogate (self)
def	extended_thrust_surrogate (self, thr_surrogate, cond, lo_blender, hi_blender)
def	extended_sfc_surrogate (self, sfc_surrogate, cond, lo_blender, hi_blender)

Public Attributes
	engine_length
	number_of_engines
	tag
	input_file
	sfc_surrogate
	thrust_surrogate
	orientation_euler_angles
	areas
	surrogate_type
	altitude_input_scale
	thrust_input_scale
	sfc_anchor
	sfc_anchor_scale
	sfc_anchor_conditions
	thrust_anchor
	thrust_anchor_scale
	thrust_anchor_conditions
	sfc_rubber_scale
	use_extended_surrogate
	sealevel_static_thrust
	negative_throttle_values
	sfc_input_scale
Public Attributes inherited from SUAVE.Components.Energy.Networks.Network.Network
	tag
	generative_design_max_per_vehicle
	non_dimensional_origin
	number_of_engines
	engine_length
	wing_mounted
	areas
Public Attributes inherited from SUAVE.Components.Physical_Component.Physical_Component
	tag
	mass_properties
	origin
	symmetric
Public Attributes inherited from SUAVE.Components.Component.Component
	tag
	origin
	generative_design_max_per_vehicle
	generative_design_characteristics
	generative_design_special_parent

Detailed Description

This is a way for you to load engine data from a source.
    A .csv file is read in, a surrogate made, that surrogate is used during the mission analysis.
    
    You need to use build surrogate first when setting up the vehicle to make this work.
    
    Assumptions:
    The input format for this should be Altitude, Mach, Throttle, Thrust, SFC
    
    Source:
    None

Member Function Documentation

__defaults__()

def SUAVE.Components.Energy.Networks.Propulsor_Surrogate.Propulsor_Surrogate.__defaults__

(

self

)

This sets the default values for the network to function

    Assumptions:
    None
    
    Source:
    N/A
    
    Inputs:
    None
    
    Outputs:
    None
    
    Properties Used:
    N/A

Reimplemented from SUAVE.Components.Energy.Networks.Network.Network.

Reimplemented in SUAVE.Components.Energy.Networks.PyCycle.PyCycle.

build_surrogate()

def SUAVE.Components.Energy.Networks.Propulsor_Surrogate.Propulsor_Surrogate.build_surrogate

(

self

)

Build a surrogate. Multiple options for models are available including:
    -Gaussian Processes
    -KNN
    -SVR
    
    Assumptions:
    None
    
    Source:
    N/A
    
    Inputs:
    state [state()]
    
    Outputs:
    self.sfc_surrogate    [fun()]
    self.thrust_surrogate [fun()]
    
    Properties Used:
    Defaulted values

Reimplemented in SUAVE.Components.Energy.Networks.PyCycle.PyCycle.

evaluate_thrust()

def SUAVE.Components.Energy.Networks.Propulsor_Surrogate.Propulsor_Surrogate.evaluate_thrust	(		self,
			state
	)

Calculate thrust given the current state of the vehicle

    Assumptions:
    None
    
    Source:
    N/A
    
    Inputs:
    state [state()]
    
    Outputs:
    results.thrust_force_vector [newtons]
    results.vehicle_mass_rate   [kg/s]
    
    Properties Used:
    Defaulted values

extended_sfc_surrogate()

def SUAVE.Components.Energy.Networks.Propulsor_Surrogate.Propulsor_Surrogate.extended_sfc_surrogate	(		self,
			sfc_surrogate,
			cond,
			lo_blender,
			hi_blender
	)

Fixes sfc values outside of the standard throttle range in order to provide
    reasonable values outside of the typical surrogate coverage area. 
    
    Assumptions:
    None
    
    Source:
    N/A
    
    Inputs:
    sfc_surrogate     - Trained sklearn surrogate that outputs a scaled sfc value
    cond              - nx3 numpy array with input conditions for the surrogate
    lo_blender        - Cubic spline blending class that is used at the low throttle cutoff
    hi_blender        - Cubic spline blending class that is used at the high throttle cutoff
    
    Outputs:
    sfcs              [nondim]
    
    Properties Used:
    None

extended_thrust_surrogate()

def SUAVE.Components.Energy.Networks.Propulsor_Surrogate.Propulsor_Surrogate.extended_thrust_surrogate	(		self,
			thr_surrogate,
			cond,
			lo_blender,
			hi_blender
	)

Fixes thrust values outside of the standard throttle range in order to provide
    reasonable values outside of the typical surrogate coverage area. 
    
    Assumptions:
    None
    
    Source:
    N/A
    
    Inputs:
    thr_surrogate     - Trained sklearn surrogate that outputs a scaled thrust value
    cond              - nx3 numpy array with input conditions for the surrogate
    lo_blender        - Cubic spline blending class that is used at the low throttle cutoff
    hi_blender        - Cubic spline blending class that is used at the high throttle cutoff
    
    Outputs:
    T                 [nondim]
    
    Properties Used:
    None

---

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

• /Users/emiliobotero/Dropbox/SUAVE/SUAVE/trunk/SUAVE/Components/Energy/Networks/Propulsor_Surrogate.py