[MOAB-dev] r3123 - MOAB/trunk

[bmsmith6 at wisc.edu]

Author: bmsmith
Date: 2009-08-31 14:25:49 -0500 (Mon, 31 Aug 2009)
New Revision: 3123

Modified:
   MOAB/trunk/ReadMCNP5.cpp
   MOAB/trunk/ReadMCNP5.hpp
Log:
Describe the structure of sets, tags, and mesh elements created by this reader.

Modified: MOAB/trunk/ReadMCNP5.cpp
===================================================================
--- MOAB/trunk/ReadMCNP5.cpp	2009-08-27 17:28:21 UTC (rev 3122)
+++ MOAB/trunk/ReadMCNP5.cpp	2009-08-31 19:25:49 UTC (rev 3123)
@@ -1,8 +1,18 @@
-/**
- * \class  ReadMCNP5
- * \brief  Read output from MCNP5
- * \author Brandon Smith
- **/
+/**                                     
+ * MOAB, a Mesh-Oriented datABase, is a software component for creating,
+ * storing and accessing finite element mesh data.       
+ *                                                                          
+ * Copyright 2004 Sandia Corporation.  Under the terms of Contract   
+ * DE-AC04-94AL85000 with Sandia Coroporation, the U.S. Government      
+ * retains certain rights in this software.
+ *                                 
+ * This library is free software; you can redistribute it and/or       
+ * modify it under the terms of the GNU Lesser General Public           
+ * License as published by the Free Software Foundation; either  
+ * version 2.1 of the License, or (at your option) any later version.       
+ *          
+ */ 
+
 #include "ReadMCNP5.hpp"
 #include "MBInterface.hpp"
 #include "MBReadUtilIface.hpp"

Modified: MOAB/trunk/ReadMCNP5.hpp
===================================================================
--- MOAB/trunk/ReadMCNP5.hpp	2009-08-27 17:28:21 UTC (rev 3122)
+++ MOAB/trunk/ReadMCNP5.hpp	2009-08-31 19:25:49 UTC (rev 3123)
@@ -1,3 +1,42 @@
+/**
+ * MOAB, a Mesh-Oriented datABase, is a software component for creating,  
+ * storing and accessing finite element mesh data.
+ *
+ * Copyright 2004 Sandia Corporation.  Under the terms of Contract
+ * DE-AC04-94AL85000 with Sandia Coroporation, the U.S. Government
+ * retains certain rights in this software.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either 
+ * version 2.1 of the License, or (at your option) any later version.
+ *                                 
+ */ 
+
+//----------------------------------------------------------------------
+// Filename : ReadMCNP5.hpp    
+// Purpose  : Read a meshtal file created by MCNP5 into MOAB
+// Creator  : Brandon Smith
+// Date     : 07/2009
+//----------------------------------------------------------------------
+
+/**
+ * Data structure of MCNP5 data created by this reader:
+ *
+ * each file_meshset contains
+ *   DATA_AND_TIME_TAG
+ *   TITLE_TAG
+ *   NPS_TAG
+ *   each tally_meshset contains
+ *     TALLY_NUMBER_TAG
+ *     TALLY_COMMENT_TAG
+ *     TALLY_PARTICLE_TAG
+ *     TALLY_COORD_SYS_TAG
+ *     each mesh element contains
+ *       TALLY_TAG
+ *       ERROR_TAG
+ */
+
 #include "MBInterface.hpp"
 #include "MBReaderIface.hpp"
 #include <iostream>