diff --git a/baseclasses/problems/FluidProperties.py b/baseclasses/problems/FluidProperties.py index d09c16e..c33fafa 100644 --- a/baseclasses/problems/FluidProperties.py +++ b/baseclasses/problems/FluidProperties.py @@ -3,6 +3,9 @@ class FluidProperties: """ + This class is the parent of pyAero_problem and defines the basic flow properties to be passed to the solver. + It also has a method to update the dynamic viscosity through the Sutherland's law based on flow temperature and other optional user inputs. + Parameters ---------- diff --git a/baseclasses/problems/pyFieldPerformance_problem.py b/baseclasses/problems/pyFieldPerformance_problem.py index a932463..035f046 100644 --- a/baseclasses/problems/pyFieldPerformance_problem.py +++ b/baseclasses/problems/pyFieldPerformance_problem.py @@ -55,7 +55,8 @@ class FieldPerformanceProblem: span : float Total wingspan - ** Note ** Thrust and weight should be specified in terms of force. + \*\* Note \*\* Thrust and weight should be specified in terms of force. + T_VA : float Idle thrust during approach. T_VF : float @@ -75,7 +76,8 @@ class FieldPerformanceProblem: TOW : float Takeoff gross weight. - ** Note ** TSFC should be specified in terms of mass / time / force. + \*\* Note \*\* TSFC should be specified in terms of mass / time / force. + TSFC_VA : float Thrust-specific fuel consumption with engine in idle during approach. TSFC_VF : float @@ -92,11 +94,13 @@ class FieldPerformanceProblem: Examples -------- FP = FieldPerformance('gulfstream') + fpp = FieldPerformanceProblem(name='fpp1',TOW=W,span=b,CLmax=CLmax, WingHeight=5.6,runwayFrictionCoef=0.04,Area=S, CD0=0.015,CD0_LG=0.0177,CD0_HL=0, T_VG=T_VG,T_VT=T_VT,TSFC_VG=TSFC,TSFC_VT=TSFC, altitude=0,units='english') + fpp.addDV('TOW') funcs = {} funcsSens = {} diff --git a/baseclasses/testing/pyRegTest.py b/baseclasses/testing/pyRegTest.py index cbefd36..71f4b4e 100644 --- a/baseclasses/testing/pyRegTest.py +++ b/baseclasses/testing/pyRegTest.py @@ -191,7 +191,7 @@ def root_add_dict(self, name, d, **kwargs): The name of the dictionary d : dict The dictionary to add - **kwargs + \*\*kwargs See :meth:`getTol ` on how to specif tolerances. """ with multi_proc_exception_check(self.comm): @@ -209,7 +209,7 @@ def par_add_val(self, name, values, **kwargs): The name of the value values : ndarray The array to be added. This must be a numpy array distributed over self.comm - **kwargs + \*\*kwargs See :meth:`getTol ` on how to specif tolerances. """ if self.comm is None: @@ -229,7 +229,7 @@ def par_add_sum(self, name, values, **kwargs): The name of the value values : ndarray The array to be added. This must be a numpy array distributed over self.comm - **kwargs + \*\*kwargs See :meth:`getTol ` on how to specif tolerances. """ if self.comm is None: @@ -249,7 +249,7 @@ def par_add_norm(self, name, values, **kwargs): The name of the value values : ndarray The array to be added. This must be a numpy array distributed over self.comm - **kwargs + \*\*kwargs See :meth:`getTol ` on how to specif tolerances. """ if self.comm is None: diff --git a/doc/conf.py b/doc/conf.py index 6092ef5..549eb42 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,4 +1,4 @@ -from sphinx_mdolab_theme.config import * +from sphinx_mdolab_theme.config import * # noqa F403 # -- Path setup -------------------------------------------------------------- # If extensions (or modules to document with autodoc) are in another directory, @@ -17,7 +17,7 @@ # Built-in Sphinx extensions are already contained in the imported variable # here we add external extensions, which must also be added to requirements.txt # so that RTD can import and use them -extensions.extend(["numpydoc"]) +extensions.extend(["numpydoc"]) # noqa F405 # mock import for autodoc autodoc_mock_imports = ["numpy", "pygeo", "mpi4py"]