Skip to content

Commit

Permalink
Adding docs for dagmcmetadata constructor and remove duplicat props
Browse files Browse the repository at this point in the history
  • Loading branch information
pshriwise committed Feb 27, 2024
1 parent b485a43 commit 19b7faf
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions src/dagmc/dagmcmetadata.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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);

/**
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 19b7faf

Please sign in to comment.