Skip to content

Commit

Permalink
Fix format
Browse files Browse the repository at this point in the history
  • Loading branch information
pshriwise committed Feb 27, 2024
1 parent eb30c20 commit 3142099
Showing 1 changed file with 29 additions and 23 deletions.
52 changes: 29 additions & 23 deletions src/dagmc/dagmcmetadata.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,35 @@
#include "logger.hpp"

class dagmcMetaData {
/**
* @class dagmcMetaData
* @brief A class to manage metadata in DAGMC models.
*
* The dagmcMetaData class provides functionality to parse and manage metadata
* that defines properties associated with volumes and surfaces in a DAGMC model
* (a .h5m file). These properties can include material assignments, density
* values, importance values, boundary conditions, and tally assignments.
*
* The class provides functions to parse metadata from the model group meshsets
* based on a set of keywords (e.g. "mat" or "rho"), retrieve metadata for
* specific entities, and check the validity of the discovered metadata.
*/
/**
* @class dagmcMetaData
* @brief A class to manage metadata in DAGMC models.
*
* The dagmcMetaData class provides functionality to parse and manage metadata
* that defines properties associated with volumes and surfaces in a DAGMC
* model (a .h5m file). These properties can include material assignments,
* density values, importance values, boundary conditions, and tally
* assignments.
*
* The class provides functions to parse metadata from the model group
* meshsets based on a set of keywords (e.g. "mat" or "rho"), retrieve
* metadata for specific entities, and check the validity of the discovered
* metadata.
*/
public:
/**
* @brief Constructs a new DagmcMetadata object.
*
* @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.
* @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,
dagmcMetaData(moab::DagMC* DAGptr, bool verbosity = false,
bool require_density_present = true);

/**
Expand Down Expand Up @@ -217,10 +222,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).
* 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.
*
Expand Down

0 comments on commit 3142099

Please sign in to comment.