def test_pyxdsm_case_reading(self):
"""
Writes a recorder file, and the XDSM writer makes the diagram based on the SQL file
and not the Problem instance.
"""
from openmdao.recorders.sqlite_recorder import SqliteRecorder
filename = 'xdsm_from_sql'
case_recording_filename = filename + '.sql'
prob = Problem()
prob.model = model = SellarNoDerivatives()
model.add_design_var('z', lower=np.array([-10.0, 0.0]),
upper=np.array([10.0, 10.0]), indices=np.arange(2, dtype=int))
model.add_design_var('x', lower=0.0, upper=10.0)
model.add_objective('obj')
model.add_constraint('con1', equals=np.zeros(1))
model.add_constraint('con2', upper=0.0)
recorder = SqliteRecorder(case_recording_filename)
prob.driver.add_recorder(recorder)
prob.setup(check=False)
prob.final_setup()
# Write output
write_xdsm(case_recording_filename, filename=filename, out_format='tex',
show_browser=False, quiet=QUIET)
# Check if file was created
self.assertTrue(os.path.isfile(case_recording_filename))
self.assertTrue(os.path.isfile('.'.join([filename, 'tex'])))
# Check that there are no errors when running from the command line with a recording.
check_call('openmdao xdsm --no_browser %s' % case_recording_filename)
def test_legend(self):
from openmdao.api import Problem, IndepVarComp
p = Problem()
model = p.model
model.add_subsystem('ground', IndepVarComp('V', 0., units='V'))
model.add_subsystem('source', IndepVarComp('I', 0.1, units='A'))
model.add_subsystem('circuit', Circuit())
model.connect('source.I', 'circuit.I_in')
model.connect('ground.V', 'circuit.Vg')
model.add_design_var('ground.V')
model.add_design_var('source.I')
model.add_objective('circuit.D1.I')
p.setup(check=False)
# set some initial guesses
p['circuit.n1.V'] = 10.
p['circuit.n2.V'] = 1.
p.run_model()
write_xdsm(p, 'xdsmjs_circuit_legend', out_format='html', quiet=QUIET, show_browser=SHOW,
recurse=True, legend=True)
self.assertTrue(os.path.isfile('.'.join(['xdsmjs_circuit_legend', 'html'])))
def test_xdsmjs_right_outputs(self):
"""Makes XDSM for the Sellar problem"""
filename = 'xdsmjs_outputs_on_the_right'
prob = om.Problem()
prob.model = model = SellarNoDerivatives()
model.add_design_var('z',
lower=np.array([-10.0, 0.0]),
upper=np.array([10.0, 10.0]),
indices=np.arange(2, dtype=int))
model.add_design_var('x', lower=0.0, upper=10.0)
model.add_objective('obj')
model.add_constraint('con1', equals=np.zeros(1))
model.add_constraint('con2', upper=0.0)
prob.setup()
prob.final_setup()
msg = 'Right side outputs not implemented for XDSMjs.'
# Write output
with assert_warning(Warning, msg):
om.write_xdsm(prob,
filename=filename,
out_format='html',
show_browser=SHOW,
quiet=QUIET,
output_side='right')
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, 'html'])))
def test_circuit_recurse(self):
# Implicit component is also tested here
import openmdao.api as om
p = om.Problem()
model = p.model
model.add_subsystem('ground', om.IndepVarComp('V', 0., units='V'))
model.add_subsystem('source', om.IndepVarComp('I', 0.1, units='A'))
model.add_subsystem('circuit', Circuit())
model.connect('source.I', 'circuit.I_in')
model.connect('ground.V', 'circuit.Vg')
model.add_design_var('ground.V')
model.add_design_var('source.I')
model.add_objective('circuit.D1.I')
p.setup()
# set some initial guesses
p['circuit.n1.V'] = 10.
p['circuit.n2.V'] = 1.
p.run_model()
om.write_xdsm(p,
'xdsmjs_circuit',
out_format='html',
quiet=QUIET,
show_browser=SHOW,
recurse=True)
self.assertTrue(os.path.isfile('.'.join(['xdsmjs_circuit', 'html'])))
def test_xdsmjs(self):
"""
Makes XDSMjs input file for the Sellar problem.
Data is in a separate JSON file.
"""
filename = 'xdsmjs' # this name is needed for XDSMjs
prob = Problem()
prob.model = model = SellarNoDerivatives()
model.add_design_var('z', lower=np.array([-10.0, 0.0]),
upper=np.array([10.0, 10.0]), indices=np.arange(2, dtype=int))
model.add_design_var('x', lower=0.0, upper=10.0)
model.add_objective('obj')
model.add_constraint('con1', equals=np.zeros(1))
model.add_constraint('con2', upper=0.0)
prob.setup(check=False)
prob.final_setup()
# Write output
write_xdsm(prob, filename=filename, out_format='html', subs=(), show_browser=SHOW,
embed_data=False)
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, 'json'])))
self.assertTrue(os.path.isfile('.'.join([filename, 'html'])))
def test_execcomp(self):
filename = 'xdsmjs_execcomp'
out_format = 'html'
prob = Problem(model=Group())
indeps = prob.model.add_subsystem('indeps',
IndepVarComp(),
promotes=['*'])
indeps.add_output('x')
prob.model.add_subsystem('C1',
ExecComp(['y=2.0*x+1.'], x=2.0),
promotes=['*'])
prob.driver = ScipyOptimizeDriver()
prob.model.add_design_var('x', lower=0.0, upper=10.0)
prob.model.add_objective('y')
prob.setup(check=False)
# Conclude setup but don't run model.
prob.final_setup()
write_xdsm(prob,
filename=filename,
out_format=out_format,
quiet=QUIET,
show_browser=SHOW,
show_parallel=True)
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, out_format])))
def test_pyxdsm_sellar_no_recurse(self):
"""Makes XDSM for the Sellar problem, with no recursion."""
filename = 'xdsm1'
prob = om.Problem()
prob.model = model = SellarNoDerivatives()
model.add_design_var('z',
lower=np.array([-10.0, 0.0]),
upper=np.array([10.0, 10.0]),
indices=np.arange(2, dtype=int))
model.add_design_var('x', lower=0.0, upper=10.0)
model.add_objective('obj')
model.add_constraint('con1', equals=np.zeros(1))
model.add_constraint('con2', upper=0.0)
prob.setup()
prob.final_setup()
# Write output
om.write_xdsm(prob,
filename=filename,
out_format=PYXDSM_OUT,
show_browser=SHOW,
recurse=False,
quiet=QUIET)
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, PYXDSM_OUT])))
def test_pyxdsm_sellar(self):
"""Makes XDSM for the Sellar problem"""
filename = 'xdsm0'
prob = Problem()
prob.model = model = SellarNoDerivatives()
model.add_design_var('z',
lower=np.array([-10.0, 0.0]),
upper=np.array([10.0, 10.0]),
indices=np.arange(2, dtype=int))
model.add_design_var('x', lower=0.0, upper=10.0)
model.add_objective('obj')
model.add_constraint('con1', equals=np.zeros(1))
model.add_constraint('con2', upper=0.0)
prob.setup(check=False)
prob.final_setup()
# Write output
write_xdsm(prob,
filename=filename,
out_format='pdf',
show_browser=False,
quiet=QUIET)
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, 'tex'])))
def test_pyxdsm_solver(self):
import openmdao.api as om
out_format = PYXDSM_OUT
prob = om.Problem()
prob.model = model = SellarNoDerivatives()
model.nonlinear_solver = om.NonlinearBlockGS()
prob.driver = om.ScipyOptimizeDriver()
prob.model.add_objective('obj')
prob.setup()
prob.run_model()
filename = 'pyxdsm_solver'
# Write output
om.write_xdsm(prob,
filename=filename,
out_format=out_format,
quiet=QUIET,
show_browser=SHOW,
include_solver=True)
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, out_format])))
filename = 'pyxdsm_solver2'
# Write output
om.write_xdsm(prob,
filename=filename,
out_format=out_format,
quiet=QUIET,
show_browser=SHOW,
include_solver=True,
recurse=False)
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, out_format])))
def test_doe(self):
filename = 'pyxdsm_doe'
out_format = PYXDSM_OUT
prob = om.Problem()
indeps = prob.model.add_subsystem('indeps',
om.IndepVarComp(),
promotes=['*'])
indeps.add_output('x')
prob.model.add_subsystem('C1',
om.ExecComp(['y=2.0*x+1.'], x=2.0),
promotes=['*'])
prob.driver = om.DOEDriver()
prob.model.add_design_var('x', lower=0.0, upper=10.0)
prob.model.add_objective('y')
prob.setup()
# Conclude setup but don't run model.
prob.final_setup()
om.write_xdsm(prob,
filename=filename,
out_format=out_format,
quiet=QUIET,
show_browser=SHOW,
show_parallel=True)
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, out_format])))
def test_xdsmjs_embeddable(self):
"""
Makes XDSMjs HTML file for the Sellar problem.
The HTML file is embeddable (no head and body tags).
"""
filename = 'xdsmjs_embeddable' # this name is needed for XDSMjs
prob = om.Problem()
prob.model = model = SellarNoDerivatives()
model.add_design_var('z',
lower=np.array([-10.0, 0.0]),
upper=np.array([10.0, 10.0]),
indices=np.arange(2, dtype=int))
model.add_design_var('x', lower=0.0, upper=10.0)
model.add_objective('obj')
model.add_constraint('con1', equals=np.zeros(1))
model.add_constraint('con2', upper=0.0)
prob.setup()
prob.final_setup()
# Write output
om.write_xdsm(prob,
filename=filename,
out_format='html',
subs=(),
show_browser=SHOW,
embed_data=True,
embeddable=True)
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, 'html'])))
def test_xdsmjs_mdf(self):
filename = 'xdsmjs_mdf'
out_format = 'html'
prob = om.Problem(model=SellarMDA())
model = prob.model
prob.driver = om.ScipyOptimizeDriver()
model.add_design_var('z',
lower=np.array([-10.0, 0.0]),
upper=np.array([10.0, 10.0]),
indices=np.arange(2, dtype=int))
model.add_design_var('x', lower=0.0, upper=10.0)
model.add_objective('obj')
model.add_constraint('con1', equals=np.zeros(1))
model.add_constraint('con2', upper=0.0)
prob.setup()
prob.final_setup()
# Write output
om.write_xdsm(prob,
filename=filename,
out_format=out_format,
show_browser=SHOW,
include_solver=True)
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, out_format])))
def test_pyxdsm_sphere(self):
"""
Makes an XDSM of the Sphere test case. It also adds a design variable, constraint and
objective.
"""
class Rosenbrock(ExplicitComponent):
def __init__(self, problem):
super(Rosenbrock, self).__init__()
self.problem = problem
self.counter = 0
def setup(self):
self.add_input('x', np.array([1.5, 1.5]))
self.add_output('f', 0.0)
self.declare_partials('f',
'x',
method='fd',
form='central',
step=1e-4)
def compute(self,
inputs,
outputs,
discrete_inputs=None,
discrete_outputs=None):
x = inputs['x']
outputs['f'] = sum(x**2)
x0 = np.array([1.2, 1.5])
filename = 'xdsm2'
prob = Problem()
indeps = prob.model.add_subsystem('indeps',
IndepVarComp(problem=prob),
promotes=['*'])
indeps.add_output('x', list(x0))
prob.model.add_subsystem('sphere',
Rosenbrock(problem=prob),
promotes=['*'])
prob.model.add_subsystem('con',
ExecComp('c=sum(x)', x=np.ones(2)),
promotes=['*'])
prob.driver = ScipyOptimizeDriver()
prob.model.add_design_var('x')
prob.model.add_objective('f')
prob.model.add_constraint('c', lower=1.0)
prob.setup(check=False)
prob.final_setup()
# Write output
write_xdsm(prob,
filename=filename,
out_format='tex',
show_browser=False)
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, 'tex'])))
def test_xdsmjs_mda(self):
filename = 'xdsmjs_mda'
out_format = 'html'
prob = Problem(model=SellarMDA())
prob.setup(check=False)
prob.final_setup()
# Write output
write_xdsm(prob, filename=filename, out_format=out_format, quiet=QUIET,
show_browser=SHOW, embed_data=True, embeddable=True, include_solver=True)
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, out_format])))
def test_pyxdsm_identical_relative_names(self):
class TimeComp(om.ExplicitComponent):
def setup(self):
self.add_input('t_initial', val=0.)
self.add_input('t_duration', val=1.)
self.add_output('time', shape=(2, ))
def compute(self, inputs, outputs):
t_initial = inputs['t_initial']
t_duration = inputs['t_duration']
outputs['time'][0] = t_initial
outputs['time'][1] = t_initial + t_duration
class Phase(om.Group):
def setup(self):
super(Phase, self).setup()
indep = om.IndepVarComp()
for var in ['t_initial', 't_duration']:
indep.add_output(var, val=1.0)
self.add_subsystem('time_extents',
indep,
promotes_outputs=['*'])
time_comp = TimeComp()
self.add_subsystem('time', time_comp)
self.connect('t_initial', 'time.t_initial')
self.connect('t_duration', 'time.t_duration')
self.set_order(['time_extents', 'time'])
p = om.Problem()
p.driver = om.ScipyOptimizeDriver()
orbit_phase = Phase()
p.model.add_subsystem('orbit_phase', orbit_phase)
systems_phase = Phase()
p.model.add_subsystem('systems_phase', systems_phase)
systems_phase = Phase()
p.model.add_subsystem('extra_phase', systems_phase)
p.model.add_design_var('orbit_phase.t_initial')
p.model.add_design_var('orbit_phase.t_duration')
p.model.add_objective('systems_phase.time.time')
p.setup()
p.run_model()
om.write_xdsm(p, 'xdsmjs_orbit', out_format='html', show_browser=SHOW)
self.assertTrue(os.path.isfile('.'.join(['xdsmjs_orbit', 'html'])))
def test_wrong_out_format(self):
"""Incorrect output format error."""
filename = 'xdsm_wrong_format' # this name is needed for XDSMjs
prob = Problem()
prob.model = SellarNoDerivatives()
prob.setup(check=False)
prob.final_setup()
# no output checking, just make sure no exceptions raised
with self.assertRaises(ValueError):
write_xdsm(prob, filename=filename, out_format='jpg', subs=(), show_browser=SHOW)
def test_parallel(self):
from openmdao.api import ParallelGroup, NonlinearBlockGS
class SellarMDA(Group):
"""
Group containing the Sellar MDA.
"""
def setup(self):
indeps = self.add_subsystem('indeps', IndepVarComp(), promotes=['*'])
indeps.add_output('x', 1.0)
indeps.add_output('z', np.array([5.0, 2.0]))
cycle = self.add_subsystem('cycle', ParallelGroup(), promotes=['*'])
cycle.add_subsystem('d1', SellarDis1(), promotes_inputs=['x', 'z', 'y2'],
promotes_outputs=['y1'])
cycle.add_subsystem('d2', SellarDis2(), promotes_inputs=['z', 'y1'],
promotes_outputs=['y2'])
# Nonlinear Block Gauss Seidel is a gradient free solver
cycle.nonlinear_solver = NonlinearBlockGS()
self.add_subsystem('obj_cmp', ExecComp('obj = x**2 + z[1] + y1 + exp(-y2)',
z=np.array([0.0, 0.0]), x=0.0),
promotes=['x', 'z', 'y1', 'y2', 'obj'])
self.add_subsystem('con_cmp1', ExecComp('con1 = 3.16 - y1'),
promotes=['con1', 'y1'])
self.add_subsystem('con_cmp2', ExecComp('con2 = y2 - 24.0'),
promotes=['con2', 'y2'])
filename = 'xdsmjs_parallel'
out_format = 'html'
prob = Problem(model=SellarMDA())
model = prob.model
prob.driver = ScipyOptimizeDriver()
model.add_design_var('z', lower=np.array([-10.0, 0.0]),
upper=np.array([10.0, 10.0]), indices=np.arange(2, dtype=int))
model.add_design_var('x', lower=0.0, upper=10.0)
model.add_objective('obj')
model.add_constraint('con1', equals=np.zeros(1))
model.add_constraint('con2', upper=0.0)
prob.setup(check=False)
prob.final_setup()
# Write output
write_xdsm(prob, filename=filename, out_format=out_format, quiet=QUIET, show_browser=SHOW,
show_parallel=True)
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, out_format])))
def test_pyxdsm_mda(self):
filename = 'pyxdsm_mda'
out_format = PYXDSM_OUT
prob = om.Problem(model=SellarMDA())
prob.setup()
prob.final_setup()
# Write output
om.write_xdsm(prob,
filename=filename,
out_format=out_format,
quiet=QUIET,
show_browser=SHOW,
include_solver=True)
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, out_format])))
def test_xdsm_solver(self):
from openmdao.api import NonlinearBlockGS
filename = 'xdsmjs_solver'
out_format = 'html'
prob = Problem(model=SellarNoDerivatives())
prob.model.nonlinear_solver = NonlinearBlockGS()
prob.driver = ScipyOptimizeDriver()
prob.model.add_objective('obj')
prob.setup(check=False)
prob.run_model()
# Write output
write_xdsm(prob, filename=filename, out_format=out_format,
show_browser=SHOW, include_solver=True)
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, out_format])))
def test_meta_model(self):
import openmdao.api as om
from openmdao.components.tests.test_meta_model_structured_comp import SampleMap
filename = 'pyxdsm_meta_model'
out_format = PYXDSM_OUT
model = om.Group()
ivc = om.IndepVarComp()
mapdata = SampleMap()
params = mapdata.param_data
x, y, z = params
outs = mapdata.output_data
z = outs[0]
ivc.add_output('x', x['default'], units=x['units'])
ivc.add_output('y', y['default'], units=y['units'])
ivc.add_output('z', z['default'], units=z['units'])
model.add_subsystem('des_vars', ivc, promotes=["*"])
comp = om.MetaModelStructuredComp(method='slinear', extrapolate=True)
for param in params:
comp.add_input(param['name'], param['default'], param['values'])
for out in outs:
comp.add_output(out['name'], out['default'], out['values'])
model.add_subsystem('comp', comp, promotes=["*"])
prob = om.Problem(model)
prob.setup()
prob.final_setup()
om.write_xdsm(prob,
filename=filename,
out_format=out_format,
quiet=QUIET,
show_browser=SHOW,
show_parallel=True)
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, out_format])))
def test_pyxdsm_case_reading(self):
"""
Writes a recorder file, and the XDSM writer makes the diagram based on the SQL file
and not the Problem instance.
"""
from openmdao.recorders.sqlite_recorder import SqliteRecorder
filename = 'xdsm_from_sql'
case_recording_filename = filename + '.sql'
prob = Problem()
prob.model = model = SellarNoDerivatives()
model.add_design_var('z',
lower=np.array([-10.0, 0.0]),
upper=np.array([10.0, 10.0]),
indices=np.arange(2, dtype=int))
model.add_design_var('x', lower=0.0, upper=10.0)
model.add_objective('obj')
model.add_constraint('con1', equals=np.zeros(1))
model.add_constraint('con2', upper=0.0)
recorder = SqliteRecorder(case_recording_filename)
prob.driver.add_recorder(recorder)
prob.setup(check=False)
prob.final_setup()
# Write output
msg = (
'For SQL input the XDSM writer shows only the model hierarchy, '
'and the driver, design variables and responses are not part of the '
'diagram.')
with assert_warning(Warning, msg):
write_xdsm(case_recording_filename,
filename=filename,
out_format='tex',
show_browser=False,
quiet=QUIET)
# Check if file was created
self.assertTrue(os.path.isfile(case_recording_filename))
self.assertTrue(os.path.isfile('.'.join([filename, 'tex'])))
def test_pyxdsm_solver(self):
from openmdao.api import NonlinearBlockGS
filename = 'pyxdsm_solver'
out_format = PYXDSM_OUT
prob = Problem()
prob.model = model = SellarNoDerivatives()
model.nonlinear_solver = NonlinearBlockGS()
prob.driver = ScipyOptimizeDriver()
prob.setup(check=False)
prob.run_model()
# Write output
write_xdsm(prob,
filename=filename,
out_format=out_format,
quiet=QUIET,
show_browser=False,
include_solver=True)
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, out_format])))
def test_circuit_model_path_recurse(self):
from openmdao.api import Problem, IndepVarComp
p = Problem()
model = p.model
group = model.add_subsystem('G1', Group(), promotes=['*'])
group2 = model.add_subsystem('G2', Group())
group.add_subsystem('ground', IndepVarComp('V', 0., units='V'))
group.add_subsystem('source', IndepVarComp('I', 0.1, units='A'))
group2.add_subsystem('source2', IndepVarComp('I', 0.1, units='A'))
group.add_subsystem('circuit', Circuit())
group.connect('source.I', 'circuit.I_in')
group.connect('ground.V', 'circuit.Vg')
model.add_design_var('ground.V')
model.add_design_var('source.I')
model.add_objective('circuit.D1.I')
p.setup(check=False)
# set some initial guesses
p['circuit.n1.V'] = 10.
p['circuit.n2.V'] = 1.
p.run_model()
write_xdsm(p,
'xdsm_circuit2',
out_format='pdf',
quiet=QUIET,
show_browser=False,
recurse=True,
model_path='G1',
include_external_outputs=False)
self.assertTrue(os.path.isfile('.'.join(['xdsm_circuit2', 'tex'])))
def test_model_path_and_recursion(self):
from openmdao.api import Problem, IndepVarComp
p = Problem()
model = p.model
group = model.add_subsystem('G1', Group(), promotes=['*'])
group2 = model.add_subsystem('G2', Group())
group.add_subsystem('ground', IndepVarComp('V', 0., units='V'))
group.add_subsystem('source', IndepVarComp('I', 0.1, units='A'))
group2.add_subsystem('source2', IndepVarComp('I', 0.1, units='A'))
group.add_subsystem('circuit', Circuit())
group.connect('source.I', 'circuit.I_in')
group.connect('ground.V', 'circuit.Vg')
model.add_design_var('ground.V')
model.add_design_var('source.I')
model.add_objective('circuit.D1.I')
p.setup(check=False)
# set some initial guesses
p['circuit.n1.V'] = 10.
p['circuit.n2.V'] = 1.
p.run_model()
# No model path, no recursion
write_xdsm(p, 'xdsm_circuit', out_format=PYXDSM_OUT, quiet=QUIET, show_browser=SHOW,
recurse=False)
self.assertTrue(os.path.isfile('.'.join(['xdsm_circuit', PYXDSM_OUT])))
# Model path given + recursion
write_xdsm(p, 'xdsm_circuit2', out_format=PYXDSM_OUT, quiet=QUIET, show_browser=SHOW,
recurse=True, model_path='G2', include_external_outputs=False)
self.assertTrue(os.path.isfile('.'.join(['xdsm_circuit2', PYXDSM_OUT])))
# Model path given + no recursion
write_xdsm(p, 'xdsm_circuit3', out_format=PYXDSM_OUT, quiet=QUIET, show_browser=SHOW,
recurse=False, model_path='G1')
self.assertTrue(os.path.isfile('.'.join(['xdsm_circuit3', PYXDSM_OUT])))
# Invalid model path, should raise error
with self.assertRaises(ValueError):
write_xdsm(p, 'xdsm_circuit4', out_format='tex', quiet=QUIET, show_browser=SHOW,
recurse=False, model_path='G3')
def test_invalid_model_path(self):
from openmdao.api import Problem, IndepVarComp
p = Problem()
model = p.model
group = model.add_subsystem('G1', Group(), promotes=['*'])
group2 = model.add_subsystem('G2', Group())
group.add_subsystem('ground', IndepVarComp('V', 0., units='V'))
group.add_subsystem('source', IndepVarComp('I', 0.1, units='A'))
group2.add_subsystem('source2', IndepVarComp('I', 0.1, units='A'))
group.add_subsystem('circuit', Circuit())
group.connect('source.I', 'circuit.I_in')
group.connect('ground.V', 'circuit.Vg')
model.add_design_var('ground.V')
model.add_design_var('source.I')
model.add_objective('circuit.D1.I')
p.setup(check=False)
# set some initial guesses
p['circuit.n1.V'] = 10.
p['circuit.n2.V'] = 1.
p.run_model()
with self.assertRaises(ValueError):
write_xdsm(p,
'xdsm_circuit3',
out_format='pdf',
quiet=QUIET,
show_browser=False,
recurse=False,
model_path='G3')
def test_pyxdsm_output_sides(self):
"""Makes XDSM for the Sellar problem"""
prob = om.Problem()
prob.model = model = SellarNoDerivatives()
model.add_design_var('z',
lower=np.array([-10.0, 0.0]),
upper=np.array([10.0, 10.0]),
indices=np.arange(2, dtype=int))
model.add_design_var('x', lower=0.0, upper=10.0)
model.add_objective('obj')
model.add_constraint('con1', equals=np.zeros(1))
model.add_constraint('con2', upper=0.0)
prob.setup()
prob.final_setup()
# Write output (outputs on the left)
filename = 'xdsm_outputs_on_the_left'
om.write_xdsm(prob,
filename=filename,
out_format=PYXDSM_OUT,
show_browser=SHOW,
quiet=QUIET,
output_side='left')
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, PYXDSM_OUT])))
filename = 'xdsm_outputs_on_the_right'
# Write output (all outputs on the right)
om.write_xdsm(prob,
filename=filename,
out_format=PYXDSM_OUT,
show_browser=SHOW,
quiet=QUIET,
output_side='right')
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, PYXDSM_OUT])))
filename = 'xdsm_outputs_side_mixed'
# Write output (outputs mixed)
om.write_xdsm(prob,
filename=filename,
out_format=PYXDSM_OUT,
show_browser=SHOW,
quiet=QUIET,
output_side={
'optimization': 'left',
'default': 'right'
})
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, PYXDSM_OUT])))
def test_custom_writer(self):
from openmdao.visualization.xdsm_viewer.xdsm_writer import XDSMjsWriter
class CustomWriter(XDSMjsWriter):
"""Customized XDSM writer, based on the XDSMjs writer."""
@staticmethod
def format_block(names, **kwargs):
"""This method is overwritten, to implement some different formatting."""
return [name.upper() for name in names]
prob = om.Problem()
prob.model = SellarNoDerivatives()
prob.setup()
prob.final_setup()
my_writer = CustomWriter()
filename = 'xdsm_custom_writer' # this name is needed for XDSMjs
# Write output
om.write_xdsm(prob,
filename=filename,
writer=my_writer,
show_browser=SHOW)
# Check if file was created
self.assertTrue(
os.path.isfile('.'.join([filename, my_writer.extension])))
# Check that error is raised in case of wrong writer type
filename = 'xdsm_custom_writer2' # this name is needed for XDSMjs
with self.assertRaises(TypeError): # Wrong type passed for writer
om.write_xdsm(prob,
filename=filename,
writer=1,
subs=(),
show_browser=SHOW)
# Check warning, if settings for custom writer are not found
my_writer2 = CustomWriter(name='my_writer')
filename = 'xdsm_custom_writer3'
msg = 'Writer name "my_writer" not found, there will be no character ' \
'substitutes used. Add "my_writer" to your settings, or provide a tuple for' \
'character substitutes.'
# Write output
with assert_warning(Warning, msg):
om.write_xdsm(prob,
filename=filename,
writer=my_writer2,
show_browser=SHOW)
def test_pyxdsm_identical_relative_names(self):
class TimeComp(ExplicitComponent):
def setup(self):
self.add_input('t_initial', val=0.)
self.add_input('t_duration', val=1.)
self.add_output('time', shape=(2, ))
def compute(self, inputs, outputs):
t_initial = inputs['t_initial']
t_duration = inputs['t_duration']
outputs['time'][0] = t_initial
outputs['time'][1] = t_initial + t_duration
class Phase(Group):
def setup(self):
super(Phase, self).setup()
indep = IndepVarComp()
for var in ['t_initial', 't_duration']:
indep.add_output(var, val=1.0)
self.add_subsystem('time_extents',
indep,
promotes_outputs=['*'])
time_comp = TimeComp()
self.add_subsystem('time', time_comp)
self.connect('t_initial', 'time.t_initial')
self.connect('t_duration', 'time.t_duration')
self.set_order(['time_extents', 'time'])
p = Problem()
p.driver = ScipyOptimizeDriver()
orbit_phase = Phase()
p.model.add_subsystem('orbit_phase', orbit_phase)
systems_phase = Phase()
p.model.add_subsystem('systems_phase', systems_phase)
systems_phase = Phase()
p.model.add_subsystem('extra_phase', systems_phase)
p.model.add_design_var('orbit_phase.t_initial')
p.model.add_design_var('orbit_phase.t_duration')
p.setup(check=True)
p.run_model()
# requesting 'pdf', but if 'pdflatex' is not found we will only get 'tex'
pdflatex = find_executable('pdflatex')
# Test non unique local names
write_xdsm(p,
'xdsm3',
out_format='pdf',
quiet=QUIET,
show_browser=False)
self.assertTrue(os.path.isfile('.'.join(['xdsm3', 'tex'])))
self.assertTrue(not pdflatex
or os.path.isfile('.'.join(['xdsm3', 'pdf'])))
# Check formatting
# Max character box formatting
write_xdsm(p,
'xdsm4',
out_format='pdf',
quiet=QUIET,
show_browser=False,
box_stacking='cut_chars',
box_width=15)
self.assertTrue(os.path.isfile('.'.join(['xdsm4', 'tex'])))
self.assertTrue(not pdflatex
or os.path.isfile('.'.join(['xdsm4', 'pdf'])))
# Cut characters box formatting
write_xdsm(p,
'xdsm5',
out_format='pdf',
quiet=True,
show_browser=False,
box_stacking='max_chars',
box_width=15)
self.assertTrue(os.path.isfile('.'.join(['xdsm5', 'tex'])))
self.assertTrue(not pdflatex
or os.path.isfile('.'.join(['xdsm5', 'pdf'])))
def test_pyxdsm_identical_relative_names(self):
class TimeComp(om.ExplicitComponent):
def setup(self):
self.add_input('t_initial', val=0.)
self.add_input('t_duration', val=1.)
self.add_output('time', shape=(2, ))
def compute(self, inputs, outputs):
t_initial = inputs['t_initial']
t_duration = inputs['t_duration']
outputs['time'][0] = t_initial
outputs['time'][1] = t_initial + t_duration
class Phase(om.Group):
def setup(self):
super(Phase, self).setup()
indep = om.IndepVarComp()
for var in ['t_initial', 't_duration']:
indep.add_output(var, val=1.0)
self.add_subsystem('time_extents',
indep,
promotes_outputs=['*'])
time_comp = TimeComp()
self.add_subsystem('time', time_comp)
self.connect('t_initial', 'time.t_initial')
self.connect('t_duration', 'time.t_duration')
self.set_order(['time_extents', 'time'])
p = om.Problem()
p.driver = om.ScipyOptimizeDriver()
orbit_phase = Phase()
p.model.add_subsystem('orbit_phase', orbit_phase)
systems_phase = Phase()
p.model.add_subsystem('systems_phase', systems_phase)
systems_phase = Phase()
p.model.add_subsystem('extra_phase', systems_phase)
p.model.add_design_var('orbit_phase.t_initial')
p.model.add_design_var('orbit_phase.t_duration')
p.model.add_objective('systems_phase.time.time')
p.setup()
p.run_model()
# Test non unique local names
filename = 'pyxdsm_identical_rel_names'
om.write_xdsm(p,
filename,
out_format=PYXDSM_OUT,
quiet=QUIET,
show_browser=SHOW)
self.assertTrue(os.path.isfile('.'.join([filename, PYXDSM_OUT])))
# Check formatting
# Max character box formatting
filename = 'pyxdsm_cut_char'
om.write_xdsm(p,
filename,
out_format=PYXDSM_OUT,
quiet=QUIET,
show_browser=SHOW,
box_stacking='cut_chars',
box_width=15)
self.assertTrue(os.path.isfile('.'.join([filename, PYXDSM_OUT])))
# Cut characters box formatting
filename = 'pyxdsm_max_chars'
om.write_xdsm(p,
filename,
out_format=PYXDSM_OUT,
quiet=True,
show_browser=SHOW,
box_stacking='max_chars',
box_width=15)
self.assertTrue(os.path.isfile('.'.join([filename, PYXDSM_OUT])))
def test_pyxdsm_pdf(self):
"""
Makes an XDSM of the Sphere test case. It also adds a design variable, constraint and
objective.
"""
class Rosenbrock(om.ExplicitComponent):
def __init__(self, problem):
super(Rosenbrock, self).__init__()
self.problem = problem
self.counter = 0
def setup(self):
self.add_input('x', np.array([1.5, 1.5]))
self.add_output('f', 0.0)
self.declare_partials('f',
'x',
method='fd',
form='central',
step=1e-4)
def compute(self,
inputs,
outputs,
discrete_inputs=None,
discrete_outputs=None):
x = inputs['x']
outputs['f'] = sum(x**2)
x0 = np.array([1.2, 1.5])
filename = 'xdsm2'
prob = om.Problem()
indeps = prob.model.add_subsystem('indeps',
om.IndepVarComp(problem=prob),
promotes=['*'])
indeps.add_output('x', list(x0))
prob.model.add_subsystem('sphere',
Rosenbrock(problem=prob),
promotes=['*'])
prob.model.add_subsystem('con',
om.ExecComp('c=sum(x)', x=np.ones(2)),
promotes=['*'])
prob.driver = om.ScipyOptimizeDriver()
prob.model.add_design_var('x')
prob.model.add_objective('f')
prob.model.add_constraint('c', lower=1.0)
prob.setup()
prob.final_setup()
# requesting 'pdf', but if 'pdflatex' is not found we will only get 'tex'
pdflatex = find_executable('pdflatex')
# Write output
om.write_xdsm(prob,
filename=filename,
out_format='pdf',
show_browser=SHOW,
quiet=QUIET)
# Check if file was created
self.assertTrue(os.path.isfile('.'.join([filename, 'tex'])))
# Check if PDF was created (only if pdflatex is installed)
self.assertTrue(not pdflatex
or os.path.isfile('.'.join([filename, 'pdf'])))
