Merge pull request #114 from Kenneth-T-Moore/ref_regression

Tweaked some residual scalers to improve nested solver performance.

Author: johnjasa

aviary/docs/theory_guide/building_metadata_syntax.ipynb

@@ -27,7 +27,7 @@
    "source": [
     "# Building Metadata\n",
     "\n",
-    "When working with Aviary models, sometimes it is necessary to extend the Aviary-core variable hierarchy or update existing metadata. The syntax for `add_meta_data` and `update_meta_data` can be found below. For a more detailed explanation of metadata please visit [this link](../user_guide/variable_metadata.md).\n",
+    "When working with Aviary models, sometimes it is necessary to extend the Aviary-core variable hierarchy or update existing metadata. The syntax for `add_meta_data` and `update_meta_data` can be found below. For a more detailed explanation of metadata please visit [this link](../user_guide/variable_metadata).\n",
     "\n",
     "```{eval-rst}\n",
     ".. autofunction:: aviary.utils.develop_metadata.add_meta_data\n",

aviary/docs/theory_guide/intro.md

@@ -20,7 +20,7 @@ The [mass](./mass) calculations that Aviary provides are similar to the geometry
 The [mission analysis](./mission) calculations that Aviary provides are broader in scope than the other disciplines. Aviary provides two different types of equations of motion (2DOF and height energy), and also provides two different ways to integrate these EOMs (collocation and analytic shooting). The intended capability is that either EOM can be used with either integration technique.
 
 
-The second aspect of Aviary, instead of being computational like the first, is about subsystem integration. In addition to the capability to build purely Aviary-based aircraft models, Aviary provides the ability to build mixed-origin aircraft models, which are aircraft models consisting partially or entirely of external user-provided subsystems. In the case of a mixed-origin model, instead of just selecting existing Aviary subsystems and combining them into an aircraft model, the user also provides the Aviary code with their own subsystems (these could be pre-existing codes such as [pyCycle](https://github.com/OpenMDAO/pyCycle), or they could be new subsystems the user has built themselves). An example of a mixed-origin model is the [OpenAeroStruct example case](../examples/OAS_subsystem.md). In this example, the built-in Aviary subsystem for mass is partially replaced by external subsystems.
+The second aspect of Aviary, instead of being computational like the first, is about subsystem integration. In addition to the capability to build purely Aviary-based aircraft models, Aviary provides the ability to build mixed-origin aircraft models, which are aircraft models consisting partially or entirely of external user-provided subsystems. In the case of a mixed-origin model, instead of just selecting existing Aviary subsystems and combining them into an aircraft model, the user also provides the Aviary code with their own subsystems (these could be pre-existing codes such as [pyCycle](https://github.com/OpenMDAO/pyCycle), or they could be new subsystems the user has built themselves). An example of a mixed-origin model is the [OpenAeroStruct example case](../examples/OAS_subsystem). In this example, the built-in Aviary subsystem for mass is partially replaced by external subsystems.
 
 ### FLOPS/LEAPS References
 1. [Here](https://ntrs.nasa.gov/api/citations/20190000442/downloads/20190000442.pdf) is an overview of the LEAPS code development.

aviary/docs/theory_guide/merging_syntax.ipynb

@@ -26,7 +26,7 @@
    "source": [
     "# Merging Variable Info\n",
     "\n",
-    "When working with multiple external subsystems for Aviary, sometimes it is helpful to merge together variable hierarchies and metadata. The syntax for those merging functions can be found below. For more detailed descriptions of how to merge [metadata](../user_guide/variable_metadata.md) and [hierarchies](../user_guide/variable_hierarchy.md) visit the included links.\n",
+    "When working with multiple external subsystems for Aviary, sometimes it is helpful to merge together variable hierarchies and metadata. The syntax for those merging functions can be found below. For more detailed descriptions of how to merge [metadata](../user_guide/variable_metadata) and [hierarchies](../user_guide/variable_hierarchy) visit the included links.\n",
     "\n",
     "```{eval-rst}\n",
     "    .. autofunction:: aviary.utils.merge_hierarchies.merge_hierarchies\n",
@@ -64,4 +64,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 4
-}
+}

aviary/mission/flops_based/ode/mission_ODE.py

@@ -164,6 +164,7 @@ def setup(self):
                                                  normalize=False,
                                                  lower=0.0 if options['throttle_enforcement'] == 'bounded' else None,
                                                  upper=1.0 if options['throttle_enforcement'] == 'bounded' else None,
+                                                 res_ref=1.0e6,
                                                  ),
                            promotes_inputs=['*'],
                            promotes_outputs=['*'])
@@ -187,7 +188,7 @@ def setup(self):
             exec_comp_string,
             initial_mass={'units': 'kg'},
             mass={'units': 'kg', 'shape': (nn,)},
-            initial_mass_residual={'units': 'kg'},
+            initial_mass_residual={'units': 'kg', 'res_ref': 1.0e5},
         )
 
         self.add_subsystem('initial_mass_residual_constraint', initial_mass_residual_constraint,

aviary/subsystems/aerodynamics/flops_based/solved_alpha_group.py

@@ -76,7 +76,7 @@ def setup(self):
                            promotes_outputs=[Dynamic.Mission.LIFT, Dynamic.Mission.DRAG])
 
         balance = self.add_subsystem('balance', om.BalanceComp())
-        balance.add_balance('alpha', val=np.ones(nn), units='deg')
+        balance.add_balance('alpha', val=np.ones(nn), units='deg', res_ref=1.0e6)
 
         self.connect('balance.alpha', 'tabular_aero.alpha')
         self.connect('needed_lift.lift_resid', 'balance.lhs:alpha')