#
# ************************************************************************
#
# ROM Tools and Workflows
# Copyright 2019 National Technology & Engineering Solutions of Sandia,LLC
# (NTESS)
#
# Under the terms of Contract DE-NA0003525 with NTESS, the
# U.S. Government retains certain rights in this software.
#
# ROM Tools and Workflows is licensed under BSD-3-Clause terms of use:
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived
# from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# Questions? Contact Eric Parish (ejparis@sandia.gov)
#
# ************************************************************************
#
'''
This module implements the class required to couple a model to Dakota.
To couple to Dakota, a user should
1. Complete a Model class for their application of interest
2. Complete a driver script that instantiates the model and calls this coupler for use as the Dakota analysis driver
'''
import os
import sys
import numpy as np
from romtools.workflows.model_execution import (
ModelEvaluation, compute_evaluation_qoi, execute_models,
)
from romtools.workflows.models import QoiModel
def _create_parameter_dict(parameter_names, parameter_values):
return dict(zip(parameter_names, parameter_values))
[docs]
def run_model_for_dakota(
model: QoiModel,
multifidelity_flag: bool = False,
add_core_time_metadata: bool = False,
):
'''
This function should be used in a driver script that will be called with
`python <driver.py> params.in results.out`
by Dakota. The parameter space is built by parsing params.in,
while the output QoI will be saved to results.out
Args:
model: rom-tools model instance (FOM or ROM)
multifidelity_flag: True if being used with Dakota's multifidelity (MF) tools
add_core_time_metadata: True if computational cost should be included in QoI file
Useful for MF UQ when model does not have a cost model.
'''
# Read parameters from param.in file (1st command line argument)
dtype = [("floats", float), ("strings", "U100")]
data = np.genfromtxt(sys.argv[1], dtype=dtype, encoding=None, delimiter=" ")
data_floats = data["floats"]
data_strings = data["strings"]
num_vars = int(data_floats[0])
parameter_values = np.array(data_floats[1 : 1 + num_vars])
parameter_names = data_strings[1 : 1 + num_vars]
# Run directory is current dir, results dir is from Dakota
run_directory = os.getcwd()
results_file = sys.argv[2]
# Initialize and run ROM
parameter_sample = _create_parameter_dict(parameter_names, parameter_values)
model.populate_run_directory(run_directory, parameter_sample)
evaluation = execute_models(
model, [ModelEvaluation(run_directory, parameter_sample)],
postprocess=compute_evaluation_qoi, ignore_blocking_status=True,
)[0]
# Compute model QoI and save it to file
qoi = evaluation.output
if multifidelity_flag:
assert qoi.size == 1, "For MF UQ, a scalar QoI is required"
if add_core_time_metadata:
qoi = np.append(qoi, evaluation.run_time) # Cost metadata for Q
np.savetxt(results_file, qoi)