From 19b7faf950f49e519a81635584861ffe07607640 Mon Sep 17 00:00:00 2001 From: Patrick Shriwise Date: Mon, 26 Feb 2024 21:46:06 -0600 Subject: [PATCH] Adding docs for dagmcmetadata constructor and remove duplicat props --- src/dagmc/dagmcmetadata.hpp | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/src/dagmc/dagmcmetadata.hpp b/src/dagmc/dagmcmetadata.hpp index bb6f2ba48..6c5c92924 100644 --- a/src/dagmc/dagmcmetadata.hpp +++ b/src/dagmc/dagmcmetadata.hpp @@ -24,9 +24,13 @@ class dagmcMetaData { /** * @brief Constructs a new DagmcMetadata object. * - * @param dagmc A pointer to the DagMC instance associated with this metadata. - */ // Constructor - dagmcMetaData(moab::DagMC* DAGptr, bool verbosity = false, + * @param DAGptr A pointer to the DagMC instance associated with this metadata. + * @param verbosity A boolean flag to control verbosity. If true, the metadata manager + * will provide additional output while setting up and parsing properties. + * @param density A boolean flag to control density requirement. If true, the metadata + * manager will require that all volumes have a specified density value. + */ + dagmcMetaData(moab::DagMC* DAGptr, bool verbosity = false, bool require_density_present = true); /** @@ -209,6 +213,11 @@ class dagmcMetaData { /** * @brief Removes duplicate properties from a vector of properties. * + * Group names are parsed in such a way that the property and value are two separate + * entries in the array. For example, a tag like "particle:neutron/1.0" will return as + * "neutron" and "neutron/1.0". This function searches each item for its more + * information-rich partner and removes the degenerate item(s). + * * @param properties The vector of properties from which to remove duplicates. * * @return Returns a vector of properties with all duplicates removed.