import numpy as np
import sharpy.utils.generator_interface as generator_interface
import sharpy.utils.settings as settings
import sharpy.utils.solver_interface as solver_interface
import sharpy.utils.cout_utils as cout
[docs]@generator_interface.generator
class StraightWake(generator_interface.BaseGenerator):
r"""
Straight wake shape generator
``StraightWake`` class inherited from ``BaseGenerator``
The object creates a straight wake shedding from the trailing edge based on
the time step ``dt``, the incoming velocity magnitude ``u_inf`` and
direction ``u_inf_direction``
"""
generator_id = 'StraightWake'
settings_types = dict()
settings_default = dict()
settings_description = dict()
settings_types['u_inf'] = 'float'
settings_default['u_inf'] = 1. # None
settings_description['u_inf'] = 'Free stream velocity magnitude'
settings_types['u_inf_direction'] = 'list(float)'
settings_default['u_inf_direction'] = np.array([1.0, 0, 0]) # None
settings_description['u_inf_direction'] = '``x``, ``y`` and ``z`` relative components of the free stream velocity'
settings_types['dt'] = 'float'
settings_default['dt'] = 0.1 # None
settings_description['dt'] = 'Time step'
settings_types['dx1'] = 'float'
settings_default['dx1'] = -1.0
settings_description['dx1'] = 'Size of the first wake panel'
settings_types['ndx1'] = 'int'
settings_default['ndx1'] = 1
settings_description['ndx1'] = 'Number of panels with size ``dx1``'
settings_types['r'] = 'float'
settings_default['r'] = 1.
settings_description['r'] = 'Growth rate after ``ndx1`` panels'
settings_types['dxmax'] = 'float'
settings_default['dxmax'] = -1.0
settings_description['dxmax'] = 'Maximum panel size'
setting_table = settings.SettingsTable()
__doc__ += setting_table.generate(settings_types, settings_default, settings_description)
def __init__(self):
self.in_dict = dict()
self.u_inf = 0.
self.u_inf_direction = None
self.dt = None
def initialise(self, data, in_dict=None):
self.in_dict = in_dict
# For backwards compatibility
if len(self.in_dict.keys()) == 0:
cout.cout_wrap("WARNING: The code will run for backwards compatibility. \
In future releases you will need to define a 'wake_shape_generator' in ``AerogridLoader''. \
Please, check the documentation", 3)
# Look for an aerodynamic solver
if 'StaticUvlm' in data.settings:
aero_solver_name = 'StaticUvlm'
aero_solver_settings = data.settings['StaticUvlm']
elif 'SHWUvlm' in data.settings:
aero_solver_name = 'SHWUvlm'
aero_solver_settings = data.settings['SHWUvlm']
elif 'StaticCoupled' in data.settings:
aero_solver_name = data.settings['StaticCoupled']['aero_solver']
aero_solver_settings = data.settings['StaticCoupled']['aero_solver_settings']
elif 'StaticCoupledRBM' in data.settings:
aero_solver_name = data.settings['StaticCoupledRBM']['aero_solver']
aero_solver_settings = data.settings['StaticCoupledRBM']['aero_solver_settings']
elif 'DynamicCoupled' in data.settings:
aero_solver_name = data.settings['DynamicCoupled']['aero_solver']
aero_solver_settings = data.settings['DynamicCoupled']['aero_solver_settings']
elif 'StepUvlm' in data.settings:
aero_solver_name = 'StepUvlm'
aero_solver_settings = data.settings['StepUvlm']
else:
raise RuntimeError("ERROR: aerodynamic solver not found")
# Get the minimum parameters needed to define the wake
aero_solver = solver_interface.solver_from_string(aero_solver_name)
settings.to_custom_types(aero_solver_settings,
aero_solver.settings_types,
aero_solver.settings_default)
if 'dt' in aero_solver_settings.keys():
dt = aero_solver_settings['dt'].value
elif 'rollup_dt' in aero_solver_settings.keys():
dt = aero_solver_settings['rollup_dt'].value
else:
# print(aero_solver['velocity_field_input']['u_inf'])
dt = 1./aero_solver_settings['velocity_field_input']['u_inf'].value
self.in_dict = {'u_inf': aero_solver_settings['velocity_field_input']['u_inf'],
'u_inf_direction': aero_solver_settings['velocity_field_input']['u_inf_direction'],
'dt': dt}
settings.to_custom_types(self.in_dict, self.settings_types, self.settings_default, no_ctype=True)
self.u_inf = self.in_dict['u_inf']
self.u_inf_direction = self.in_dict['u_inf_direction']
self.dt = self.in_dict['dt']
if self.in_dict['dx1'] == -1:
self.dx1 = self.u_inf*self.dt
else:
self.dx1 = self.in_dict['dx1']
self.ndx1 = self.in_dict['ndx1']
self.r = self.in_dict['r']
if self.in_dict['dxmax'] == -1:
self.dxmax = self.dx1
def generate(self, params):
# Renaming for convenience
zeta = params['zeta']
zeta_star = params['zeta_star']
gamma = params['gamma']
gamma_star = params['gamma_star']
nsurf = len(zeta)
for isurf in range(nsurf):
M, N = zeta_star[isurf][0, :, :].shape
for j in range(N):
zeta_star[isurf][:, 0, j] = zeta[isurf][:, -1, j]
zeta_star[isurf][:, 1, j] = zeta_star[isurf][:, 0, j] + self.dx1*self.u_inf_direction
for i in range(2, self.ndx1 + 1):
zeta_star[isurf][:, i, j] = zeta_star[isurf][:, i-1, j] + self.dx1*self.u_inf_direction
for i in range(self.ndx1 + 1, M):
# print(self.dx1, self.r, i, self.ndx1)
deltax = self.dx1*self.r**(i - self.ndx1)
if deltax > self.dxmax:
deltax = self.dxmax
zeta_star[isurf][:, i, j] = zeta_star[isurf][:, i-1, j] + deltax*self.u_inf_direction
gamma[isurf] *= 0.
gamma_star[isurf] *= 0.
# print(zeta_star[isurf][0, :, 0])