New doc structure for TurbVelocityFieldBts
@@ -16,11 +16,13 @@ class TurbVelocityFieldBts(generator_interface.BaseGenerator):
``TurbVelocitityFieldBts`` is a class inherited from ``BaseGenerator``
- The ``TurbVelocitityFieldBts`` class generates a velocity field based on the input from abts file generated by TurbSim.
+ The ``TurbVelocitityFieldBts`` class generates a velocity field based on
+ the input from a bts file generated by TurbSim.
https://nwtc.nrel.gov/TurbSim
To call this generator, the ``generator_id = TurbVelocityField`` shall be used.
- This is parsed as the value for the ``velocity_field_generator`` key in the desired aerodynamic solver's settings.
+ This is parsed as the value for the ``velocity_field_generator``
+ key in the desired aerodynamic solver's settings.
Args:
in_dict (dict): Input data in the form of dictionary. See acceptable entries below:
@@ -43,30 +45,41 @@ class TurbVelocityFieldBts(generator_interface.BaseGenerator):
"""
generator_id = 'TurbVelocityFieldBts'
+ generator_classification = 'TurbVelocityFieldBts'
- def __init__(self):
- self.in_dict = dict()
- self.settings_types = dict()
- self.settings_default = dict()
+ settings_types = dict()
+ settings_default = dict()
+ settings_description = dict()
+
+ settings_types['print_info'] = 'bool'
+ settings_default['print_info'] = True
+ settings_description['print_info'] = 'Output solver-specific information in runtime'
- self.settings_types['print_info'] = 'bool'
- self.settings_default['print_info'] = True
+ settings_types['turbulent_field'] = 'str'
+ settings_default['turbulent_field'] = None
+ settings_description['turbulent_field'] = 'XDMF file path of the velocity file'
- self.settings_types['turbulent_field'] = 'str'
- self.settings_default['turbulent_field'] = None
+ settings_types['new_orientation'] = 'str'
+ settings_default['new_orientation'] = 'xyz'
+ settings_description['new_orientation'] = 'New order of the axes'
- self.settings_types['new_orientation'] = 'str'
- self.settings_default['new_orientation'] = 'xyz'
+ settings_types['u_fed'] = 'list(float)'
+ settings_default['u_fed'] = np.zeros((3,))
+ settings_description['u_fed'] = 'Velocity at which the turbulence field is fed into the solid'
- self.settings_types['u_fed'] = 'list(float)'
- self.settings_default['u_fed'] = np.zeros((3,))
+ settings_types['u_out'] = 'list(float)'
+ settings_default['u_out'] = np.zeros((3,))
+ settings_description['u_out'] = 'Velocity to set for points outside the interpolating box'
- self.settings_types['u_out'] = 'list(float)'
- self.settings_default['u_out'] = np.zeros((3,))
+ settings_types['case_with_tower'] = 'bool'
+ settings_default['case_with_tower'] = False
+ settings_description['case_with_tower'] = 'Will the SHARPy case include the tower in the simulation?'
- self.settings_types['case_with_tower'] = 'bool'
- self.settings_default['case_with_tower'] = False
+ settings_table = settings.SettingsTable()
+ __doc__ += settings_table.generate(settings_types, settings_default, settings_description)
+ def __init__(self):
+ self.in_dict = dict()
self.settings = dict()
self.interpolator = []
