Merge branch 'main' into stream_scaler_Polley

README.md

@@ -14,7 +14,7 @@ scale-up, operation and troubleshooting of innovative, advanced energy systems.
 [![GitHub contributors](https://img.shields.io/github/contributors/IDAES/idaes-pse.svg)](https://github.com/IDAES/idaes-pse/graphs/contributors)
 [![Merged PRs](https://img.shields.io/github/issues-pr-closed-raw/IDAES/idaes-pse.svg?label=merged+PRs)](https://github.com/IDAES/idaes-pse/pulls?q=is:pr+is:merged)
 [![Issue stats](http://isitmaintained.com/badge/resolution/IDAES/idaes-pse.svg)](http://isitmaintained.com/project/IDAES/idaes-pse)
-[![Downloads](https://pepy.tech/badge/idaes-pse)](https://pepy.tech/project/idaes-pse)
+[![Downloads](https://static.pepy.tech/badge/idaes-pse)](https://pepy.tech/project/idaes-pse)
 <!-- END Status badges -->
 
 ## Getting Started

idaes/core/scaling/custom_scaler_base.py

@@ -16,7 +16,6 @@
 Author: Andrew Lee
 """
 from copy import copy
-from enum import Enum
 
 from pyomo.environ import ComponentMap, units, value
 from pyomo.core.base.units_container import UnitsError
@@ -26,6 +25,7 @@
 from idaes.core.scaling.scaling_base import CONFIG, ScalerBase
 from idaes.core.scaling.util import get_scaling_factor, NominalValueExtractionVisitor
 import idaes.logger as idaeslog
+from idaes.core.util.misc import StrEnum
 
 # Set up logger
 _log = idaeslog.getLogger(__name__)
@@ -41,7 +41,7 @@
 }
 
 
-class ConstraintScalingScheme(str, Enum):
+class ConstraintScalingScheme(StrEnum):
     """
     Schemes available for calculating constraint scaling factors.
 

idaes/core/util/misc.py

@@ -15,9 +15,12 @@
 This module contains miscellaneous utility functions for use in IDAES models.
 """
 from enum import Enum
+import sys
 
 import pyomo.environ as pyo
 from pyomo.common.config import ConfigBlock
+from pyomo.core.expr.visitor import _ToStringVisitor
+from pyomo.core.base.expression import ExpressionData
 
 import idaes.logger as idaeslog
 
@@ -177,3 +180,66 @@ class StrEnum(str, Enum):
 
     def __str__(self):
         return str(self.value)
+
+
+class _ToExprStringVisitor(_ToStringVisitor):
+    """
+    Derived version of the Pyomo _ToStringVisitor class
+    which checks for named Expressions in the expression tree
+    and prints their name instead of expanding the expression tree.
+    """
+
+    def visiting_potential_leaf(self, node):
+        # Check if node is a named Expression
+        if isinstance(node, ExpressionData):
+            # If it is, return the name of the Expression
+            return True, node.name
+
+        # Otherwise, continue descending as normal
+        return super().visiting_potential_leaf(node)
+
+
+def compact_expression_to_string(expr):
+    """Return a compact string representation of an expression.
+
+    Unlike the normal Pyomo string representations, this function will
+    identify any Expressions that appear within the expression tree and
+    print the name of these rather than expanding the expression tree.
+
+    Args:
+        expr: ExpressionBase. The root node of an expression tree.
+
+    Returns:
+        A string representation for the expression.
+    """
+    # Create and execute the visitor pattern
+    #
+    visitor = _ToExprStringVisitor(verbose=False, smap=None)
+    return visitor.dfs_postorder_stack(expr)
+
+
+def print_compact_form(expr, stream=None):
+    """
+    Writes a compact string representation of the given component or
+    expression to the specified stream.
+
+    Unlike the normal Pyomo string representations, this function will
+    identify any Expressions that appear within the expression tree and
+    print the name of these rather than expanding the expression tree.
+
+    Args:
+        expr: component or expression to print
+        stream: StringIO object to write to. Default is stdout.
+
+    Returns:
+        None
+    """
+    if stream is None:
+        stream = sys.stdout
+
+    if hasattr(expr, "expr"):
+        # We have a Constraint or Expression
+        # We want to print the expression, not the object name
+        expr = expr.expr
+
+    stream.write(compact_expression_to_string(expr))