Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support synchronised variables in Optimetrics.create_setup #130

Merged
merged 2 commits into from
Aug 4, 2022
Merged

Support synchronised variables in Optimetrics.create_setup #130

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ccd2255
Fix code block formattings
nikosavola Aug 2, 2022
c1139a6
Implement synchronised sweep support in Optimetrics
nikosavola Aug 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 72 additions & 51 deletions pyEPR/ansys.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1730,9 +1730,11 @@ def create_report(self,
pass_name: AdaptivePass, LastAdaptive

Example
------------------------------------------------------
-------
Example plot for a single variation all pass converge of mode freq
.. code-block python

.. code-block:: python

ycomp = [f"re(Mode({i}))" for i in range(1,1+epr_hfss.n_modes)]
params = ["Pass:=", ["All"]]+variation
setup.create_report("Freq. vs. pass", "Pass", ycomp, params, pass_name='AdaptivePass')
Expand Down Expand Up @@ -1863,11 +1865,13 @@ class Optimetrics(COMWrapper):
Optimetrics script commands executed by the "Optimetrics" module.

Example use:
.. code-block python
opti = Optimetrics(pinfo.design)
names = opti.get_setup_names()
print('Names of optimetrics: ', names)
opti.solve_setup(names[0])

.. code-block:: python

opti = Optimetrics(pinfo.design)
names = opti.get_setup_names()
print('Names of optimetrics: ', names)
opti.solve_setup(names[0])

Note that running optimetrics requires the license for Optimetrics by Ansys.
"""
Expand Down Expand Up @@ -1910,18 +1914,24 @@ def create_setup(self,
solve_with_copied_mesh_only=True,
setup_type='parametric'):
"""
Inserts a new parametric setup of one variable. Either with sweep
Inserts a new parametric setup of one variable. Either with sweep
definition or from file.

*Synchronized* sweeps (more than one variable changing at once)
can be implemented by giving a list of variables to ``variable``
and corresponding lists to ``swp_params`` and ``swp_type``.
The lengths of the sweep types should match (excluding single value).

Corresponds to ui access:
Right-click the Optimetrics folder in the project tree, and then click
Right-click the Optimetrics folder in the project tree, and then click
Add> Parametric on the shortcut menu.

Ansys provides six sweep definitions types specified using the swp_type
variable.

Sweep type definitions:
- 'single_value'

- 'single_value'
Specify a single value for the sweep definition.
- 'linear_step'
Specify a linear range of values with a constant step size.
Expand All @@ -1932,28 +1942,28 @@ def create_setup(self,
Specify a logarithmic (base 10) series of values, and the number of
values to calculate in each decade.
- 'octave_count'
Specify a logarithmic (base 2) series of values, and the number of
Specify a logarithmic (base 2) series of values, and the number of
values to calculate in each octave.
- 'exponential_count'
Specify an exponential (base e) series of values, and the number of
Specify an exponential (base e) series of values, and the number of
values to calculate.

For swp_type='single_value' swp_params is the single value.

For swp_type='linear_step' swp_params is start, stop, step:
For swp_type='linear_step' swp_params is start, stop, step:
swp_params = ("12.8nH", "13.6nH", "0.2nH")

All other types swp_params is start, stop, count:
swp_params = ("12.8nH", "13.6nH", 4)
The definition of count varies amongst the available types.
The definition of count varies amongst the available types.

For Decade count and Octave count, the Count value specifies the number
of points to calculate in every decade or octave. For Exponential count,
the Count value is the total number of points. The total number of
the Count value is the total number of points. The total number of
points includes the start and stop values.

For parametric from file, setup_type='parametric_file', pass in a file
name and path to swp_params like "C:\\test.csv" or "C:\\test.txt" for
name and path to swp_params like "C:\\test.csv" or "C:\\test.txt" for
example.

Example csv formatting:
Expand All @@ -1962,48 +1972,59 @@ def create_setup(self,
2,9.7nH
3,10.2nH

See Ansys documentation for additional formatting instructions.
See Ansys documentation for additional formatting instructions.
"""
setup_name = setup_name or self.design.get_setup_names()[0]
print(
f"Inserting optimetrics setup `{name}` for simulation setup: `{setup_name}`"
)

if setup_type == 'parametric':
valid_swp_types = ['single_value', 'linear_step', 'linear_count',
'decade_count', 'octave_count', 'exponential_count']

if swp_type not in valid_swp_types:
type_map = {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good add

'linear_count': 'LINC',
'decade_count': 'DEC',
'octave_count': 'OCT',
'exponential_count': 'ESTP',
}
valid_swp_types = {'single_value', 'linear_step'} | set(type_map.keys())

if isinstance(variable, Iterable) and not isinstance(variable, str):
# synchronized sweep, check that data is in correct format
assert len(swp_params) == len(swp_type) == len(variable), \
'Incorrect swp_params or swp_type format for synchronised sweep.'
synchronize = True
else:
# convert all to lists as we can reuse same code for synchronized
swp_type = [swp_type]
swp_params = [swp_params]
variable = [variable]
synchronize = False

if any(e not in valid_swp_types for e in swp_type):
raise NotImplementedError()
else:
if swp_type == 'single_value':
# Single takes string of single variable no swp_type_name
swp_str = f"{swp_params}"
swp_str = list()
for i, e in enumerate(swp_type):
if e == 'single_value':
# Single takes string of single variable no swp_type_name
swp_str.append(f"{swp_params[i]}")
else:
# correct number of inputs
assert len(swp_params[i]) == 3, "Incorrect number of sweep parameters."

else:
# correct number of inputs
assert len(swp_params) == 3, "Incorrect number of sweep parameters."
# Not checking for compatible unit types
if e == 'linear_step':
swp_type_name = "LIN"
else:
# counts needs to be an integer number
assert isinstance(swp_params[i][2], int), "Count must be integer."

swp_type_name = type_map[e]

# prepare the string to pass to Ansys
swp_str.append(f"{swp_type_name} {swp_params[i][0]} {swp_params[i][1]} {swp_params[i][2]}")

# Not checking for compatible unit types
if swp_type == 'linear_step':
swp_type_name = "LIN"
else:
# counts needs to be an integer number
assert isinstance(swp_params[2], int), "Count must be integer."

if swp_type == 'linear_count':
swp_type_name = "LINC"
elif swp_type == 'decade_count':
swp_type_name = "DEC"
elif swp_type == 'octave_count':
swp_type_name = "OCT"
elif swp_type == 'exponential_count':
swp_type_name = "ESTP"

# prepare the string to pass to Ansys
swp_str = f"{swp_type_name} {swp_params[0]} {swp_params[1]} {swp_params[2]}"

# talk with Ansys
self._optimetrics.InsertSetup("OptiParametric", [
f"NAME:{name}", "IsEnabled:=", True,
[
Expand All @@ -2017,14 +2038,14 @@ def create_setup(self,
], ["NAME:StartingPoint"], "Sim. Setups:=", [setup_name],
[
"NAME:Sweeps",
[
"NAME:SweepDefinition", "Variable:=", variable, "Data:=",
swp_str, "OffsetF1:=", False, "Synchronize:=", 0
]
*[[
"NAME:SweepDefinition", "Variable:=", var_name, "Data:=",
swp, "OffsetF1:=", False, "Synchronize:=", int(synchronize)
] for var_name, swp in zip(variable, swp_str)]
], ["NAME:Sweep Operations"], ["NAME:Goals"]
])
elif setup_type == 'parametric_file':
# Uses the file name as the swp_params
# Uses the file name as the swp_params
filename = swp_params

self._optimetrics.ImportSetup("OptiParametric",
Expand Down