Parmest update of util convert_params_to_vars.

[smartin71]

Fixes # .

Summary/Motivation:

This is step 1 of a set of internal changes to parmest related to issue:
#3252

Changes proposed in this PR:

• Revamped util function convert_params_to_vars to avoid the use of parameter names as strings.
• Now using component IDs both internally to the convert function and in the API.

Legal Acknowledgement

By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution:

1. I agree my contributions are submitted under the BSD license.
2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

[jsiirola]

This looks pretty good, but there is a big performance bug that should be addressed.

[codecov]

Codecov Report

Attention: Patch coverage is 93.33333% with 1 line in your changes missing coverage. Please review.

Project coverage is 88.53%. Comparing base (7f779ab) to head (7ea02db).
Report is 158 commits behind head on main.

Files	Patch %	Lines
pyomo/contrib/parmest/utils/model_utils.py	90.90%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##             main    #3339    +/-   ##
========================================
  Coverage   88.52%   88.53%            
========================================
  Files         868      868            
  Lines       98436    98771   +335     
========================================
+ Hits        87144    87450   +306     
- Misses      11292    11321    +29     

Flag	Coverage Δ
linux	86.05% <93.33%> (+0.01%)	⬆️
osx	75.63% <6.66%> (-0.03%)	⬇️
other	86.55% <93.33%> (+0.01%)	⬆️
win	83.86% <93.33%> (+0.02%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[blnicho]

I think this still needs some work. There are some bugs in this function when params to be converted to vars live on blocks. This PR didn't necessarily introduce the bugs but I think we should fix them while we're overhauling this function. Here is a small example demonstrating one of the bugs:

from pyomo.environ import *
from pyomo.contrib.parmest.utils import convert_params_to_vars

m = ConcreteModel()
m.p1 = Param(initialize=1, mutable=True)
m.b = Block()
m.b.p2 = Param(initialize=2, mutable=True)

param_cuids = [ComponentUID(m.p1), ComponentUID(m.b.p2)]
m2 = convert_params_to_vars(m, param_cuids)

this fails with an AttributeError:
AttributeError: 'ScalarParam' object has no attribute 'unfix'

[blnicho]

I don't think this will work on hierarchical models. I think we need to add more tests for edge cases.

[smartin71]

I think I fixed this and added a test.

[blnicho]

Why do we replace param_CUIDs here instead of extending it?

[smartin71]

I think we have to replace it because it might not have the indexed variables, only the main variable. For example "theta" (param_CUIDs) vs. "theta[asymptote]" and "theta[rate_constant]" (indexed_param_CUIDs).

[mrmundt]

@blnicho - Do you think you'll have time to look over this one before the Monday patch?

[shermanjasonaf]

Does this fix #3375?