# Copyright 2019 TerraPower, LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Unit tests for the SuiteBuilder."""
import os
import unittest
from armi import cases, settings
from armi.cases.inputModifiers.inputModifiers import (
SamplingInputModifier,
InputModifier,
)
from armi.cases.suiteBuilder import (
LatinHyperCubeSuiteBuilder,
FullFactorialSuiteBuilder,
SeparateEffectsSuiteBuilder,
)
cs = settings.Settings(
os.path.join(
os.path.dirname(os.path.abspath(__file__)),
"..",
"..",
"tests",
"tutorials",
"anl-afci-177.yaml",
)
)
case = cases.Case(cs)
[docs]class LatinHyperCubeModifier(SamplingInputModifier):
def __init__(self, name, paramType: str, bounds: list, independentVariable=None):
super().__init__(
name, paramType, bounds, independentVariable=independentVariable
)
self.value = None
def __call__(self, cs, bp, geom):
cs = cs.modified(newSettings={self.name: self.value})
return cs, bp, geom
[docs]class SettingModifier(InputModifier):
def __init__(self, settingName, value):
self.settingName = settingName
self.value = value
def __call__(self, cs, bp, geom):
cs = cs.modified(newSettings={self.settingName: self.value})
return cs, bp, geom
[docs]class TestLatinHyperCubeSuiteBuilder(unittest.TestCase):
"""Class to test LatinHyperCubeSuiteBuilder."""
[docs] def test_initialize(self):
builder = LatinHyperCubeSuiteBuilder(case, size=20)
assert builder.modifierSets == []
[docs] def test_buildSuite(self):
"""
Initialize an LHC suite.
.. test:: A generic mechanism to allow users to modify user inputs in cases.
:id: T_ARMI_CASE_MOD0
:tests: R_ARMI_CASE_MOD
"""
builder = LatinHyperCubeSuiteBuilder(case, size=20)
powerMod = LatinHyperCubeModifier("power", "continuous", [0, 1e6])
availabilityMod = LatinHyperCubeModifier(
"availabilityFactor", "discrete", [0.0, 0.2, 0.4, 0.6, 0.8]
)
builder.addDegreeOfFreedom([powerMod, availabilityMod])
builder.buildSuite()
assert len(builder.modifierSets) == 20
for mod in builder.modifierSets:
assert 0 < mod[0].value < 1e6
assert mod[1].value in [0.0, 0.2, 0.4, 0.6, 0.8]
[docs] def test_addDegreeOfFreedom(self):
builder = LatinHyperCubeSuiteBuilder(case, size=20)
powerMod = LatinHyperCubeModifier("power", "continuous", [0, 1e6])
morePowerMod = LatinHyperCubeModifier("power", "continuous", [1e3, 1e5])
with self.assertRaises(ValueError):
builder.addDegreeOfFreedom([powerMod, morePowerMod])
[docs]class TestFullFactorialSuiteBuilder(unittest.TestCase):
"""Class to test FullFactorialSuiteBuilder."""
[docs] def test_buildSuite(self):
"""Initialize a full factorial suite of cases.
.. test:: A generic mechanism to allow users to modify user inputs in cases.
:id: T_ARMI_CASE_MOD1
:tests: R_ARMI_CASE_MOD
"""
builder = FullFactorialSuiteBuilder(case)
builder.addDegreeOfFreedom(
SettingModifier("settingName1", value) for value in (1, 2)
)
builder.addDegreeOfFreedom(
SettingModifier("settingName2", value) for value in (3, 4, 5)
)
self.assertEquals(builder.modifierSets[0][0].value, 1)
self.assertEquals(builder.modifierSets[0][1].value, 3)
self.assertEquals(builder.modifierSets[1][0].value, 2)
self.assertEquals(builder.modifierSets[1][1].value, 3)
self.assertEquals(builder.modifierSets[2][0].value, 1)
self.assertEquals(builder.modifierSets[2][1].value, 4)
self.assertEquals(builder.modifierSets[3][0].value, 2)
self.assertEquals(builder.modifierSets[3][1].value, 4)
self.assertEquals(builder.modifierSets[4][0].value, 1)
self.assertEquals(builder.modifierSets[4][1].value, 5)
self.assertEquals(builder.modifierSets[5][0].value, 2)
self.assertEquals(builder.modifierSets[5][1].value, 5)
self.assertEquals(len(builder.modifierSets), 6)
[docs]class TestSeparateEffectsBuilder(unittest.TestCase):
"""Class to test separate effects builder."""
[docs] def test_buildSuite(self):
"""Initialize a full factorial suite of cases.
.. test:: A generic mechanism to allow users to modify user inputs in cases.
:id: T_ARMI_CASE_MOD2
:tests: R_ARMI_CASE_MOD
"""
builder = SeparateEffectsSuiteBuilder(case)
builder.addDegreeOfFreedom(
SettingModifier("settingName1", value) for value in (1, 2)
)
builder.addDegreeOfFreedom(
SettingModifier("settingName2", value) for value in (3, 4, 5)
)
self.assertEquals(builder.modifierSets[0][0].value, 1)
self.assertEquals(builder.modifierSets[0][0].settingName, "settingName1")
self.assertEquals(builder.modifierSets[1][0].value, 2)
self.assertEquals(builder.modifierSets[1][0].settingName, "settingName1")
self.assertEquals(builder.modifierSets[2][0].value, 3)
self.assertEquals(builder.modifierSets[2][0].settingName, "settingName2")
self.assertEquals(builder.modifierSets[3][0].value, 4)
self.assertEquals(builder.modifierSets[3][0].settingName, "settingName2")
self.assertEquals(builder.modifierSets[4][0].value, 5)
self.assertEquals(builder.modifierSets[4][0].settingName, "settingName2")
self.assertEquals(len(builder.modifierSets), 5)