crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-28 14:15:42 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Merge pull request #2465 from paulromano/model-fixes

Browse source 
A few improvements related to the Model class
This commit is contained in:
John Tramm 2023-04-12 14:33:42 -05:00 • committed by GitHub
commit f7c2961436
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 45 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

8
man/man1/openmc.1
View file

@ -8,7 +8,10 @@ sections are available.
.SH SYNOPSIS
\fBopenmc\fR [\fIoptions\fR] [\fIpath\fR]
.PP
It is assumed that if no
.I path
specifies either the path to a single model XML file containing the full model
or a directory containing either a model.xml file or a set of individual XML
files (settings.xml, materials.xml, geometry.xml). It is assumed that if no
.I path
is specified, the XML input files are present in the current directory.
.SH OPTIONS
@ -46,6 +49,9 @@ The behavior of
.B openmc
is affected by the following environment variables.
.TP
.B OPENMC_CHAIN_FILE
Indicates the path to a depletion chain XML file.
.TP
.B OPENMC_CROSS_SECTIONS
Indicates the default path to the cross_sections.xml summary file that is used
to locate HDF5 format cross section libraries if the user has not specified the

39
openmc/model/model.py
View file

@ -597,11 +597,13 @@ class Model:
def run(self, particles=None, threads=None, geometry_debug=False,
restart_file=None, tracks=False, output=True, cwd='.',
openmc_exec='openmc', mpi_args=None, event_based=None,
export_model_xml=True):
"""Runs OpenMC. If the C API has been initialized, then the C API is
used, otherwise, this method creates the XML files and runs OpenMC via
a system call. In both cases this method returns the path to the last
statepoint file generated.
export_model_xml=True, **export_kwargs):
"""Run OpenMC
If the C API has been initialized, then the C API is used, otherwise,
this method creates the XML files and runs OpenMC via a system call. In
both cases this method returns the path to the last statepoint file
generated.
.. versionchanged:: 0.12
Instead of returning the final k-effective value, this function now
@ -630,27 +632,30 @@ class Model:
output : bool, optional
Capture OpenMC output from standard out
cwd : str, optional
Path to working directory to run in. Defaults to the current
working directory.
Path to working directory to run in. Defaults to the current working
directory.
openmc_exec : str, optional
Path to OpenMC executable. Defaults to 'openmc'.
mpi_args : list of str, optional
MPI execute command and any additional MPI arguments to pass,
e.g. ['mpiexec', '-n', '8'].
MPI execute command and any additional MPI arguments to pass, e.g.
['mpiexec', '-n', '8'].
event_based : None or bool, optional
Turns on event-based parallelism if True. If None, the value in
the Settings will be used.
Turns on event-based parallelism if True. If None, the value in the
Settings will be used.
export_model_xml : bool, optional
Exports a single model.xml file rather than separate files.
Defaults to True.
Exports a single model.xml file rather than separate files. Defaults
to True.
.. versionadded:: 0.13.3
**export_kwargs
Keyword arguments passed to either :meth:`Model.export_to_model_xml`
or :meth:`Model.export_to_xml`.
Returns
-------
Path
Path to the last statepoint written by this run
(None if no statepoint was written)
Path to the last statepoint written by this run (None if no
statepoint was written)
"""
@ -695,9 +700,9 @@ class Model:
else:
# Then run via the command line
if export_model_xml:
self.export_to_model_xml()
self.export_to_model_xml(**export_kwargs)
else:
self.export_to_xml()
self.export_to_xml(**export_kwargs)
openmc.run(particles, threads, geometry_debug, restart_file,
tracks, output, Path('.'), openmc_exec, mpi_args,
event_based)

12
src/initialize.cpp
View file

@ -358,7 +358,7 @@ bool read_model_xml()
for (const auto& input : other_inputs) {
if (file_exists(settings::path_input + input)) {
warning((fmt::format("Other XML file input(s) are present. These files "
"will be ignored in favor of the {} file.",
"may be ignored in favor of the {} file.",
model_filename)));
break;
}
@ -392,8 +392,16 @@ bool read_model_xml()
// Initialize distribcell_filters
prepare_distribcell();
if (check_for_node(root, "plots"))
if (check_for_node(root, "plots")) {
read_plots_xml(root.child("plots"));
} else {
// When no <plots> element is present in the model.xml file, check for a
// regular plots.xml file
std::string filename = settings::path_input + "plots.xml";
if (file_exists(filename)) {
read_plots_xml();
}
}
return true;
}

2
src/output.cpp
View file

@ -268,7 +268,7 @@ void print_usage()
{
if (mpi::master) {
fmt::print(
"Usage: openmc [options] [directory]\n\n"
"Usage: openmc [options] [path]\n\n"
"Options:\n"
" -c, --volume Run in stochastic volume calculation mode\n"
" -g, --geometry-debug Run with geometry debugging on\n"

15
src/settings.cpp
View file

@ -223,16 +223,11 @@ void read_settings_xml()
std::string filename = settings::path_input + "settings.xml";
if (!file_exists(filename)) {
if (run_mode != RunMode::PLOTTING) {
fatal_error(
fmt::format("Settings XML file '{}' does not exist! In order "
"to run OpenMC, you first need a set of input files; at a "
"minimum, this "
"includes settings.xml, geometry.xml, and materials.xml "
"or a single XML file containing all of these files. "
"Please consult "
"the user's guide at https://docs.openmc.org for further "
"information.",
filename));
fatal_error("Could not find any XML input files! In order to run OpenMC, "
"you first need a set of input files; at a minimum, this "
"includes settings.xml, geometry.xml, and materials.xml or a "
"single model XML file. Please consult the user's guide at "
"https://docs.openmc.org for further information.");
} else {
// The settings.xml file is optional if we just want to make a plot.
return;